dcspb

package
v1.15.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 18, 2024 License: GPL-3.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	Configurator_Subscribe_FullMethodName     = "/dcs.Configurator/Subscribe"
	Configurator_PrepareForRun_FullMethodName = "/dcs.Configurator/PrepareForRun"
	Configurator_StartOfRun_FullMethodName    = "/dcs.Configurator/StartOfRun"
	Configurator_EndOfRun_FullMethodName      = "/dcs.Configurator/EndOfRun"
	Configurator_GetStatus_FullMethodName     = "/dcs.Configurator/GetStatus"
)

Variables

View Source 
var (
	EventType_name = map[int32]string{
		0:  "NULL_EVENT",
		1:  "HEARTBEAT",
		2:  "STATE_CHANGE_EVENT",
		3:  "ERROR_EVENT",
		4:  "ACK_EVENT",
		20: "SOR_EVENT",
		30: "EOR_EVENT",
		40: "EVENT_TIMEOUT",
		50: "PFR_EVENT",
	}
	EventType_value = map[string]int32{
		"NULL_EVENT":         0,
		"HEARTBEAT":          1,
		"STATE_CHANGE_EVENT": 2,
		"ERROR_EVENT":        3,
		"ACK_EVENT":          4,
		"SOR_EVENT":          20,
		"EOR_EVENT":          30,
		"EVENT_TIMEOUT":      40,
		"PFR_EVENT":          50,
	}
)

Enum value maps for EventType.

View Source 
var (
	Detector_name = map[int32]string{
		0:  "NULL_DETECTOR",
		1:  "CPV",
		2:  "EMC",
		3:  "FDD",
		4:  "FT0",
		5:  "FV0",
		6:  "ITS",
		7:  "HMP",
		8:  "MCH",
		9:  "MFT",
		10: "MID",
		11: "PHS",
		12: "TOF",
		13: "TPC",
		14: "TRD",
		15: "ZDC",
		16: "LHC",
		17: "DCS",
		18: "AGD",
	}
	Detector_value = map[string]int32{
		"NULL_DETECTOR": 0,
		"CPV":           1,
		"EMC":           2,
		"FDD":           3,
		"FT0":           4,
		"FV0":           5,
		"ITS":           6,
		"HMP":           7,
		"MCH":           8,
		"MFT":           9,
		"MID":           10,
		"PHS":           11,
		"TOF":           12,
		"TPC":           13,
		"TRD":           14,
		"ZDC":           15,
		"LHC":           16,
		"DCS":           17,
		"AGD":           18,
	}
)

Enum value maps for Detector.

View Source 
var (
	DetectorState_name = map[int32]string{
		0:  "NULL_STATE",
		1:  "READY",
		2:  "RUN_OK",
		3:  "RUN_FAILURE",
		4:  "RUN_INHIBIT",
		5:  "SOR_PROGRESSING",
		6:  "EOR_PROGRESSING",
		7:  "SOR_FAILURE",
		8:  "EOR_FAILURE",
		9:  "ERROR",
		10: "DEAD",
		11: "SOR_UNAVAILABLE",
		12: "EOR_UNAVAILABLE",
		13: "PREPARING",
		14: "SOR_AVAILABLE",
		15: "EOR_AVAILABLE",
		16: "PFR_AVAILABLE",
		17: "PFR_UNAVAILABLE",
		18: "TIMEOUT",
	}
	DetectorState_value = map[string]int32{
		"NULL_STATE":      0,
		"READY":           1,
		"RUN_OK":          2,
		"RUN_FAILURE":     3,
		"RUN_INHIBIT":     4,
		"SOR_PROGRESSING": 5,
		"EOR_PROGRESSING": 6,
		"SOR_FAILURE":     7,
		"EOR_FAILURE":     8,
		"ERROR":           9,
		"DEAD":            10,
		"SOR_UNAVAILABLE": 11,
		"EOR_UNAVAILABLE": 12,
		"PREPARING":       13,
		"SOR_AVAILABLE":   14,
		"EOR_AVAILABLE":   15,
		"PFR_AVAILABLE":   16,
		"PFR_UNAVAILABLE": 17,
		"TIMEOUT":         18,
	}
)

Enum value maps for DetectorState.

