VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtDiGuyScaleRecord Class Reference
+ Inheritance diagram for DtDiGuyScaleRecord:
+ Collaboration diagram for DtDiGuyScaleRecord:

Public Member Functions

 DtDiGuyScaleRecord ()
 Constructor. More...
 
 DtDiGuyScaleRecord (const DtDiGuyScaleRecord &orig)
 Copy Constructor. More...
 
 DtDiGuyScaleRecord (void *netBuffer, unsigned int size)
 Net Constructor. More...
 
virtual DtDiGuyScaleRecordoperator= (const DtDiGuyScaleRecord &record)
 Assignment Operator. More...
 
virtual DtStandardVariableRecordoperator= (const DtStandardVariableRecord &other)
 Assignment operator. More...
 
virtual bool operator== (const DtDiGuyScaleRecord &record)
 Equals Operator. More...
 
virtual bool operator== (const DtStandardVariableRecord &other)
 Equals operator. More...
 
virtual const DtVectorcharacterScale () const
 Set/Get character scale. More...
 
virtual void setCharacterScale (const DtVector &value)
 
virtual void printDataToStream (std::ostream &stream) const
 Prints the data to the specified stream. More...
 
virtual DtStandardVariableRecordclone () const
 Clone. 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 unsigned int unpaddedNetsize () const
 This is the network size of the record without padding. More...
 
- Public Member Functions inherited from DtGenericVariableRecord
 DtGenericVariableRecord (unsigned int recordType, unsigned int dataLength=0, void *dataPtr=0)
 Construct a record of the given type with optional data length (not including header or padding) and data. More...
 
 DtGenericVariableRecord (const DtGenericVariableRecord &orig)
 Copy Constructor. More...
 
 DtGenericVariableRecord (void *ptr, unsigned int size)
 Net Constructor Memory must exist for life of the variable record. More...
 
virtual ~DtGenericVariableRecord ()
 Destructor. More...
 
virtual DtGenericVariableRecordoperator= (const DtGenericVariableRecord &record)
 Assignment Operator. More...
 
virtual bool operator== (const DtGenericVariableRecord &record)
 Equals Operator. More...
 
virtual unsigned int dataSize () const
 Get the variable data size (will include size of padding bytes if any) More...
 
virtual const char * netRep () const
 The net record including the header. 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 * variableData () const
 Get/Set the variable data part of record. More...
 
virtual char * variableData ()
 Get/Set the variable data part of record. More...
 
virtual void setVariableData (const std::vector< char > &data)
 Get/Set the variable data part of record. More...
 
virtual void setVariableData (const char *data, unsigned size)
 Get/Set the variable data part of record. 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 DtSimulationAddressoriginatingSimulationAddress () const
 

Static Public Member Functions

static DtStandardVariableRecordcreate (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...
 
- Static Public Member Functions inherited from DtGenericVariableRecord
static DtStandardVariableRecordcreate (void *addr, unsigned int length)
 Creator of an unknown record for registering in a factory. More...
 

Protected Member Functions

virtual void updateData ()
 
virtual void commitData ()
 
virtual DtDiGuyScaleRecorddoCopy (const DtDiGuyScaleRecord &record)
 
- Protected Member Functions inherited from DtGenericVariableRecord
virtual void resizeForDataOfSize (int size)
 Resize the buffer for the given data size. More...
 

Protected Attributes

DtVector myCharacterScale
 
bool myDataIsDirty
 
bool myBufferIsDirty
 
- Protected Attributes inherited from DtGenericVariableRecord
std::vector< char > myRecordBuffer
 
DtNetGenericVariableRecordmyRecordPtr
 
DtU8myVariableDataPtr
 
unsigned int myNetSize
 Greater than 0 only when record is wrapping around a network buffer. More...
 
- Protected Attributes inherited from DtStandardVariableRecord
DtSimulationAddress myOriginatingSimulationAddress
 

Static Protected Attributes

static DtDatumParam theDiGuyCharacterScaleId
 

Constructor & Destructor Documentation

DtDiGuyScaleRecord::DtDiGuyScaleRecord ( )

Constructor.

DtDiGuyScaleRecord::DtDiGuyScaleRecord ( const DtDiGuyScaleRecord orig)

Copy Constructor.

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

Net Constructor.

Member Function Documentation

virtual const DtVector& DtDiGuyScaleRecord::characterScale ( ) const
virtual

Set/Get character scale.

virtual DtStandardVariableRecord* DtDiGuyScaleRecord::clone ( ) const
virtual

Clone.

Reimplemented from DtGenericVariableRecord.

virtual void DtDiGuyScaleRecord::commitData ( )
protectedvirtual
static DtStandardVariableRecord* DtDiGuyScaleRecord::create ( void *  addr,
unsigned int  length 
)
static

Creator of an unknown record for registering in a factory.

virtual DtDiGuyScaleRecord& DtDiGuyScaleRecord::doCopy ( const DtDiGuyScaleRecord record)
protectedvirtual
virtual DtDiGuyScaleRecord& DtDiGuyScaleRecord::operator= ( const DtDiGuyScaleRecord record)
virtual

Assignment Operator.

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

Assignment operator.

Reimplemented from DtGenericVariableRecord.

virtual bool DtDiGuyScaleRecord::operator== ( const DtDiGuyScaleRecord record)
virtual

Equals Operator.

virtual bool DtDiGuyScaleRecord::operator== ( const DtStandardVariableRecord other)
virtual

Equals operator.

Reimplemented from DtGenericVariableRecord.

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

Prints the data to the specified stream.

Reimplemented from DtGenericVariableRecord.

static unsigned int DtDiGuyScaleRecord::recordTypeToUse ( )
static

Return the DI-Guy Action record type.

virtual void DtDiGuyScaleRecord::setCharacterScale ( const DtVector value)
virtual
virtual void DtDiGuyScaleRecord::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

Reimplemented from DtGenericVariableRecord.

static void DtDiGuyScaleRecord::setRecordTypeToUse ( unsigned int  typeToUse)
static

Set the record type to use.

virtual unsigned int DtDiGuyScaleRecord::unpaddedNetsize ( ) const
virtual

This is the network size of the record without padding.

Reimplemented from DtGenericVariableRecord.

virtual void DtDiGuyScaleRecord::updateData ( )
protectedvirtual
virtual void DtDiGuyScaleRecord::writeRecord ( void *  addr) const
virtual

Reimplemented from DtGenericVariableRecord.

Member Data Documentation

bool DtDiGuyScaleRecord::myBufferIsDirty
protected
DtVector DtDiGuyScaleRecord::myCharacterScale
protected
bool DtDiGuyScaleRecord::myDataIsDirty
protected
DtDatumParam DtDiGuyScaleRecord::theDiGuyCharacterScaleId
staticprotected

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

Document ID: Generated on Wed Mar 27 02:04:30 EDT 2024 from SVN revision 264570
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)