VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtSimIndividualRemoteEntityNetInterface Class Reference

Derived from DtSimEntityNetInterface, DtSimRemoteEntityNetInterface provides an interface between the local representation of a remote individual entity and it's network (VR-Link) representation (DtReflectedEntity and DtExtEntityStateRepository). More...

Inheritance diagram for DtSimIndividualRemoteEntityNetInterface:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtSimIndividualRemoteEntityNetInterface (const DtString &name, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
 read/writable constructor
 DtSimIndividualRemoteEntityNetInterface (const DtSimIndividualRemoteEntityNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const
DtSimIndividualRemoteEntityNetInterface & 
operator= (const DtSimIndividualRemoteEntityNetInterface &orig)
 assignment operator
virtual ~DtSimIndividualRemoteEntityNetInterface ()
 destructor
virtual void updateFromReflectedObject ()
 this will copy from the reflected entity and associated network state repository to the local state repository
virtual DtReflectedEntity * reflectedEntity () const
 returns the pointer to the VR-Link reflected entity being used to represent this remote entity
virtual
DtExtEntityStateRepository * 
individualNetworkState () const
 returns a pointer to the DtExtEntityStateRepository created by the DtReflectedEntity
virtual bool isPhysicalDataInitialized () const
 Returns true if physical data for entity has been initialized.
virtual bool isAggregate () const
virtual
DtArticulatedPartStateRepository * 
createPart (DtArticulatedPart *artPart)
virtual DtString type () const
 Returns the type of net interface object.

Static Public Member Functions

static const
DtSimIndividualRemoteEntityNetInterface * 
isIndividualRemoteEntityNetInterface (const DtSimObjectNetInterface *objNetInterface)
 This function will return the objNetInterface passed in, cast to a DtSimIndividualRemoteEntityNetInterface*, provided the objNetInterface is indeed an individual remote entity network interface.
static
DtSimIndividualRemoteEntityNetInterface * 
isIndividualRemoteEntityNetInterface (DtSimObjectNetInterface *objNetInterface)
static DtSimObjectNetInterface * creator (const DtString &name, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry, bool publishObject)

Protected Member Functions

 DtSimIndividualRemoteEntityNetInterface ()
 default constructor; not implemented
virtual
DtArticulatedPartStateRepository * 
createArtPartStateRepository (DtVrfObject *vrfObject, const DtObjectType &objectType, const DtString &rwName=DtString::nullString())
 Returns new instance of a DtArticulatedPartStateRepository.

Protected Attributes

bool myIsPhysicalDataInitialized

Detailed Description

Derived from DtSimEntityNetInterface, DtSimRemoteEntityNetInterface provides an interface between the local representation of a remote individual entity and it's network (VR-Link) representation (DtReflectedEntity and DtExtEntityStateRepository).


Constructor & Destructor Documentation

DtSimIndividualRemoteEntityNetInterface::DtSimIndividualRemoteEntityNetInterface ( const DtString &  name,
DtVrfObject *  simObject,
DtReaderWriterRegistry *  parentRegistry = 0,
bool  publishObject = true 
)

read/writable constructor

copy constructor

destructor

default constructor; not implemented


Member Function Documentation

const DtSimIndividualRemoteEntityNetInterface& DtSimIndividualRemoteEntityNetInterface::operator= ( const DtSimIndividualRemoteEntityNetInterface &  orig)

assignment operator

this will copy from the reflected entity and associated network state repository to the local state repository

Implements DtSimRemoteEntityNetInterface.

Reimplemented in DtVrfIndividualRemoteEntityNetInterface, and MyIndividualRemoteEntityNetInterface.

virtual DtReflectedEntity* DtSimIndividualRemoteEntityNetInterface::reflectedEntity ( ) const [virtual]

returns the pointer to the VR-Link reflected entity being used to represent this remote entity

returns a pointer to the DtExtEntityStateRepository created by the DtReflectedEntity

Returns true if physical data for entity has been initialized.

virtual bool DtSimIndividualRemoteEntityNetInterface::isAggregate ( ) const [inline, virtual]

Returns the type of net interface object.

Strings are defined in netIfTypes.h.

Implements DtSimObjectNetInterface.

Reimplemented in DtVrfIndividualRemoteEntityNetInterface, and MyIndividualRemoteEntityNetInterface.

This function will return the objNetInterface passed in, cast to a DtSimIndividualRemoteEntityNetInterface*, provided the objNetInterface is indeed an individual remote entity network interface.

static DtSimObjectNetInterface* DtSimIndividualRemoteEntityNetInterface::creator ( const DtString &  name,
DtVrfObject *  simObject,
DtReaderWriterRegistry *  parentRegistry,
bool  publishObject 
) [static]
virtual DtArticulatedPartStateRepository* DtSimIndividualRemoteEntityNetInterface::createArtPartStateRepository ( DtVrfObject *  vrfObject,
const DtObjectType &  objectType,
const DtString &  rwName = DtString::nullString() 
) [protected, virtual]

Returns new instance of a DtArticulatedPartStateRepository.

Called by createPart() when constructing the tree articulated part state repositories for the entity.


Member Data Documentation


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)