DtEnvironmentBulkRecord Class Reference

DtEnvironmentBulkRecord is an environmental record that acts as the separator between individual environmental in a bulk object and contains the info that would normally be the Environment Process PDU. More...

Inheritance diagram for DtEnvironmentBulkRecord:

Public Member Functions
	DtEnvironmentBulkRecord ()
	Constructor.
	DtEnvironmentBulkRecord (const DtEnvironmentBulkRecord &orig)
	Copy constructor.
const DtEnvironmentBulkRecord &	operator= (const DtEnvironmentBulkRecord &orig)
	Assignment Operator.
virtual	~DtEnvironmentBulkRecord ()
	Destructor.
virtual DtEnvironmentalRecord *	clone () const
	Clone.
virtual void	setEnvironmentalProcessID (const DtEntityIdentifier &entity)
	Set/Get originating environmental process ID.
virtual DtEntityIdentifier	environmentalProcessID () const
virtual void	setEnvironmentType (const DtEnvironmentTypeRecord &type)
	Set/Get environment type.
virtual DtEnvironmentTypeRecord	environmentType () const
virtual void	setModelType (DtEnvironmentalModelType value)
	Set/Get the model type.
virtual DtEnvironmentalModelType	modelType () const
virtual void	setEnvironmentalStatus (DtU8 value)
	Set/Get the environmental status (as an 8-bit value).
virtual DtU8	environmentalStatus () const
virtual void	setNumberOfEnvironmentalRecords (DtU16 newNumberOfRecords)
	Set/Get number of environment records.
virtual DtU16	numberOfEnvironmentalRecords () const
virtual void	setAssociatedObject (const DtGlobalObjectDesignator &obj)
	Set/Get associated object.
virtual DtGlobalObjectDesignator	associatedObject () const
virtual bool	createNetworkRepresentation ()
	Create the record's network representation.
const DtNetEnvironmentBulkRecord *	bulkNetRep () const
	returns the network representation of the environmental record
DtNetEnvironmentBulkRecord *	bulkNetRep ()
virtual void	setFromNet (const DtNetEnvironmentalRecord &buffer, int protocolVersion)
	used by the PDU class to fill in the network representation
virtual int	netRepSize () const
	returns the size of the net representation, in bytes.

Protected Member Functions
DtEnvironmentBulkRecord *	self () const
	Casts the 'this' pointer for changing elements in a const function.

Detailed Description

DtEnvironmentBulkRecord is an environmental record that acts as the separator between individual environmental in a bulk object and contains the info that would normally be the Environment Process PDU.

Constructor & Destructor Documentation

DtEnvironmentBulkRecord::DtEnvironmentBulkRecord

(

)

Constructor.

DtEnvironmentBulkRecord::DtEnvironmentBulkRecord

(

const DtEnvironmentBulkRecord &

orig

)

Copy constructor.

virtual DtEnvironmentBulkRecord::~DtEnvironmentBulkRecord ( )

virtual

Destructor.

Member Function Documentation

const DtEnvironmentBulkRecord& DtEnvironmentBulkRecord::operator=

(

const DtEnvironmentBulkRecord &

orig

)

Assignment Operator.

virtual DtEnvironmentalRecord* DtEnvironmentBulkRecord::clone ( ) const

virtual

Clone.

virtual void DtEnvironmentBulkRecord::setEnvironmentalProcessID ( const DtEntityIdentifier &  entity )

virtual

Set/Get originating environmental process ID.

virtual DtEntityIdentifier DtEnvironmentBulkRecord::environmentalProcessID ( ) const

virtual

virtual void DtEnvironmentBulkRecord::setEnvironmentType ( const DtEnvironmentTypeRecord &  type )

virtual

Set/Get environment type.

virtual DtEnvironmentTypeRecord DtEnvironmentBulkRecord::environmentType ( ) const

virtual

virtual void DtEnvironmentBulkRecord::setModelType ( DtEnvironmentalModelType  value )

virtual

Set/Get the model type.

virtual DtEnvironmentalModelType DtEnvironmentBulkRecord::modelType ( ) const

virtual

virtual void DtEnvironmentBulkRecord::setEnvironmentalStatus ( DtU8  value )

virtual

Set/Get the environmental status (as an 8-bit value).

virtual DtU8 DtEnvironmentBulkRecord::environmentalStatus ( ) const

virtual

virtual void DtEnvironmentBulkRecord::setNumberOfEnvironmentalRecords ( DtU16  newNumberOfRecords )

virtual

Set/Get number of environment records.

virtual DtU16 DtEnvironmentBulkRecord::numberOfEnvironmentalRecords ( ) const

virtual

virtual void DtEnvironmentBulkRecord::setAssociatedObject ( const DtGlobalObjectDesignator &  obj )

virtual

Set/Get associated object.

virtual DtGlobalObjectDesignator DtEnvironmentBulkRecord::associatedObject ( ) const

virtual

virtual bool DtEnvironmentBulkRecord::createNetworkRepresentation ( )

virtual

Create the record's network representation.

const DtNetEnvironmentBulkRecord* DtEnvironmentBulkRecord::bulkNetRep

(

)

const

returns the network representation of the environmental record

DtNetEnvironmentBulkRecord* DtEnvironmentBulkRecord::bulkNetRep

(

)

virtual void DtEnvironmentBulkRecord::setFromNet ( const DtNetEnvironmentalRecord &  buffer, int  protocolVersion  )

virtual

used by the PDU class to fill in the network representation

virtual int DtEnvironmentBulkRecord::netRepSize ( ) const

virtual

returns the size of the net representation, in bytes.

DtEnvironmentBulkRecord* DtEnvironmentBulkRecord::self ( ) const

protected

Casts the 'this' pointer for changing elements in a const function.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfExtObjects/environmentalBulkRecord.h