View Source 
var (
	RunType_name = map[int32]string{
		0:   "NULL_RUNTYPE",
		1:   "PHYSICS",
		2:   "TECHNICAL",
		3:   "PEDESTALS",
		4:   "PULSER",
		5:   "LASER",
		6:   "CALIBRATION_ITHR_TUNING",
		7:   "CALIBRATION_VCASN_TUNING",
		8:   "CALIBRATION_THR_SCAN",
		9:   "CALIBRATION_DIGITAL_SCAN",
		10:  "CALIBRATION_ANALOG_SCAN",
		11:  "CALIBRATION_FHR",
		12:  "CALIBRATION_ALPIDE_SCAN",
		16:  "NOISE",
		17:  "CALIBRATION_PULSE_LENGTH",
		18:  "CALIBRATION_VRESETD",
		300: "ANY",
	}
	RunType_value = map[string]int32{
		"NULL_RUNTYPE":             0,
		"PHYSICS":                  1,
		"TECHNICAL":                2,
		"PEDESTALS":                3,
		"PULSER":                   4,
		"LASER":                    5,
		"CALIBRATION_ITHR_TUNING":  6,
		"CALIBRATION_VCASN_TUNING": 7,
		"CALIBRATION_THR_SCAN":     8,
		"CALIBRATION_DIGITAL_SCAN": 9,
		"CALIBRATION_ANALOG_SCAN":  10,
		"CALIBRATION_FHR":          11,
		"CALIBRATION_ALPIDE_SCAN":  12,
		"NOISE":                    16,
		"CALIBRATION_PULSE_LENGTH": 17,
		"CALIBRATION_VRESETD":      18,
		"ANY":                      300,
	}
)

Enum value maps for RunType.

View Source 
var (
	TriggerMode_name = map[int32]string{
		0: "CONTINUOUS",
		1: "TRIGGERED",
	}
	TriggerMode_value = map[string]int32{
		"CONTINUOUS": 0,
		"TRIGGERED":  1,
	}
)

Enum value maps for TriggerMode.

View Source 
var (
	SorMode_name = map[int32]string{
		0: "FULL",
		1: "FAST",
	}
	SorMode_value = map[string]int32{
		"FULL": 0,
		"FAST": 1,
	}
)

Enum value maps for SorMode.

View Source 
var Configurator_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "dcs.Configurator",
	HandlerType: (*ConfiguratorServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetStatus",
			Handler:    _Configurator_GetStatus_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Subscribe",
			Handler:       _Configurator_Subscribe_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "PrepareForRun",
			Handler:       _Configurator_PrepareForRun_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "StartOfRun",
			Handler:       _Configurator_StartOfRun_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "EndOfRun",
			Handler:       _Configurator_EndOfRun_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "protos/dcs.proto",
}

Configurator_ServiceDesc is the grpc.ServiceDesc for Configurator service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var File_protos_dcs_proto protoreflect.FileDescriptor

Functions

func RegisterConfiguratorServer 

func RegisterConfiguratorServer(s grpc.ServiceRegistrar, srv ConfiguratorServer)

Types

type ConfiguratorClient 

type ConfiguratorClient interface {
	// Optional call, legal at any time, to subscribe to all future events from
	// the DCS service. The server stops serving the stream when the client closes
	// it. Multiple concurrent stream subscriptions are allowed.
	Subscribe(ctx context.Context, in *SubscriptionRequest, opts ...grpc.CallOption) (Configurator_SubscribeClient, error)
	// Single PFR request for a data taking session, with per-detector parameters.
	// Returns an event stream which returns subsequent intermediate states within
	// the PFR operation. Upon PFR completion (DetectorState.RUN_OK), the server
	// closes the stream.
	PrepareForRun(ctx context.Context, in *PfrRequest, opts ...grpc.CallOption) (Configurator_PrepareForRunClient, error)
	// Single SOR request for a data taking session, with run number.
	// Returns an event stream which returns subsequent intermediate states within
	// the SOR operation. Upon SOR completion (DetectorState.RUN_OK), the server
	// closes the stream.
	// If the DetectorOperationRequest or run type parameters are the same as the
	// last PrepareForRun request (no matter how far back in time) and the DCS
	// state hasn't changed, the SOR operations should be fast. Otherwise, the SOR
	// also implicitly includes any number of PrepareForRun operations as needed,
	// this can take a while but should not change the overall behavior reported
	// to ECS.
	StartOfRun(ctx context.Context, in *SorRequest, opts ...grpc.CallOption) (Configurator_StartOfRunClient, error)
	// Single EOR request for a data taking session, with per-detector parameters.
	// Returns an event stream which returns subsequent intermediate states within
	// the EOR operation. Upon EOR completion (DetectorState.RUN_OK), the server
	// closes the stream.
	EndOfRun(ctx context.Context, in *EorRequest, opts ...grpc.CallOption) (Configurator_EndOfRunClient, error)
	// Optional call, legal at any time, to query the status of the DCS service
	// and either some or all of its constituent detectors. This call returns a
	// single value (not a stream), reflecting the service state at that
	// specific moment.
	GetStatus(ctx context.Context, in *StatusRequest, opts ...grpc.CallOption) (*StatusReply, error)
}

ConfiguratorClient is the client API for Configurator service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewConfiguratorClient 

func NewConfiguratorClient(cc grpc.ClientConnInterface) ConfiguratorClient

type ConfiguratorServer 

