DtDiGuyActionRecord Class Reference

Inheritance diagram for DtDiGuyActionRecord:

Collaboration diagram for DtDiGuyActionRecord:

Public Member Functions
	DtDiGuyActionRecord ()
	Constructor. More...
	DtDiGuyActionRecord (const DtDiGuyActionRecord &orig)
	Copy Constructor. More...
	DtDiGuyActionRecord (void *netBuffer, unsigned int size)
	Net Constructor. More...
virtual DtDiGuyActionRecord &	operator= (const DtDiGuyActionRecord &record)
	Assignment Operator. More...
virtual DtStandardVariableRecord &	operator= (const DtStandardVariableRecord &other)
	Assignment operator. More...
virtual bool	operator== (const DtDiGuyActionRecord &record)
	Equals Operator. More...
virtual bool	operator== (const DtStandardVariableRecord &other)
	Equals operator. More...
virtual void	writeRecord (void *addr) const
virtual void	setFromNet (const void *netRecord, unsigned int length, DtStandardVariableRetCode *retCode=NULL)
	Sets the record from an address and length. More...
virtual void	printDataToStream (std::ostream &stream) const
	Prints the data to the specified stream. More...
virtual unsigned int	unpaddedNetsize () const
	This is the network size of the record without padding. More...
virtual DtStandardVariableRecord *	clone () const
	Clone. More...
virtual unsigned int	recordType () const
	Get/Set Record Type. More...
virtual void	setRecordType (unsigned int recordType)
	Get/Set Record Type. More...
virtual unsigned int	recordLength () const
	Get/Set Record Length. More...
virtual void	setRecordLength (unsigned int length)
	Must include size of record header and padding to 8 bytes. More...
virtual const char *	action () const
	Set/Get action. More...
virtual void	setAction (const DtString &actionValue)
	Set/Get action. More...
virtual bool	isPaused () const
	Set/Get is paused. More...
virtual void	setIsPaused (bool paused)
	Set/Get is paused. More...
virtual float	speed () const
	Set/Get speed. More...
virtual void	setSpeed (float speedValue)
	Set/Get speed. More...
virtual short	usePositioningFlag () const
	Set/Get usePositioningFlag. More...
virtual void	setUsePositioningFlag (short usePositioningFlag)
	Set/Get usePositioningFlag. More...
virtual DtVector	offset () const
	Set/Get offset. More...
virtual void	setOffset (DtVector offset)
	Set/Get offset. More...
virtual float	transitionSpeed () const
	Set/Get transition speed. More...
virtual void	setTransitionSpeed (float tSpeed)
	Set/Get transition speed. More...
Public Member Functions inherited from DtStandardVariableRecord
	DtStandardVariableRecord ()
	Constructor. More...
virtual	~DtStandardVariableRecord ()
	Destructor. More...
virtual void	printData () const
	Prints the data to DtInfo. More...
virtual unsigned int	netSize ()
	Returns the size of the network representation (including padding bytes) More...
virtual void	setOriginatingSimulationAddress (const DtSimulationAddress &)
virtual const DtSimulationAddress &	originatingSimulationAddress () const

Static Public Member Functions
static DtStandardVariableRecord *	create (void *addr, unsigned int length)
	Creator of an unknown record for registering in a factory. More...
static unsigned int	recordTypeToUse ()
	Return the DI-Guy Action record type. More...
static void	setRecordTypeToUse (unsigned int typeToUse)
	Set the record type to use. More...

Protected Member Functions
virtual void	updateTransitionSpeedData ()
	Update the transition speed member variable and transition speed pointer. More...

Protected Attributes
std::vector< char >	myRecordBuffer
DtNetDiGuyActionRecord *	myRecordPtr
char *	myActionPtr
char *	myTransitionSpeedPtr
bool	myPtrIsDirty
float	myTransitionSpeed
Protected Attributes inherited from DtStandardVariableRecord
DtSimulationAddress	myOriginatingSimulationAddress

Static Protected Attributes
static const unsigned int	theMinimumSize

Constructor & Destructor Documentation

DtDiGuyActionRecord::DtDiGuyActionRecord

(

)

Constructor.

DtDiGuyActionRecord::DtDiGuyActionRecord

(

const DtDiGuyActionRecord &

orig

)

Copy Constructor.

DtDiGuyActionRecord::DtDiGuyActionRecord	(	void *	netBuffer,
		unsigned int	size
	)

Net Constructor.

Member Function Documentation

virtual const char* DtDiGuyActionRecord::action ( ) const

virtual

Set/Get action.

virtual DtStandardVariableRecord* DtDiGuyActionRecord::clone ( ) const

