GLAT Class Reference

GLAST LAT node Record. More...

Inheritance diagram for GLAT:

[legend]Collaboration diagram for GLAT:

[legend]List of all members.

Public Member Functions
	__init__ (client)
	Initialize valid registers as Gattrs.
	read (reg)
	load (reg, value)
	readSchema (name)
	writeSchema (fileName)
	writeConfig (fileName, seq=None)
	takeSnapshot (stream, fileName, captureGTIC, captureGAEQ, trigger, configName, configVersion)
	readConfig (cfgFileName)
	applyConfig (seq=None, gxbrd=None)
	getSysReg (node, regName)
	Returns the system register value applied.
	downTEM (childId)
	Navigate to the GTEM indicated by childId.
	allTEM ()
	Navigate to the GTEM broadcast node.
	downPDU (childId)
	Navigate to the GPDU indicated by childId.
	downAEM ()
	Navigate to the GAEM.
	downGEM ()
	Navigate to the GGEM.
	downEBM ()
	Navigate to the GEBM.
	downLCB ()
	Navigate to the GLCB.
	downCRU ()
	Navigate to the GCRU.
	TEMcnt ()
	Return the TEM count.
	existsTEM (temId)
	Check if the GTEM instance with the id temId exists in the schema.
	existsPDU (pduId)
	Check if the GPDU instance with the id pduId exists in the schema.
	existsAEM ()
	Check if the GAEM instance exists in the schema.
	existsGEM ()
	Check if the GGEM instance exists in the schema.
	existsEBM ()
	Check if the GEBM instance exists in the schema.
	existsCRU ()
	Check if the GCRU instance exists in the schema.
	existsLCB ()
	Check if the GLCB instance exists in the schema.
	getConfigurations ()
	Get list of configurations.
	getDeclarations ()
	Get list of declarations.
	getRules ()
	Retrieves the rule dictionary as defined by the current schema/configuration.
	getAllOpaque ()
	Return all opaque data.
	getAllSerialNos ()
	Return all opaque data.
	getAllExcludeFlags ()
	Return all exclude data.

---

Detailed Description

GLAST LAT node Record.

The GLAT node provides access to parity registers and event statistics registers.

Valid Registers:

• parity_latp_cell_header
• parity_latp_cell_body
• parity_tem_cmd_str
• parity_tem_access_desc
• parity_tem_cmd_payload
• stats_failed_events
• stats_failed_event_sends
• stats_valid_events
• stats_discarded_event_sends
• stats_length_mismatch_count
• stats_events_not_sent

Deprecated:

• parity_latp_cell_header Use 'LCB.parity_latp_cell_header' instead
• parity_latp_cell_body Use 'LCB.parity_latp_cell_body' instead
• stats_failed_events Use 'OCS.stats_failed_events' instead
• stats_failed_event_sends Use 'OCS.stats_failed_event_sends' instead
• stats_valid_events Use 'OCS.stats_valid_events' instead
• stats_discarded_event_sends Use 'OCS.stats_discarded_event_sends' instead
• stats_length_mismatch_count Use 'OCS.stats_length_mismatch_count' instead
• stats_events_not_sent Use 'OCS.stats_events_not_sent' instead

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 the event mode is set to DONOT_SEND_EVENTS where the incoming events will not be forwarded to the client over the socket.

Definition at line 135 of file gLAT.py.

---

Member Function Documentation

__init__ (  client   )

Initialize valid registers as Gattrs. Assign default values to members

allTEM (   )

Navigate to the GTEM broadcast node. Returns: the GTEM broadcast node instance

downAEM (   )

Navigate to the GAEM. Returns: the GAEM object instance

downCRU (   )

Navigate to the GCRU. Returns: the GCRU object instance

downEBM (   )

Navigate to the GEBM. Returns: the GEBM object instance

downGEM (   )

Navigate to the GGEM. Returns: the GGEM object instance

downLCB (   )

Navigate to the GLCB. Returns: the GLCB object instance

downPDU (  childId   )

Navigate to the GPDU indicated by childId. Parameters: childId  The id of the child PDU Returns: a GPDU object instance

downTEM (  childId   )

Navigate to the GTEM indicated by childId. Parameters: childId  The id of the child TEM Returns: a GTEM object instance

existsAEM (   )

Check if the GAEM instance exists in the schema. Returns: 1 if it exists, 0 if it doesn't.

existsCRU (   )

Check if the GCRU instance exists in the schema. Returns: 1 if it exists, 0 if it doesn't.

existsEBM (   )

Check if the GEBM instance exists in the schema. Returns: 1 if it exists, 0 if it doesn't.

existsGEM (   )

Check if the GGEM instance exists in the schema. Returns: 1 if it exists, 0 if it doesn't.

existsLCB (   )

Check if the GLCB instance exists in the schema. Returns: 1 if it exists, 0 if it doesn't.

existsPDU (  pduId   )

Check if the GPDU instance with the id pduId exists in the schema. Parameters: pduId  PDU id Returns: 1 if it exists, 0 if it doesn't.

existsTEM (  temId   )

Check if the GTEM instance with the id temId exists in the schema. Parameters: temId  TEM id Returns: 1 if it exists, 0 if it doesn't.

getAllExcludeFlags (   )

Return all exclude data. Returns: All exclude data regardless of the node they are associated with.

getAllOpaque (   )

Return all opaque data. Returns: All opaque data regardless of the node they are associated with.

getAllSerialNos (   )

Return all opaque data. Returns: All serial number data regardless of the node they are associated with.

getConfigurations (   )

Get list of configurations. Return a list of configuration tuples where each tuple contains the configDOM, configName and configRelease. Returns: Configuration tuple list.

getDeclarations (   )

Get list of declarations. Return a list of declarations Returns: Declarations.

getRules (   )

Retrieves the rule dictionary as defined by the current schema/configuration. Returns: Dictionary containing Grule objects (or its descendants).

getSysReg (  node  , regName  )

Returns the system register value applied. The value of the register applied in the configuration and specified by node and regName is returned. Returns: Register value or None

TEMcnt (   )

Return the TEM count. Returns: Current TEM count

---

The documentation for this class was generated from the following file:

• gLAT.py

---