type ConfiguratorServer interface {
	// Optional call, legal at any time, to subscribe to all future events from
	// the DCS service. The server stops serving the stream when the client closes
	// it. Multiple concurrent stream subscriptions are allowed.
	Subscribe(*SubscriptionRequest, Configurator_SubscribeServer) error
	// Single PFR request for a data taking session, with per-detector parameters.
	// Returns an event stream which returns subsequent intermediate states within
	// the PFR operation. Upon PFR completion (DetectorState.RUN_OK), the server
	// closes the stream.
	PrepareForRun(*PfrRequest, Configurator_PrepareForRunServer) error
	// Single SOR request for a data taking session, with run number.
	// Returns an event stream which returns subsequent intermediate states within
	// the SOR operation. Upon SOR completion (DetectorState.RUN_OK), the server
	// closes the stream.
	// If the DetectorOperationRequest or run type parameters are the same as the
	// last PrepareForRun request (no matter how far back in time) and the DCS
	// state hasn't changed, the SOR operations should be fast. Otherwise, the SOR
	// also implicitly includes any number of PrepareForRun operations as needed,
	// this can take a while but should not change the overall behavior reported
	// to ECS.
	StartOfRun(*SorRequest, Configurator_StartOfRunServer) error
	// Single EOR request for a data taking session, with per-detector parameters.
	// Returns an event stream which returns subsequent intermediate states within
	// the EOR operation. Upon EOR completion (DetectorState.RUN_OK), the server
	// closes the stream.
	EndOfRun(*EorRequest, Configurator_EndOfRunServer) error
	// Optional call, legal at any time, to query the status of the DCS service
	// and either some or all of its constituent detectors. This call returns a
	// single value (not a stream), reflecting the service state at that
	// specific moment.
	GetStatus(context.Context, *StatusRequest) (*StatusReply, error)
}

ConfiguratorServer is the server API for Configurator service. All implementations should embed UnimplementedConfiguratorServer for forward compatibility

type Configurator_EndOfRunClient added in v0.22.0 

type Configurator_EndOfRunClient interface {
	Recv() (*RunEvent, error)
	grpc.ClientStream
}

type Configurator_EndOfRunServer added in v0.22.0 

type Configurator_EndOfRunServer interface {
	Send(*RunEvent) error
	grpc.ServerStream
}

type Configurator_PrepareForRunClient added in v0.69.0 

type Configurator_PrepareForRunClient interface {
	Recv() (*RunEvent, error)
	grpc.ClientStream
}

type Configurator_PrepareForRunServer added in v0.69.0 

type Configurator_PrepareForRunServer interface {
	Send(*RunEvent) error
	grpc.ServerStream
}

type Configurator_StartOfRunClient added in v0.22.0 

type Configurator_StartOfRunClient interface {
	Recv() (*RunEvent, error)
	grpc.ClientStream
}

type Configurator_StartOfRunServer added in v0.22.0 

type Configurator_StartOfRunServer interface {
	Send(*RunEvent) error
	grpc.ServerStream
}

type Configurator_SubscribeClient 

type Configurator_SubscribeClient interface {
	Recv() (*Event, error)
	grpc.ClientStream
}

type Configurator_SubscribeServer 

type Configurator_SubscribeServer interface {
	Send(*Event) error
	grpc.ServerStream
}

type Detector 

type Detector int32
const (
	Detector_NULL_DETECTOR Detector = 0
	Detector_CPV           Detector = 1
	Detector_EMC           Detector = 2
	Detector_FDD           Detector = 3
	Detector_FT0           Detector = 4
	Detector_FV0           Detector = 5
	Detector_ITS           Detector = 6
	Detector_HMP           Detector = 7
	Detector_MCH           Detector = 8
	Detector_MFT           Detector = 9
	Detector_MID           Detector = 10
	Detector_PHS           Detector = 11
	Detector_TOF           Detector = 12
	Detector_TPC           Detector = 13
	Detector_TRD           Detector = 14
	Detector_ZDC           Detector = 15
	Detector_LHC           Detector = 16
	Detector_DCS           Detector = 17
	Detector_AGD           Detector = 18
)

func (Detector) Descriptor 

func (Detector) Descriptor() protoreflect.EnumDescriptor

func (Detector) Enum 

func (x Detector) Enum() *Detector

func (Detector) EnumDescriptor deprecated 

func (Detector) EnumDescriptor() ([]byte, []int)

Deprecated: Use Detector.Descriptor instead.

func (Detector) Number 

func (x Detector) Number() protoreflect.EnumNumber

func (Detector) String 

func (x Detector) String() string

func (Detector) Type 

func (Detector) Type() protoreflect.EnumType

type DetectorInfo 

