DtIoEffectRecord Class Reference

Inheritance diagram for DtIoEffectRecord:

Collaboration diagram for DtIoEffectRecord:

Public Member Functions
	DtIoEffectRecord ()
	Constructor. More...
	DtIoEffectRecord (DtIOStatus status, DtIOLinkType linkType, DtIOEffect effect, unsigned int effectDutyCycle, unsigned int effectDuration, DtIOProcess process)
	Constructor. More...
	DtIoEffectRecord (const DtIoEffectRecord &orig)
	Copy Constructor. More...
	DtIoEffectRecord (const DtNetIoEffectRecord &orig)
	Copy Constructor. More...
	DtIoEffectRecord (void *ptr, unsigned int length)
	Net Constructor. More...
virtual DtIoEffectRecord &	operator= (const DtIoEffectRecord &other)
	Assignment operator. More...
virtual DtStandardVariableRecord &	operator= (const DtStandardVariableRecord &record)
	Assignment operator. More...
virtual bool	operator== (const DtIoEffectRecord &other)
	Equals operator. More...
virtual bool	operator== (const DtStandardVariableRecord &other)
	Equals operator. More...
virtual unsigned int	recordType () const
	Setters and Getters for Record Type. More...
virtual void	setRecordType (unsigned int recordType)
	Get/Set Record Type. More...
virtual unsigned int	recordLength () const
	Setters and Getters for Record Length. More...
virtual void	setRecordLength (unsigned int recordLength)
	Must include size of record header and padding to 8 bytes. More...
virtual DtIOStatus	ioStatus () const
	Setters and Getters for IO Status. More...
virtual void	setIoStatus (DtIOStatus ioStatus)
virtual DtIOLinkType	ioLinkType () const
	Setters and Getters for IO Link Type. More...
virtual void	setIoLinkType (DtIOLinkType ioLinkType)
virtual DtIOEffect	ioEffect () const
	Setters and Getters for IO Effect. More...
virtual void	setIoEffect (DtIOEffect ioEffect)
virtual unsigned int	ioEffectDutyCycle () const
	Setters and Getters for IO Effect Duty Cycle. More...
virtual void	setIoEffectDutyCycle (unsigned int ioEffectDutyCycle)
virtual unsigned int	ioEffectDuration () const
	Setters and Getters for IO Effect Duration. More...
virtual void	setIoEffectDuration (unsigned int ioEffectDuration)
virtual DtIOProcess	ioProcess () const
	Setters and Getters for IO Effect Duration. More...
virtual void	setIoProcess (DtIOProcess ioProcess)
virtual void	printDataToStream (std::ostream &stream) const
	Prints the data to the specified stream. More...
virtual void	writeRecord (void *addr) const
	Writes the network representation to the given address. More...
virtual void	setFromNet (const void *netRecord, unsigned int length, DtStandardVariableRetCode *retCode=NULL)
	Sets the record from an address and length. Retcode will be Valid if all goes well. More...
virtual unsigned int	unpaddedNetsize () const
	Returns the size of the network representation (without padding bytes) More...
virtual unsigned int	netSize () const
	This overrides netSize because this Record is a special case as it is of a fixed size and Will never require padding. More...
virtual DtStandardVariableRecord *	clone () const
	Clone. 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)
	Create function used by Standard Variable Record Factory. More...

Protected Attributes
DtNetIoEffectRecord	myIoEffectRecord
Protected Attributes inherited from DtStandardVariableRecord
DtSimulationAddress	myOriginatingSimulationAddress

Constructor & Destructor Documentation

DtIoEffectRecord::DtIoEffectRecord

(

)

Constructor.

DtIoEffectRecord::DtIoEffectRecord	(	DtIOStatus	status,
		DtIOLinkType	linkType,
		DtIOEffect	effect,
		unsigned int	effectDutyCycle,
		unsigned int	effectDuration,
		DtIOProcess	process
	)

Constructor.

DtIoEffectRecord::DtIoEffectRecord

(

const DtIoEffectRecord &

orig

)

