Inheritance diagram for GOCS:
Public Member Functions | |
__init__ (client) | |
read (reg) | |
load (reg, value) | |
evtHandlerSendAll () | |
Sets the current event mode to send all events to the client. | |
evtHandlerSendNothing () | |
Sets the current event mode to send no data events to the client. | |
evtHandlerSendErrorsOnly () | |
Sets the current event mode to send only error events to the client. | |
evtHandlerSendAcdScalers (marker, prescale=0) | |
Sets the current event mode to send only events containing the ACD software scalers to the client upon recept of the given marker. All marker zero events are accumulated by the scaler code. If an event is triggered with the specified marker, the scaler data will be delivered with that event. Thus, if the specified marker is zero, then all data events will be accompanied by the scaler data. In addition, marker zero events can be prescaled before delivery to the client. A prescale value of zero (the default) delivers every marker zero event. A prescale value of 0xffffffffL disables prescaling and delivers no events. | |
evtHandlerSendPrescaled (prescale) | |
Sets the current event mode to send prescaled events to the client. A prescale value of zero delivers every event. A prescale value of 0xffffffffL disables prescaling and delivers no events. | |
evtHandlerPrescaleExternal (prescale) | |
Sets the current event mode to prescale externally triggered events. Only events with only the external trigger firing will be prescaled. A prescale value of zero delivers every event. A prescale value of 0xffffffffL disables prescaling and delivers no events. | |
evtHandlerFilterTkrHits (lowThreshold=0, towerMask=0xffff, highThreshold=0xffffffffL, prescale=0xffffffffL) | |
Sets the current event mode to the Tracker Hit Filter. | |
evtHandlerSetVerbosity (verbosity) | |
Sets the event server verbosity. | |
evtClearEvtSeqMSW () | |
Clears the event sequence counter. | |
synchronize () | |
Synchronize the SBC's clock with the host's clock. | |
getCallbackParams () | |
Return a dictionary of the parameters used in the active OES callback. | |
getVersion () | |
Get the protocol versions of code running on the SBC. | |
getStartupScriptInfo () | |
Retrieve CVS
| |
verifyVersion () | |
Verify that the protocol version of the code running on the SBC is one the host code is expected to support. | |
cmxAsBuilt () |
Has OCS specific registers and methods.
Valid Registers:
stats_failed_events
stats_failed_event_sends
stats_valid_events
stats_discarded_event_sends
stats_length_mismatch_count
stats_events_not_sent
stats_filter_pkt_errors
stats_filter_src_errors
stats_filter_passes
stats_filter_fails
stats_handled_events
Event statistics:
The following statistics registers are initialized at the start of each RunControl run:
stats_failed_events
-- Counts events where the eventHandler receives a bad status for the event.
stats_failed_event_sends
-- Counts events where the socket send failed with an error other than EWOULDBLOCK.
stats_valid_events
-- Counts when a valid event has been successfully sent to the client.
stats_discarded_event_sends
-- Counts cases when an event send failed due to the fact that the send returned an EWOULDBLOCK error.
stats_length_mismatch_count
-- Counts cases when the length argument passed to the event handler did not match the length provided in the event header.
stats_events_not_sent
-- Counts when an event is not sent over the socket due a filter or a scaler.
stats_filter_pkt_errors
-- Counts when the filtered event has a packet error in its contribution.
stats_filter_src_errors
-- Counts when the filtered event has a source error in its contribution.
stats_filter_passes
-- Counts when the event goes through the filter.
stats_filter_fails
-- Counts when the event fails the filter.
stats_handled_events
-- Counts when the event is received by the SBC event handler.
Definition at line 68 of file gOCS.py.
|
Sets the current event mode to the Tracker Hit Filter. The Tracker Hit Filter filters events based on the number of hits in the tracker. Only events with no errors will be filtered. The filter algorithm sums up the number of hits found in the tracker contributions of the towers given in the towerMask and requires this total number of hits to be greater than or equal to the lowThreshold value and less than or equal to the highThreshold value in order to send the event downstream. The default threshold values allow all events to pass the filter, i.e., the default low threshold is zero, and the default high threshold is larger than the full LAT can generate. The towerMask value is constructed by setting the bit at the position corresponding to the tower address of the tower to be included. Bit zero is the least significant, right-most bit and corresponds to the tower with LATp address zero. By default, all 16 towers are included in the filter calculation. A prescale can be applied to allow a fraction of the events that don't pass the TKR hit filter through. If the prescale value is zero, the TKR hit filter is ignored. If the prescale value is 0xffffffffL (the default), prescaling is disabled and filtering is determined by the TKR hit filter. If prescaling is enabled, every event is considered for prescaling, not just the events that fail the TKR hit filter.
|
|
Sets the current event mode to prescale externally triggered events. Only events with only the external trigger firing will be prescaled. A prescale value of zero delivers every event. A prescale value of 0xffffffffL disables prescaling and delivers no events.
|
|
Sets the current event mode to send only events containing the ACD software scalers to the client upon recept of the given marker. All marker zero events are accumulated by the scaler code. If an event is triggered with the specified marker, the scaler data will be delivered with that event. Thus, if the specified marker is zero, then all data events will be accompanied by the scaler data. In addition, marker zero events can be prescaled before delivery to the client. A prescale value of zero (the default) delivers every marker zero event. A prescale value of 0xffffffffL disables prescaling and delivers no events.
|
|
Sets the current event mode to send prescaled events to the client. A prescale value of zero delivers every event. A prescale value of 0xffffffffL disables prescaling and delivers no events.
|
|
Sets the event server verbosity.
|
|
Retrieve CVS
|