type DetectorInfo struct {
	Detector        Detector      `protobuf:"varint,1,opt,name=detector,proto3,enum=dcs.Detector" json:"detector,omitempty"`                     // 1 detector per DetectorInfo
	State           DetectorState `protobuf:"varint,2,opt,name=state,proto3,enum=dcs.DetectorState" json:"state,omitempty"`                      // state of this detector at the time of response generation
	Timestamp       string        `protobuf:"bytes,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`                                      // time when the detector state is as declared
	AllowedRunTypes []RunType     `protobuf:"varint,4,rep,packed,name=allowedRunTypes,proto3,enum=dcs.RunType" json:"allowedRunTypes,omitempty"` // a list of run types that are currently
	// possible with the given detector, taking into
	// account all low-level information;
	// for example, at a given moment TECHNICAL
	// runs might be possible but not PHYSICS
	PfrAvailability DetectorState `protobuf:"varint,5,opt,name=pfrAvailability,proto3,enum=dcs.DetectorState" json:"pfrAvailability,omitempty"` // availability of this detector for PFR at the time of response generation
	SorAvailability DetectorState `protobuf:"varint,6,opt,name=sorAvailability,proto3,enum=dcs.DetectorState" json:"sorAvailability,omitempty"` // availability of this detector for SOR at the time of response generation
	// contains filtered or unexported fields
}

A DetectorInfo is a full status report for a single detector, multiple such payloads are then aggregated in a StatusReply or Subscribe Event.

func (*DetectorInfo) Descriptor deprecated 

func (*DetectorInfo) Descriptor() ([]byte, []int)

Deprecated: Use DetectorInfo.ProtoReflect.Descriptor instead.

func (*DetectorInfo) GetAllowedRunTypes added in v0.26.3 

func (x *DetectorInfo) GetAllowedRunTypes() []RunType

func (*DetectorInfo) GetDetector 

func (x *DetectorInfo) GetDetector() Detector

func (*DetectorInfo) GetPfrAvailability added in v1.2.0 

func (x *DetectorInfo) GetPfrAvailability() DetectorState

func (*DetectorInfo) GetSorAvailability added in v1.2.0 

func (x *DetectorInfo) GetSorAvailability() DetectorState

func (*DetectorInfo) GetState 

func (x *DetectorInfo) GetState() DetectorState

func (*DetectorInfo) GetTimestamp 

func (x *DetectorInfo) GetTimestamp() string

func (*DetectorInfo) ProtoMessage 

func (*DetectorInfo) ProtoMessage()

func (*DetectorInfo) ProtoReflect 

func (x *DetectorInfo) ProtoReflect() protoreflect.Message

func (*DetectorInfo) Reset 

func (x *DetectorInfo) Reset()

func (*DetectorInfo) String 

func (x *DetectorInfo) String() string

type DetectorOperationRequest added in v0.26.3 

type DetectorOperationRequest struct {
	Detector        Detector          `protobuf:"varint,1,opt,name=detector,proto3,enum=dcs.Detector" json:"detector,omitempty"`
	ExtraParameters map[string]string `` // detector-specific parameters
	/* 171-byte string literal not displayed */
	// contains filtered or unexported fields
}

Each SorRequest/EorRequest contains multiple DetectorOperationRequests, one per detector. This is needed in order to pass per-detector parameters within a single SOR/EOR operation.

func (*DetectorOperationRequest) Descriptor deprecated added in v0.26.3 

func (*DetectorOperationRequest) Descriptor() ([]byte, []int)

Deprecated: Use DetectorOperationRequest.ProtoReflect.Descriptor instead.

func (*DetectorOperationRequest) GetDetector added in v0.26.3 

func (x *DetectorOperationRequest) GetDetector() Detector

func (*DetectorOperationRequest) GetExtraParameters added in v0.26.3 

func (x *DetectorOperationRequest) GetExtraParameters() map[string]string

func (*DetectorOperationRequest) ProtoMessage added in v0.26.3 

func (*DetectorOperationRequest) ProtoMessage()

func (*DetectorOperationRequest) ProtoReflect added in v0.26.3 

func (x *DetectorOperationRequest) ProtoReflect() protoreflect.Message

func (*DetectorOperationRequest) Reset added in v0.26.3 

func (x *DetectorOperationRequest) Reset()

func (*DetectorOperationRequest) String added in v0.26.3 

func (x *DetectorOperationRequest) String() string

type DetectorState 

