EventSummary Class Reference

Class for accessing fields in the event summary longword. More...

#include <eventSummary.h>

List of all members.

Public Member Functions
	EventSummary (unsigned summary)
	Constructor for initializing the EventSummary class with a summary word.
unsigned	calStrobe () const
	Method for returning the calStrobe state in the summary word.
unsigned	tag () const
	Method for returning the tag value in the summary word.
unsigned	TACK () const
	Method for returning the TACK state in the summary word.
unsigned	readout4 () const
	Method for returning the 4-range readout state in the summary word.
unsigned	zeroSuppress () const
	Method for returning the zeroSuppress state in the summary word.
unsigned	marker () const
	Method for returning the marker value in the summary word.
unsigned	error () const
	Method for returning the error state in the summary word.
unsigned	diagnostic () const
	Method for returning the diagnostic state in the summary word.
unsigned	eventNumber () const
	Method for returning the eventNumber value in the summary word.
unsigned	trgParityError () const
	Method for returning the trigger message parity error state in the summary word.
Static Public Member Functions
static unsigned	calStrobe (unsigned summary)
	Static method for returning the calStrobe state in the summary word.
static unsigned	tag (unsigned summary)
	Static method for returning the tag value in the summary word.
static unsigned	TACK (unsigned summary)
	Static method for returning the TACK state in the summary word.
static unsigned	readout4 (unsigned summary)
	Static method for returning the 4-range readout state in the summary word.
static unsigned	zeroSuppress (unsigned summary)
	Static method for returning the zeroSuppress state in the summary word.
static unsigned	marker (unsigned summary)
	Static method for returning the marker value in the summary word.
static unsigned	error (unsigned summary)
	Static method for returning the error state in the summary word.
static unsigned	diagnostic (unsigned summary)
	Static method for returning the diagnostic state in the summary word.
static unsigned	eventNumber (unsigned summary)
	Static method for returning the eventNumber value in the summary word.
static unsigned	trgParityError (unsigned summary)
	Static method for returning the trigger message parity error state in the summary word.

---

Detailed Description

Class for accessing fields in the event summary longword.

Author:

Ric Claus -- GLAST LAT I&T/Online - (claus@slac.stanford.edu)

Revision

1.2

Date:

January 22, 2003 -- Created

Id

eventSummary.h,v 1.2 2004/04/01 23:45:57 claus Exp

Copyright: Copyright 2004 by The Board of Trustees of the Leland Stanford Junior University. All rights reserved.

---

Constructor & Destructor Documentation

EventSummary::EventSummary

(

unsigned

summary

)

[inline]

Constructor for initializing the EventSummary class with a summary word.

Parameters:

summary

- A summary word

---

Member Function Documentation

unsigned EventSummary::calStrobe

(

)

const [inline]

Method for returning the calStrobe state in the summary word.

Returns:

The calStrobe state

unsigned EventSummary::calStrobe

(

unsigned

summary

)

[inline, static]

Static method for returning the calStrobe state in the summary word.

Parameters:

summary

- A summary word

Returns:

The calStrobe state

unsigned EventSummary::diagnostic

(

)

const [inline]

Method for returning the diagnostic state in the summary word.

If this error state is true, this event will have an diagnostic contribution decodable with DIAGcontributionIterator.

Returns:

The diagnostic state

unsigned EventSummary::diagnostic

(

unsigned

summary

)

[inline, static]

Static method for returning the diagnostic state in the summary word.

If this error state is true, this event will have an diagnostic contribution decodable with DIAGcontributionIterator.

Parameters:

summary

- A summary word

Returns:

The diagnostic state

unsigned EventSummary::error

(

)

const [inline]

Method for returning the error state in the summary word.

If this error state is true, this event will have an error contribution decodable with ERRcontributionIterator.

Returns:

The error state

unsigned EventSummary::error

(

unsigned

summary

)

[inline, static]

Static method for returning the error state in the summary word.

If this error state is true, this event will have an error contribution decodable with ERRcontributionIterator.

Parameters:

summary

- A summary word

Returns:

The error state

unsigned EventSummary::eventNumber

(

)

const [inline]

Method for returning the eventNumber value in the summary word.

Returns:

The eventNumber value

unsigned EventSummary::eventNumber

(

unsigned

summary

)

[inline, static]

Static method for returning the eventNumber value in the summary word.

Parameters:

summary

- A summary word

Returns:

The eventNumber value

unsigned EventSummary::marker

(

)

const [inline]

Method for returning the marker value in the summary word.

Returns:

The marker value

unsigned EventSummary::marker

(

unsigned

summary

)

[inline, static]

Static method for returning the marker value in the summary word.

Parameters:

summary

- A summary word

Returns:

The marker value

unsigned EventSummary::readout4

(

)

const [inline]

Method for returning the 4-range readout state in the summary word.

Returns:

The 4-range readout state

unsigned EventSummary::readout4

(

unsigned

summary

)

[inline, static]

Static method for returning the 4-range readout state in the summary word.

Parameters:

summary

- A summary word

Returns:

The 4-range readout state

unsigned EventSummary::TACK

(

)

const [inline]

Method for returning the TACK state in the summary word.

Returns:

The TACK state

unsigned EventSummary::TACK

(

unsigned

summary

)

[inline, static]

Static method for returning the TACK state in the summary word.

Parameters:

summary

- A summary word

Returns:

The TACK state

unsigned EventSummary::tag

(

)

const [inline]

Method for returning the tag value in the summary word.

Returns:

The tag value

unsigned EventSummary::tag

(

unsigned

summary

)

[inline, static]

Static method for returning the tag value in the summary word.

Parameters:

summary

- A summary word

Returns:

The tag value

unsigned EventSummary::trgParityError

(

)

const [inline]

Method for returning the trigger message parity error state in the summary word.

Returns:

The trigger message parity error state

unsigned EventSummary::trgParityError

(

unsigned

summary

)

[inline, static]

Static method for returning the trigger message parity error state in the summary word.

Parameters:

summary

- A summary word

Returns:

The trigger message parity error state

unsigned EventSummary::zeroSuppress

(

)

const [inline]

Method for returning the zeroSuppress state in the summary word.

Returns:

The zeroSuppress state

unsigned EventSummary::zeroSuppress

(

unsigned

summary

)

[inline, static]

Static method for returning the zeroSuppress state in the summary word.

Parameters:

summary

- A summary word

Returns:

The zeroSuppress state

---

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

• eventSummary.h

---