DtEnvironmentalRecord Class Reference

DtEnvironmentalRecord is the base class from which all geometry and state environmental records are derived. More...

Inheritance diagram for DtEnvironmentalRecord:

Collaboration diagram for DtEnvironmentalRecord:

Public Member Functions
	DtEnvironmentalRecord ()
	Constructor. More...
	DtEnvironmentalRecord (const DtEnvironmentalRecord &orig)
	Copy constructor. More...
const DtEnvironmentalRecord &	operator= (const DtEnvironmentalRecord &orig)
	Assignment operator. More...
virtual	~DtEnvironmentalRecord ()
	Destructor. More...
virtual DtEnvironmentalRecord *	clone () const
	Creates a new complete copy of this record, including a copy of the network representation. More...
virtual bool	createNetworkRepresentation ()
	This doesn't need to be called explicitly. More...
virtual void	setType (DtU32 type)
virtual DtU32	type () const
virtual void	setLength (DtU16 length)
virtual DtU16	length () const
virtual void	setIndex (DtU8 index)
virtual DtU8	index () const
const DtNetEnvironmentalRecord *	netRep () const
	returns the network representation of the environmental record More...
DtNetEnvironmentalRecord *	netRep ()
virtual int	netRepSize () const
	Returns the size of the network representation. More...
virtual void	setFromNet (const DtNetEnvironmentalRecord &buffer, int protocolVersion)
	used by the PDU class to fill in the network representation More...

Protected Member Functions
virtual bool	checkAndCreate ()
	Checks to see if we need a representation, and creates it if we do Returns false, if the create fails, true otherwise. More...
virtual bool	resizeNetRep (int newSize)
	Resizes the network representation. More...
DtEnvironmentalRecord *	self () const
	Casts the 'this' pointer for changing elements in a const function. More...

Protected Attributes
DtNetEnvironmentalRecord *	myNetRep

Detailed Description

DtEnvironmentalRecord is the base class from which all geometry and state environmental records are derived.

See IEEE 1278.1a-1998, page 133.

Constructor & Destructor Documentation

DtEnvironmentalRecord::DtEnvironmentalRecord

(

)

Constructor.

DtEnvironmentalRecord::DtEnvironmentalRecord

(

const DtEnvironmentalRecord &

orig

)

Copy constructor.

virtual DtEnvironmentalRecord::~DtEnvironmentalRecord ( )

virtual

Destructor.

Member Function Documentation

virtual bool DtEnvironmentalRecord::checkAndCreate ( )

protectedvirtual

Checks to see if we need a representation, and creates it if we do Returns false, if the create fails, true otherwise.

virtual DtEnvironmentalRecord* DtEnvironmentalRecord::clone ( ) const

virtual

Creates a new complete copy of this record, including a copy of the network representation.

Reimplemented in DtEnvironmentalBoundingSphereRecord, DtEnvironmentalCombicStateRecord, DtEnvironmentalConeRecord, DtEnvironmentalDRPointRecord, DtEnvironmentalFlareStateRecord, DtEnvironmentalGeometryRecord, DtEnvironmentalDREllipsoidRecord, DtEnvironmentalDRRectangularVolumeRecord, DtEnvironmentalEllipsoidRecord, DtEnvironmentalGaussianPlumeRecord, DtEnvironmentalGaussianPuffRecord, DtEnvironmentalPointRecord, DtEnvironmentalUniformRecord, DtEnvironmentalDRConeRecord, DtEnvironmentalDRSphereRecord, DtEnvironmentalLineRecord, DtEnvironmentalDRLineRecord, DtEnvironmentalRectangularVolumeRecord, and DtEnvironmentalSphereRecord.

virtual bool DtEnvironmentalRecord::createNetworkRepresentation ( )

virtual

This doesn't need to be called explicitly.

If any routine that needs the repository finds that it hasn't been created yet, it calls this method.