type DetectorState int32
const (
	DetectorState_NULL_STATE      DetectorState = 0
	DetectorState_READY           DetectorState = 1
	DetectorState_RUN_OK          DetectorState = 2
	DetectorState_RUN_FAILURE     DetectorState = 3
	DetectorState_RUN_INHIBIT     DetectorState = 4
	DetectorState_SOR_PROGRESSING DetectorState = 5
	DetectorState_EOR_PROGRESSING DetectorState = 6
	DetectorState_SOR_FAILURE     DetectorState = 7
	DetectorState_EOR_FAILURE     DetectorState = 8
	DetectorState_ERROR           DetectorState = 9
	DetectorState_DEAD            DetectorState = 10
	DetectorState_SOR_UNAVAILABLE DetectorState = 11
	DetectorState_EOR_UNAVAILABLE DetectorState = 12
	DetectorState_PREPARING       DetectorState = 13
	DetectorState_SOR_AVAILABLE   DetectorState = 14
	DetectorState_EOR_AVAILABLE   DetectorState = 15
	DetectorState_PFR_AVAILABLE   DetectorState = 16
	DetectorState_PFR_UNAVAILABLE DetectorState = 17
	DetectorState_TIMEOUT         DetectorState = 18
)

func (DetectorState) Descriptor 

func (DetectorState) Descriptor() protoreflect.EnumDescriptor

func (DetectorState) Enum 

func (x DetectorState) Enum() *DetectorState

func (DetectorState) EnumDescriptor deprecated 

func (DetectorState) EnumDescriptor() ([]byte, []int)

Deprecated: Use DetectorState.Descriptor instead.

func (DetectorState) Number 

func (x DetectorState) Number() protoreflect.EnumNumber

func (DetectorState) String 

func (x DetectorState) String() string

func (DetectorState) Type 

func (DetectorState) Type() protoreflect.EnumType

type EorRequest 

type EorRequest struct {
	Detectors []*DetectorOperationRequest `protobuf:"bytes,1,rep,name=detectors,proto3" json:"detectors,omitempty"`
	RunNumber int32                       `protobuf:"varint,2,opt,name=runNumber,proto3" json:"runNumber,omitempty"`
	// contains filtered or unexported fields
}

An EorRequest encapsulates a list of detector-specific request payloads, plus a runNumber to identify the run being stopped.

func (*EorRequest) Descriptor deprecated 

func (*EorRequest) Descriptor() ([]byte, []int)

Deprecated: Use EorRequest.ProtoReflect.Descriptor instead.

func (*EorRequest) GetDetectors added in v0.26.3 

func (x *EorRequest) GetDetectors() []*DetectorOperationRequest

func (*EorRequest) GetRunNumber 

func (x *EorRequest) GetRunNumber() int32

func (*EorRequest) ProtoMessage 

func (*EorRequest) ProtoMessage()

func (*EorRequest) ProtoReflect 

func (x *EorRequest) ProtoReflect() protoreflect.Message

func (*EorRequest) Reset 

func (x *EorRequest) Reset()

func (*EorRequest) String 

func (x *EorRequest) String() string

type Event 

type Event struct {
	Eventtype      EventType       `protobuf:"varint,1,opt,name=eventtype,proto3,enum=dcs.EventType" json:"eventtype,omitempty"` // type of event being published by the DCS service
	DetectorMatrix []*DetectorInfo `protobuf:"bytes,2,rep,name=detectorMatrix,proto3" json:"detectorMatrix,omitempty"`           // detector-specific status payloads (optional depending
	// on event type)
	ExtraParameters map[string]string `` // general key-value map just in case
	/* 171-byte string literal not displayed */
	Timestamp string `protobuf:"bytes,4,opt,name=timestamp,proto3" json:"timestamp,omitempty"` // this corresponds to the moment where this Event-answer
	// was valid from the source
	Message string `protobuf:"bytes,5,opt,name=message,proto3" json:"message,omitempty"` // optional user-facing error message, if the DCS wants to
	// contains filtered or unexported fields
}

The Subscribe response stream returns Event payloads:

  1. as needed, Events of type ERROR_EVENT, TIMEOUT, etc. when something unexpected happens, especially outside of a SOR or EOR operation (which are already served by operation-specific streams)
  2. periodically, Events of type HEARTBEAT with a full detectorMatrix to republish the full status of all detectors in the system
  3. as needed, Events of type STATE_CHANGE_EVENT and similar, with a partial detectorMatrix that only reflects the changes in some detectors, usually when the internal state of a detector has changed on the DCS side in some way that makes a new RunType possible, or that inhibits a RunType that was previously possible and now isn't any more.

func (*Event) Descriptor deprecated 

func (*Event) Descriptor() ([]byte, []int)

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetDetectorMatrix added in v0.26.3 

func (x *Event) GetDetectorMatrix() []*DetectorInfo

func (*Event) GetEventtype 

func (x *Event) GetEventtype() EventType

func (*Event) GetExtraParameters added in v0.26.3 

func (x *Event) GetExtraParameters() map[string]string

func (*Event) GetMessage added in v0.26.3 

func (x *Event) GetMessage() string

func (*Event) GetTimestamp 

func (x *Event) GetTimestamp() string

func (*Event) ProtoMessage 

func (*Event) ProtoMessage()

func (*Event) ProtoReflect 

