VR-Forces 4.7 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Static Protected Attributes
DtEntityExtendedAttributesInitializer Class Reference

The extended attributes initializer for entity objects. More...

Inheritance diagram for DtEntityExtendedAttributesInitializer:
Inheritance graph
[legend]

Public Member Functions

 DtEntityExtendedAttributesInitializer ()
 Constructor.
virtual ~DtEntityExtendedAttributesInitializer ()
 Destructor.
- Public Member Functions inherited from DtExtendedAttributesInitializer
 DtExtendedAttributesInitializer ()
 Constructor.
virtual ~DtExtendedAttributesInitializer ()
 Destructor.
virtual void initialize (DtExerciseConn *exConn)
 Performs initialization.
virtual void setObjectClassChooser (DtObjectClassChooserPtr chooser)
 Specifies an object class chooser to choose what object class to publish.
virtual void addSupportedClass (const DtString &fullClassName, bool addSubclasses=false)
 Adds a new FOM class to be supported.

Protected Member Functions

virtual bool needsInitialization (DtExerciseConn *exConn)
 Returns true if initialization needs to be performed.
virtual const DtStringpublisherName () const
 The name of the publisher class in VR-Link.
virtual const DtStringreflectedListName () const
 The name of the reflected list class in VR-Link.
virtual const DtStringdefaultBaseObjectClass () const
 The base object class that is supported by default. All subclasses will also be supported.
virtual void setUnknownAttributeFunctions (DtObjClassDesc *desc)
 Sets the unknown attribute checker, encoder, and decoder functions in order to process them as extended attributes.
virtual std::map< DtString,
RTI::AttributeHandle > 
attributeNameToHandleMap (const RTI::ObjectClassHandle &classHdl) const
 Gets the current attribute name to handle mapping for the object class.
virtual void setAttributeNameToHandleMap (const RTI::ObjectClassHandle &classHdl, const std::map< DtString, RTI::AttributeHandle > &mapping)
 SEts the attribute name to handle mapping for the object class.
virtual void setPublisherStateRepCreator ()
 Sets the state rep creator for the associated publisher.
virtual void setReflectedObjectStateRepCreator ()
 Sets the state rep creator for the associated reflected object.
- Protected Member Functions inherited from DtExtendedAttributesInitializer
virtual bool areClassNamesEquivalent (const DtString &, const DtString &) const
 These functions are called within initialize() to perform specific aspects of the process.
virtual void addSupportedSubclasses (DtExerciseConn *exConn)
 Finds all subclasses for supported base classes and adds them to the list of supported object classes.
virtual void initializeObjectClassChooser (DtExerciseConn *exConn)
 Initializes the object class chooser for the publisher.
virtual void initializeObjectClasses (DtExerciseConn *exConn)
 Initializes the object classes by specifying unknown attribute functions and setting up attribute mappings.
virtual void initializeAttributes (DtObjClassDesc *desc)
 Called by initializeObjectClasses() to set up the mapping of attribute handles to attribute names that is required to translate FOM class attributes into extended attributes.
virtual void initializeExtendedAttributes (DtExerciseConn *exConn)
 Initializes the attributes for extended attributes that are sent via an associated ExtendedAttributes object.

Static Protected Attributes

static DtTime thePrevExConnInitTime
static bool theExConnNeedsInit
- Static Protected Attributes inherited from DtExtendedAttributesInitializer
static DtString theExtendedAttributesClassName

Additional Inherited Members

- Protected Attributes inherited from DtExtendedAttributesInitializer
bool myNeedsInitialization
DtObjectClassChooserPtr myObjectClassChooser
std::list< DtStringmyFullBaseClassNames
std::list< DtStringmyFullClassNames

Detailed Description

The extended attributes initializer for entity objects.

Constructor & Destructor Documentation

DtEntityExtendedAttributesInitializer::DtEntityExtendedAttributesInitializer ( )

Constructor.

virtual DtEntityExtendedAttributesInitializer::~DtEntityExtendedAttributesInitializer ( )
virtual

Destructor.

Member Function Documentation

virtual bool DtEntityExtendedAttributesInitializer::needsInitialization ( DtExerciseConn *  exConn)
protectedvirtual

Returns true if initialization needs to be performed.

Reimplemented from DtExtendedAttributesInitializer.

virtual const DtString& DtEntityExtendedAttributesInitializer::publisherName ( ) const
protectedvirtual

The name of the publisher class in VR-Link.

Implements DtExtendedAttributesInitializer.

virtual const DtString& DtEntityExtendedAttributesInitializer::reflectedListName ( ) const
protectedvirtual

The name of the reflected list class in VR-Link.

Implements DtExtendedAttributesInitializer.

virtual const DtString& DtEntityExtendedAttributesInitializer::defaultBaseObjectClass ( ) const
protectedvirtual

The base object class that is supported by default. All subclasses will also be supported.

Implements DtExtendedAttributesInitializer.

virtual void DtEntityExtendedAttributesInitializer::setUnknownAttributeFunctions ( DtObjClassDesc *  desc)
protectedvirtual

Sets the unknown attribute checker, encoder, and decoder functions in order to process them as extended attributes.

Specific to a particular state repository class.

Implements DtExtendedAttributesInitializer.

virtual std::map<DtString, RTI::AttributeHandle> DtEntityExtendedAttributesInitializer::attributeNameToHandleMap ( const RTI::ObjectClassHandle &  classHdl) const
protectedvirtual

Gets the current attribute name to handle mapping for the object class.

Specific to a particular state repository class.

Implements DtExtendedAttributesInitializer.

virtual void DtEntityExtendedAttributesInitializer::setAttributeNameToHandleMap ( const RTI::ObjectClassHandle &  classHdl,
const std::map< DtString, RTI::AttributeHandle > &  mapping 
)
protectedvirtual

SEts the attribute name to handle mapping for the object class.

Specific to a particular state repository class.

Implements DtExtendedAttributesInitializer.

virtual void DtEntityExtendedAttributesInitializer::setPublisherStateRepCreator ( )
protectedvirtual

Sets the state rep creator for the associated publisher.

Specific to a particular publisher class and state repository class.

Implements DtExtendedAttributesInitializer.

virtual void DtEntityExtendedAttributesInitializer::setReflectedObjectStateRepCreator ( )
protectedvirtual

Sets the state rep creator for the associated reflected object.

Specific to a particular reflected object class and state repository class.

Implements DtExtendedAttributesInitializer.

Member Data Documentation

DtTime DtEntityExtendedAttributesInitializer::thePrevExConnInitTime
staticprotected
bool DtEntityExtendedAttributesInitializer::theExConnNeedsInit
staticprotected

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

Document ID: Generated on Fri Apr 26 21:53:14 EDT 2019 from SVN revision 197883
Copyright © 2005-2019 VT MAK. All Rights Reserved (www.mak.com)