Reimplemented in DtEnvironmentalCombicStateRecord, DtEnvironmentalDRConeRecord, DtEnvironmentalGaussianPuffRecord, DtEnvironmentalDREllipsoidRecord, DtEnvironmentalDRRectangularVolumeRecord, DtEnvironmentalGaussianPlumeRecord, DtEnvironmentalDRSphereRecord, DtEnvironmentalFlareStateRecord, DtEnvironmentalConeRecord, DtEnvironmentalDRLineRecord, DtEnvironmentalEllipsoidRecord, DtEnvironmentalDRPointRecord, DtEnvironmentalLineRecord, DtEnvironmentalPointRecord, DtEnvironmentalRectangularVolumeRecord, DtEnvironmentalBoundingSphereRecord, DtEnvironmentalSphereRecord, and DtEnvironmentalUniformRecord.

virtual DtU8 DtEnvironmentalRecord::index ( ) const

virtual

virtual DtU16 DtEnvironmentalRecord::length ( ) const

virtual

const DtNetEnvironmentalRecord* DtEnvironmentalRecord::netRep

(

)

const

returns the network representation of the environmental record

DtNetEnvironmentalRecord* DtEnvironmentalRecord::netRep

(

)

virtual int DtEnvironmentalRecord::netRepSize ( ) const

virtual

Returns the size of the network representation.

Reimplemented in DtEnvironmentalCombicStateRecord, DtEnvironmentalDRConeRecord, DtEnvironmentalGaussianPuffRecord, DtEnvironmentalDREllipsoidRecord, DtEnvironmentalDRRectangularVolumeRecord, DtEnvironmentalGaussianPlumeRecord, DtEnvironmentalDRSphereRecord, DtEnvironmentalFlareStateRecord, DtEnvironmentalConeRecord, DtEnvironmentalDRLineRecord, DtEnvironmentalEllipsoidRecord, DtEnvironmentalDRPointRecord, DtEnvironmentalLineRecord, DtEnvironmentalPointRecord, DtEnvironmentalRectangularVolumeRecord, DtEnvironmentalSphereRecord, and DtEnvironmentalUniformRecord.

const DtEnvironmentalRecord& DtEnvironmentalRecord::operator=

(

const DtEnvironmentalRecord &

orig

)

Assignment operator.

Will copy full network representation, no need to copy in subclasses.

virtual bool DtEnvironmentalRecord::resizeNetRep ( int  newSize )

protectedvirtual

Resizes the network representation.

Only valid for DtEnvironmentalRecord that include variable size data. If not supported, should simply return false and do nothing. Used in copying the network representation in the assignment operator.

DtEnvironmentalRecord* DtEnvironmentalRecord::self ( ) const

protected

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

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

virtual

used by the PDU class to fill in the network representation

Reimplemented in DtEnvironmentalCombicStateRecord, DtEnvironmentalDRConeRecord, DtEnvironmentalGaussianPuffRecord, DtEnvironmentalDREllipsoidRecord, DtEnvironmentalDRRectangularVolumeRecord, DtEnvironmentalGaussianPlumeRecord, DtEnvironmentalDRSphereRecord, DtEnvironmentalFlareStateRecord, DtEnvironmentalConeRecord, DtEnvironmentalDRLineRecord, DtEnvironmentalEllipsoidRecord, DtEnvironmentalDRPointRecord, DtEnvironmentalLineRecord, DtEnvironmentalPointRecord, DtEnvironmentalRectangularVolumeRecord, DtEnvironmentalSphereRecord, and DtEnvironmentalUniformRecord.

virtual void DtEnvironmentalRecord::setIndex ( DtU8  index )

virtual

virtual void DtEnvironmentalRecord::setLength ( DtU16  length )

virtual

virtual void DtEnvironmentalRecord::setType ( DtU32  type )

virtual

virtual DtU32 DtEnvironmentalRecord::type ( ) const

virtual

Member Data Documentation

DtNetEnvironmentalRecord* DtEnvironmentalRecord::myNetRep

protected

---

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

• environmentalRecord.h