func (x *Event) ProtoReflect() protoreflect.Message

func (*Event) Reset 

func (x *Event) Reset()

func (*Event) String 

func (x *Event) String() string

type EventType 

type EventType int32
const (
	EventType_NULL_EVENT         EventType = 0
	EventType_HEARTBEAT          EventType = 1
	EventType_STATE_CHANGE_EVENT EventType = 2
	EventType_ERROR_EVENT        EventType = 3
	EventType_ACK_EVENT          EventType = 4
	EventType_SOR_EVENT          EventType = 20
	EventType_EOR_EVENT          EventType = 30
	EventType_EVENT_TIMEOUT      EventType = 40
	EventType_PFR_EVENT          EventType = 50
)

func (EventType) Descriptor 

func (EventType) Descriptor() protoreflect.EnumDescriptor

func (EventType) Enum 

func (x EventType) Enum() *EventType

func (EventType) EnumDescriptor deprecated 

func (EventType) EnumDescriptor() ([]byte, []int)

Deprecated: Use EventType.Descriptor instead.

func (EventType) Number 

func (x EventType) Number() protoreflect.EnumNumber

func (EventType) String 

func (x EventType) String() string

func (EventType) Type 

func (EventType) Type() protoreflect.EnumType

type PfrRequest added in v0.69.0 

type PfrRequest struct {
	Detectors   []*DetectorOperationRequest `protobuf:"bytes,1,rep,name=detectors,proto3" json:"detectors,omitempty"`
	RunType     RunType                     `protobuf:"varint,2,opt,name=runType,proto3,enum=dcs.RunType" json:"runType,omitempty"` // default: NULL_RUNTYPE, should probably never be sent
	PartitionId string                      `protobuf:"bytes,3,opt,name=partitionId,proto3" json:"partitionId,omitempty"`           // unique id for a pfr request
	// contains filtered or unexported fields
}

A PfrRequest encapsulates a list of detector-specific request payloads, plus a common runType any future runs.

func (*PfrRequest) Descriptor deprecated added in v0.69.0 

func (*PfrRequest) Descriptor() ([]byte, []int)

Deprecated: Use PfrRequest.ProtoReflect.Descriptor instead.

func (*PfrRequest) GetDetectors added in v0.69.0 

func (x *PfrRequest) GetDetectors() []*DetectorOperationRequest

func (*PfrRequest) GetPartitionId added in v0.69.0 

func (x *PfrRequest) GetPartitionId() string

func (*PfrRequest) GetRunType added in v0.69.0 

func (x *PfrRequest) GetRunType() RunType

func (*PfrRequest) ProtoMessage added in v0.69.0 

func (*PfrRequest) ProtoMessage()

func (*PfrRequest) ProtoReflect added in v0.69.0 

func (x *PfrRequest) ProtoReflect() protoreflect.Message

func (*PfrRequest) Reset added in v0.69.0 

func (x *PfrRequest) Reset()

func (*PfrRequest) String added in v0.69.0 

func (x *PfrRequest) String() string

type RunEvent added in v0.26.3 

