Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages

SctPixelRod::RodPrimList Class Reference

This is a list of RodPrimitives to be sent to the RodModule. More...

#include <RodPrimList.h>


Public Member Functions

 RodPrimList (unsigned long theIndex)
 Constructor with specified index.

 RodPrimList ()
 Default constructor.

 RodPrimList (const RodPrimList &rhs)
 Copy constructor.

RodPrimListoperator= (const RodPrimList &)
 Overloaded assignment.

 ~RodPrimList ()
 Destructor.

unsigned long checkSum ()
 Compute list checksum.

unsigned long numWords ()
 Compute number of words in list.

void bufferBuild () throw (PrimListException &)
 Create the buffer to send.

void writeToXml (std::string &xmlFile) throw (PrimListException &)
 Write the buffer to an XML file. Buffer must already be built when this is called.

void buildFromXml (std::string &xmlFile) throw (PrimListException &)
 Create the buffer from an XML file.

long getBufferLength ()
 Return the buffer lingth.

unsigned long * getBuffer ()
 Return the buffer.

void print ()
 Print the primitive list.

void clear ()
 Clear the primitive list.

void setIndex (unsigned long i)
 Set the list identifier index.

unsigned long getIndex () const
 Get the list identifier index.

void setVersion (unsigned long version)
 Set the version number.

unsigned long getVersion () const
 Get the version number.


Private Attributes

unsigned long m_index
 Unique list identifier.

unsigned long m_version
 PrimList version number.

unsigned long * m_buffer
 Buffer to send.

unsigned long m_bufferSize
 Buffer size.


Detailed Description

This is a list of RodPrimitives to be sent to the RodModule.

This class is a list of the primitives that control ROD behavior. It is sent to the RodModule via its Send function. As it is derived from the STL list, it inherits all the usual list functionality.

Author:
Tom Meyer (meyer@iastate.edu) - originator

Definition at line 49 of file RodPrimList.h.


Constructor & Destructor Documentation

SctPixelRod::RodPrimList::RodPrimList unsigned long  theIndex  )  [inline]
 

Constructor with specified index.

Definition at line 62 of file RodPrimList.h.

References m_buffer, m_bufferSize, m_index, and m_version.

SctPixelRod::RodPrimList::RodPrimList  )  [inline]
 

Default constructor.

Definition at line 66 of file RodPrimList.h.

References m_buffer, m_bufferSize, m_index, and m_version.

SctPixelRod::RodPrimList::RodPrimList const RodPrimList rhs  ) 
 

Copy constructor.

Definition at line 38 of file RodPrimList.cxx.

References m_index, and m_version.

SctPixelRod::RodPrimList::~RodPrimList  ) 
 

Destructor.

Definition at line 60 of file RodPrimList.cxx.

References m_buffer.


Member Function Documentation

void SctPixelRod::RodPrimList::bufferBuild  )  throw (PrimListException &)
 

Create the buffer to send.

Definition at line 82 of file RodPrimList.cxx.

Referenced by SctPixelRod::RodModule::synchSendPrim().

void SctPixelRod::RodPrimList::buildFromXml std::string &  xmlFile  )  throw (PrimListException &)
 

Create the buffer from an XML file.

Definition at line 149 of file RodPrimList.cxx.

unsigned long SctPixelRod::RodPrimList::checkSum  ) 
 

Compute list checksum.

Definition at line 74 of file RodPrimList.cxx.

References m_buffer, and m_bufferSize.

void SctPixelRod::RodPrimList::clear  ) 
 

Clear the primitive list.

Definition at line 261 of file RodPrimList.cxx.

References m_buffer, and m_bufferSize.

unsigned long* SctPixelRod::RodPrimList::getBuffer  )  [inline]
 

Return the buffer.

Definition at line 94 of file RodPrimList.h.

References m_buffer.

long SctPixelRod::RodPrimList::getBufferLength  )  [inline]
 

Return the buffer lingth.

Definition at line 91 of file RodPrimList.h.

References m_buffer.

unsigned long SctPixelRod::RodPrimList::getIndex  )  const [inline]
 

Get the list identifier index.

Definition at line 105 of file RodPrimList.h.

References m_index.

Referenced by operator=().

unsigned long SctPixelRod::RodPrimList::getVersion  )  const [inline]
 

Get the version number.

Definition at line 110 of file RodPrimList.h.

References m_version.

Referenced by operator=().

unsigned long SctPixelRod::RodPrimList::numWords  ) 
 

Compute number of words in list.

Definition at line 65 of file RodPrimList.cxx.

RodPrimList & SctPixelRod::RodPrimList::operator= const RodPrimList  ) 
 

Overloaded assignment.

Definition at line 44 of file RodPrimList.cxx.

References getIndex(), getVersion(), m_buffer, m_bufferSize, m_index, and m_version.

Here is the call graph for this function:

void SctPixelRod::RodPrimList::print  ) 
 

Print the primitive list.

Definition at line 269 of file RodPrimList.cxx.

References m_buffer, and m_bufferSize.

void SctPixelRod::RodPrimList::setIndex unsigned long  i  )  [inline]
 

Set the list identifier index.

Definition at line 103 of file RodPrimList.h.

References m_index.

void SctPixelRod::RodPrimList::setVersion unsigned long  version  )  [inline]
 

Set the version number.

Definition at line 108 of file RodPrimList.h.

References m_index.

void SctPixelRod::RodPrimList::writeToXml std::string &  xmlFile  )  throw (PrimListException &)
 

Write the buffer to an XML file. Buffer must already be built when this is called.

Definition at line 111 of file RodPrimList.cxx.


Field Documentation

unsigned long* SctPixelRod::RodPrimList::m_buffer [private]
 

Buffer to send.

Definition at line 56 of file RodPrimList.h.

Referenced by checkSum(), clear(), getBuffer(), getBufferLength(), operator=(), print(), RodPrimList(), and ~RodPrimList().

unsigned long SctPixelRod::RodPrimList::m_bufferSize [private]
 

Buffer size.

Definition at line 58 of file RodPrimList.h.

Referenced by checkSum(), clear(), operator=(), print(), and RodPrimList().

unsigned long SctPixelRod::RodPrimList::m_index [private]
 

Unique list identifier.

Definition at line 52 of file RodPrimList.h.

Referenced by getIndex(), operator=(), RodPrimList(), setIndex(), and setVersion().

unsigned long SctPixelRod::RodPrimList::m_version [private]
 

PrimList version number.

Definition at line 54 of file RodPrimList.h.

Referenced by getVersion(), operator=(), and RodPrimList().


The documentation for this class was generated from the following files:
Generated on Thu Dec 22 20:23:26 2005 for SCT DAQ/DCS Software - C++ by doxygen 1.3.5