virtual

Clone.

Implements DtStandardVariableRecord.

static DtStandardVariableRecord* DtDiGuyActionRecord::create ( void *  addr, unsigned int  length  )

static

Creator of an unknown record for registering in a factory.

virtual bool DtDiGuyActionRecord::isPaused ( ) const

virtual

Set/Get is paused.

virtual DtVector DtDiGuyActionRecord::offset ( ) const

virtual

Set/Get offset.

virtual DtDiGuyActionRecord& DtDiGuyActionRecord::operator= ( const DtDiGuyActionRecord &  record )

virtual

Assignment Operator.

virtual DtStandardVariableRecord& DtDiGuyActionRecord::operator= ( const DtStandardVariableRecord &  other )

virtual

Assignment operator.

virtual bool DtDiGuyActionRecord::operator== ( const DtDiGuyActionRecord &  record )

virtual

Equals Operator.

virtual bool DtDiGuyActionRecord::operator== ( const DtStandardVariableRecord &  other )

virtual

Equals operator.

Implements DtStandardVariableRecord.

virtual void DtDiGuyActionRecord::printDataToStream ( std::ostream &  stream ) const

virtual

Prints the data to the specified stream.

Implements DtStandardVariableRecord.

virtual unsigned int DtDiGuyActionRecord::recordLength ( ) const

virtual

Get/Set Record Length.

Implements DtStandardVariableRecord.

virtual unsigned int DtDiGuyActionRecord::recordType ( ) const

virtual

Get/Set Record Type.

Implements DtStandardVariableRecord.

static unsigned int DtDiGuyActionRecord::recordTypeToUse ( )

static

Return the DI-Guy Action record type.

virtual void DtDiGuyActionRecord::setAction ( const DtString &  actionValue )

virtual

Set/Get action.

virtual void DtDiGuyActionRecord::setFromNet ( const void *  netRecord, unsigned int  length, DtStandardVariableRetCode *  retCode = NULL  )

virtual

Sets the record from an address and length.

Return code will be Valid if all goes well. Memory must exist for life of the variable record

Implements DtStandardVariableRecord.

virtual void DtDiGuyActionRecord::setIsPaused ( bool  paused )

virtual

Set/Get is paused.

virtual void DtDiGuyActionRecord::setOffset ( DtVector  offset )

virtual

Set/Get offset.

virtual void DtDiGuyActionRecord::setRecordLength ( unsigned int  length )

virtual

Must include size of record header and padding to 8 bytes.

Implements DtStandardVariableRecord.

virtual void DtDiGuyActionRecord::setRecordType ( unsigned int  recordType )

virtual

Get/Set Record Type.

Implements DtStandardVariableRecord.

static void DtDiGuyActionRecord::setRecordTypeToUse ( unsigned int  typeToUse )

static

Set the record type to use.

virtual void DtDiGuyActionRecord::setSpeed ( float  speedValue )

virtual

Set/Get speed.

virtual void DtDiGuyActionRecord::setTransitionSpeed ( float  tSpeed )

virtual

Set/Get transition speed.

virtual void DtDiGuyActionRecord::setUsePositioningFlag ( short  usePositioningFlag )

virtual

Set/Get usePositioningFlag.

virtual float DtDiGuyActionRecord::speed ( ) const

virtual

Set/Get speed.

virtual float DtDiGuyActionRecord::transitionSpeed ( ) const

virtual

Set/Get transition speed.

virtual unsigned int DtDiGuyActionRecord::unpaddedNetsize ( ) const

virtual

This is the network size of the record without padding.

Implements DtStandardVariableRecord.

virtual void DtDiGuyActionRecord::updateTransitionSpeedData ( )

protectedvirtual

Update the transition speed member variable and transition speed pointer.

virtual short DtDiGuyActionRecord::usePositioningFlag ( ) const

virtual

Set/Get usePositioningFlag.

virtual void DtDiGuyActionRecord::writeRecord ( void *  addr ) const

virtual

Implements DtStandardVariableRecord.

Member Data Documentation

char* DtDiGuyActionRecord::myActionPtr

protected

bool DtDiGuyActionRecord::myPtrIsDirty

protected

std::vector<char> DtDiGuyActionRecord::myRecordBuffer

protected

DtNetDiGuyActionRecord* DtDiGuyActionRecord::myRecordPtr

protected

float DtDiGuyActionRecord::myTransitionSpeed

protected

char* DtDiGuyActionRecord::myTransitionSpeedPtr

protected

const unsigned int DtDiGuyActionRecord::theMinimumSize

staticprotected

---

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

• diGuyActionRecord.h