Copy Constructor.

DtIoEffectRecord::DtIoEffectRecord

(

const DtNetIoEffectRecord &

orig

)

Copy Constructor.

DtIoEffectRecord::DtIoEffectRecord	(	void *	ptr,
		unsigned int	length
	)

Net Constructor.

Member Function Documentation

virtual DtStandardVariableRecord* DtIoEffectRecord::clone ( ) const

virtual

Clone.

Implements DtStandardVariableRecord.

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

static

Create function used by Standard Variable Record Factory.

virtual DtIOEffect DtIoEffectRecord::ioEffect ( ) const

virtual

Setters and Getters for IO Effect.

virtual unsigned int DtIoEffectRecord::ioEffectDuration ( ) const

virtual

Setters and Getters for IO Effect Duration.

virtual unsigned int DtIoEffectRecord::ioEffectDutyCycle ( ) const

virtual

Setters and Getters for IO Effect Duty Cycle.

virtual DtIOLinkType DtIoEffectRecord::ioLinkType ( ) const

virtual

Setters and Getters for IO Link Type.

virtual DtIOProcess DtIoEffectRecord::ioProcess ( ) const

virtual

Setters and Getters for IO Effect Duration.

virtual DtIOStatus DtIoEffectRecord::ioStatus ( ) const

virtual

Setters and Getters for IO Status.

virtual unsigned int DtIoEffectRecord::netSize ( ) const

virtual

This overrides netSize because this Record is a special case as it is of a fixed size and Will never require padding.

virtual DtIoEffectRecord& DtIoEffectRecord::operator= ( const DtIoEffectRecord &  other )

virtual

Assignment operator.

virtual DtStandardVariableRecord& DtIoEffectRecord::operator= ( const DtStandardVariableRecord &  record )

virtual

Assignment operator.

virtual bool DtIoEffectRecord::operator== ( const DtIoEffectRecord &  other )

virtual

Equals operator.

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

virtual

Equals operator.

Implements DtStandardVariableRecord.

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

virtual

Prints the data to the specified stream.

Implements DtStandardVariableRecord.

virtual unsigned int DtIoEffectRecord::recordLength ( ) const

virtual

Setters and Getters for Record Length.

Implements DtStandardVariableRecord.

virtual unsigned int DtIoEffectRecord::recordType ( ) const

virtual

Setters and Getters for Record Type.

Implements DtStandardVariableRecord.

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

virtual

Sets the record from an address and length. Retcode will be Valid if all goes well.

Implements DtStandardVariableRecord.

virtual void DtIoEffectRecord::setIoEffect ( DtIOEffect  ioEffect )

virtual

virtual void DtIoEffectRecord::setIoEffectDuration ( unsigned int  ioEffectDuration )

virtual

virtual void DtIoEffectRecord::setIoEffectDutyCycle ( unsigned int  ioEffectDutyCycle )

virtual

virtual void DtIoEffectRecord::setIoLinkType ( DtIOLinkType  ioLinkType )

virtual

virtual void DtIoEffectRecord::setIoProcess ( DtIOProcess  ioProcess )

virtual

virtual void DtIoEffectRecord::setIoStatus ( DtIOStatus  ioStatus )

virtual

virtual void DtIoEffectRecord::setRecordLength ( unsigned int  recordLength )

virtual

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

Implements DtStandardVariableRecord.

virtual void DtIoEffectRecord::setRecordType ( unsigned int  recordType )

virtual

Get/Set Record Type.

Implements DtStandardVariableRecord.

virtual unsigned int DtIoEffectRecord::unpaddedNetsize ( ) const

virtual

Returns the size of the network representation (without padding bytes)

Implements DtStandardVariableRecord.

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

virtual

Writes the network representation to the given address.

The assumption is that this memory is allocated and is of the proper size.

Implements DtStandardVariableRecord.

Member Data Documentation

DtNetIoEffectRecord DtIoEffectRecord::myIoEffectRecord

protected

---

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

• ioEffectRecord.h