---

SctPixelRod::RodPrimList Class Reference

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

#include <RodPrimList.h>

Inheritance diagram for SctPixelRod::RodPrimList:

Public Member Functions
	RodPrimList (unsigned long theIndex)
	Constructor with specified index.
	RodPrimList ()
	Default constructor.
	RodPrimList (const RodPrimList &rhs)
	Copy constructor.
RodPrimList &	operator= (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 PRIM_LIST_REVISION.

SctPixelRod::RodPrimList::RodPrimList (    )  [inline]

Default constructor. Definition at line 66 of file RodPrimList.h. References PRIM_LIST_REVISION.

SctPixelRod::RodPrimList::RodPrimList (  const RodPrimList &    rhs )

Copy constructor.

SctPixelRod::RodPrimList::~RodPrimList (    )

Destructor.

---

Member Function Documentation

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

Create the buffer to send.

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

Create the buffer from an XML file.

unsigned long SctPixelRod::RodPrimList::checkSum (    )

Compute list checksum.

void SctPixelRod::RodPrimList::clear (    )

Clear the primitive list.

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

Return the buffer. Definition at line 94 of file RodPrimList.h.

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

Return the buffer lingth. Definition at line 91 of file RodPrimList.h.

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

Get the list identifier index. Definition at line 105 of file RodPrimList.h.

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

Get the version number. Definition at line 110 of file RodPrimList.h.

unsigned long SctPixelRod::RodPrimList::numWords (    )

Compute number of words in list.

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

Overloaded assignment.

void SctPixelRod::RodPrimList::print (    )

Print the primitive list.

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

Set the list identifier index. Definition at line 103 of file RodPrimList.h.

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

Set the version number. Definition at line 108 of file RodPrimList.h.

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.

---

Field Documentation

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

Buffer to send. Definition at line 56 of file RodPrimList.h.

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

Buffer size. Definition at line 58 of file RodPrimList.h.

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

Unique list identifier. Definition at line 52 of file RodPrimList.h.

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

PrimList version number. Definition at line 54 of file RodPrimList.h.

---

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

• RodPrimList.h

---