type RunEvent struct {
	Eventtype EventType `protobuf:"varint,1,opt,name=eventtype,proto3,enum=dcs.EventType" json:"eventtype,omitempty"` // type of event being published by the DCS service
	Detector  Detector  `protobuf:"varint,2,opt,name=detector,proto3,enum=dcs.Detector" json:"detector,omitempty"`    // if detector==DCS, the update is a pre-closure summary
	// of the current operation
	State DetectorState `protobuf:"varint,3,opt,name=state,proto3,enum=dcs.DetectorState" json:"state,omitempty"` // aggregate state for all detectors involved in current
	// SOR/EOR operation
	ExtraParameters map[string]string `` /* 171-byte string literal not displayed */
	Timestamp       string            `protobuf:"bytes,5,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	Message         string            `protobuf:"bytes,6,opt,name=message,proto3" json:"message,omitempty"` // optional user-facing error message, if the DCS wants to
	// contains filtered or unexported fields
}

A stream of Event objects is returned by SOR and EOR calls. Most fields are optional and filled as needed, depending on the type of request.

func (*RunEvent) Descriptor deprecated added in v0.26.3 

func (*RunEvent) Descriptor() ([]byte, []int)

Deprecated: Use RunEvent.ProtoReflect.Descriptor instead.

func (*RunEvent) GetDetector added in v0.26.3 

func (x *RunEvent) GetDetector() Detector

func (*RunEvent) GetEventtype added in v0.26.3 

func (x *RunEvent) GetEventtype() EventType

func (*RunEvent) GetExtraParameters added in v0.26.3 

func (x *RunEvent) GetExtraParameters() map[string]string

func (*RunEvent) GetMessage added in v0.26.3 

func (x *RunEvent) GetMessage() string

func (*RunEvent) GetState added in v0.26.3 

func (x *RunEvent) GetState() DetectorState

func (*RunEvent) GetTimestamp added in v0.26.3 

func (x *RunEvent) GetTimestamp() string

func (*RunEvent) ProtoMessage added in v0.26.3 

func (*RunEvent) ProtoMessage()

func (*RunEvent) ProtoReflect added in v0.26.3 

func (x *RunEvent) ProtoReflect() protoreflect.Message

func (*RunEvent) Reset added in v0.26.3 

func (x *RunEvent) Reset()

func (*RunEvent) String added in v0.26.3 

func (x *RunEvent) String() string

type RunType 

type RunType int32
const (
	RunType_NULL_RUNTYPE             RunType = 0
	RunType_PHYSICS                  RunType = 1
	RunType_TECHNICAL                RunType = 2
	RunType_PEDESTALS                RunType = 3
	RunType_PULSER                   RunType = 4
	RunType_LASER                    RunType = 5
	RunType_CALIBRATION_ITHR_TUNING  RunType = 6
	RunType_CALIBRATION_VCASN_TUNING RunType = 7
	RunType_CALIBRATION_THR_SCAN     RunType = 8
	RunType_CALIBRATION_DIGITAL_SCAN RunType = 9
	RunType_CALIBRATION_ANALOG_SCAN  RunType = 10
	RunType_CALIBRATION_FHR          RunType = 11
	RunType_CALIBRATION_ALPIDE_SCAN  RunType = 12
	RunType_NOISE                    RunType = 16
	RunType_CALIBRATION_PULSE_LENGTH RunType = 17
	RunType_CALIBRATION_VRESETD      RunType = 18
	RunType_ANY                      RunType = 300
)

func (RunType) Descriptor 

func (RunType) Descriptor() protoreflect.EnumDescriptor

func (RunType) Enum 

func (x RunType) Enum() *RunType

func (RunType) EnumDescriptor deprecated 

func (RunType) EnumDescriptor() ([]byte, []int)

Deprecated: Use RunType.Descriptor instead.

func (RunType) Number 

func (x RunType) Number() protoreflect.EnumNumber

func (RunType) String 

func (x RunType) String() string

func (RunType) Type 

func (RunType) Type() protoreflect.EnumType

type SorMode added in v0.26.3 

type SorMode int32
const (
	SorMode_FULL SorMode = 0
	SorMode_FAST SorMode = 1
)

func (SorMode) Descriptor added in v0.26.3 

func (SorMode) Descriptor() protoreflect.EnumDescriptor

func (SorMode) Enum added in v0.26.3 

func (x SorMode) Enum() *SorMode

func (SorMode) EnumDescriptor deprecated added in v0.26.3 

func (SorMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use SorMode.Descriptor instead.

func (SorMode) Number added in v0.26.3 

func (x SorMode) Number() protoreflect.EnumNumber

func (SorMode) String added in v0.26.3 

func (x SorMode) String() string

func (SorMode) Type added in v0.26.3 

func (SorMode) Type() protoreflect.EnumType

type SorRequest 

type SorRequest struct {
	Detectors []*DetectorOperationRequest `protobuf:"bytes,1,rep,name=detectors,proto3" json:"detectors,omitempty"`
	RunType   RunType                     `protobuf:"varint,2,opt,name=runType,proto3,enum=dcs.RunType" json:"runType,omitempty"` // default: NULL_RUNTYPE, should probably never be sent
	RunNumber int32                       `protobuf:"varint,3,opt,name=runNumber,proto3" json:"runNumber,omitempty"`
	// contains filtered or unexported fields
}

A SorRequest encapsulates a list of detector-specific request payloads, plus a common runType and a runNumber for the run about to start.

func (*SorRequest) Descriptor deprecated 

func (*SorRequest) Descriptor() ([]byte, []int)

Deprecated: Use SorRequest.ProtoReflect.Descriptor instead.

func (*SorRequest) GetDetectors added in v0.26.3 

func (x *SorRequest) GetDetectors() []*DetectorOperationRequest

func (*SorRequest) GetRunNumber 

func (x *SorRequest) GetRunNumber() int32

func (*SorRequest) GetRunType 

func (x *SorRequest) GetRunType() RunType

func (*SorRequest) ProtoMessage 

func (*SorRequest) ProtoMessage()

func (*SorRequest) ProtoReflect 

func (x *SorRequest) ProtoReflect() protoreflect.Message

func (*SorRequest) Reset 

func (x *SorRequest) Reset()

func (*SorRequest) String 

func (x *SorRequest) String() string

type StatusReply 

type StatusReply struct {
	DetectorMatrix []*DetectorInfo `protobuf:"bytes,1,rep,name=detectorMatrix,proto3" json:"detectorMatrix,omitempty"` // an exhaustive list of DetectorInfos
	// contains filtered or unexported fields
}

Aggregate response to a GetStatus call, wraps around a list of DetectorInfo payloads.

func (*StatusReply) Descriptor deprecated 

func (*StatusReply) Descriptor() ([]byte, []int)

Deprecated: Use StatusReply.ProtoReflect.Descriptor instead.

func (*StatusReply) GetDetectorMatrix added in v0.26.3 

func (x *StatusReply) GetDetectorMatrix() []*DetectorInfo

func (*StatusReply) ProtoMessage 

func (*StatusReply) ProtoMessage()

func (*StatusReply) ProtoReflect 

func (x *StatusReply) ProtoReflect() protoreflect.Message

func (*StatusReply) Reset 

func (x *StatusReply) Reset()

func (*StatusReply) String 

func (x *StatusReply) String() string

type StatusRequest 

type StatusRequest struct {
	Detector []Detector `protobuf:"varint,1,rep,packed,name=detector,proto3,enum=dcs.Detector" json:"detector,omitempty"`
	// contains filtered or unexported fields
}

Payload for the GetStatus call, just a list of detectors to query.

func (*StatusRequest) Descriptor deprecated 

func (*StatusRequest) Descriptor() ([]byte, []int)

Deprecated: Use StatusRequest.ProtoReflect.Descriptor instead.

func (*StatusRequest) GetDetector 

func (x *StatusRequest) GetDetector() []Detector

func (*StatusRequest) ProtoMessage 

func (*StatusRequest) ProtoMessage()

func (*StatusRequest) ProtoReflect 

func (x *StatusRequest) ProtoReflect() protoreflect.Message

func (*StatusRequest) Reset 

func (x *StatusRequest) Reset()

func (*StatusRequest) String 

func (x *StatusRequest) String() string

type SubscriptionRequest 

type SubscriptionRequest struct {
	InstanceId string `protobuf:"bytes,1,opt,name=instanceId,proto3" json:"instanceId,omitempty"`
	// contains filtered or unexported fields
}

func (*SubscriptionRequest) Descriptor deprecated 

func (*SubscriptionRequest) Descriptor() ([]byte, []int)

Deprecated: Use SubscriptionRequest.ProtoReflect.Descriptor instead.

func (*SubscriptionRequest) GetInstanceId 

func (x *SubscriptionRequest) GetInstanceId() string

func (*SubscriptionRequest) ProtoMessage 

func (*SubscriptionRequest) ProtoMessage()

func (*SubscriptionRequest) ProtoReflect 

func (x *SubscriptionRequest) ProtoReflect() protoreflect.Message

func (*SubscriptionRequest) Reset 

func (x *SubscriptionRequest) Reset()

func (*SubscriptionRequest) String 

func (x *SubscriptionRequest) String() string

type TriggerMode 

type TriggerMode int32
const (
	TriggerMode_CONTINUOUS TriggerMode = 0
	TriggerMode_TRIGGERED  TriggerMode = 1
)

func (TriggerMode) Descriptor 

func (TriggerMode) Descriptor() protoreflect.EnumDescriptor

func (TriggerMode) Enum 

func (x TriggerMode) Enum() *TriggerMode

func (TriggerMode) EnumDescriptor deprecated 

func (TriggerMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use TriggerMode.Descriptor instead.

func (TriggerMode) Number 

func (x TriggerMode) Number() protoreflect.EnumNumber

func (TriggerMode) String 

func (x TriggerMode) String() string

func (TriggerMode) Type 

func (TriggerMode) Type() protoreflect.EnumType

type UnimplementedConfiguratorServer 

type UnimplementedConfiguratorServer struct {
}

UnimplementedConfiguratorServer should be embedded to have forward compatible implementations.

func (UnimplementedConfiguratorServer) EndOfRun 

func (UnimplementedConfiguratorServer) EndOfRun(*EorRequest, Configurator_EndOfRunServer) error

func (UnimplementedConfiguratorServer) GetStatus 

func (UnimplementedConfiguratorServer) GetStatus(context.Context, *StatusRequest) (*StatusReply, error)

func (UnimplementedConfiguratorServer) PrepareForRun added in v0.69.0 

func (UnimplementedConfiguratorServer) PrepareForRun(*PfrRequest, Configurator_PrepareForRunServer) error

func (UnimplementedConfiguratorServer) StartOfRun 

func (UnimplementedConfiguratorServer) StartOfRun(*SorRequest, Configurator_StartOfRunServer) error

func (UnimplementedConfiguratorServer) Subscribe 

func (UnimplementedConfiguratorServer) Subscribe(*SubscriptionRequest, Configurator_SubscribeServer) error

type UnsafeConfiguratorServer 

type UnsafeConfiguratorServer interface {
	// contains filtered or unexported methods
}

UnsafeConfiguratorServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ConfiguratorServer will result in compilation errors.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.