 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
Derived from DtSimEntityNetInterface, DtSimAggregateRemoteEntityNetInterface provides an interface between the local representation of a remote aggregate entity and it's network (VR-Link) representation (DtReflectedExtAggregate and DtAggregateStateRepository). More...
Public Member Functions | |
| DtSimAggregateRemoteEntityNetInterface (const DtString &name, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true) | |
| read/writable constructor | |
| DtSimAggregateRemoteEntityNetInterface (const DtSimAggregateRemoteEntityNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| const DtSimAggregateRemoteEntityNetInterface & | operator= (const DtSimAggregateRemoteEntityNetInterface &orig) |
| assignment operator | |
| virtual | ~DtSimAggregateRemoteEntityNetInterface () |
| destructor | |
| virtual void | updateFromReflectedObject () |
| this will copy from the reflected aggregate and associated network state repository to the local state repository | |
| virtual DtReflectedExtAggregate * | reflectedAggregate () const |
| returns the pointer to the VR-Link reflected entity being used to represent this remote entity | |
| virtual DtExtAggregateStateRepository * | aggregateNetworkState () const |
| returns a pointer to the DtEntityStateRepository created by the DtReflectedEntity | |
| virtual bool | updateStateFromVariableDatum () |
| Updates local state from variable datum read in from network as part as aggregate state repository. | |
| virtual bool | getUserVariableDatum (int userRecordNumber, DtVariableDatumRecord &rec) |
| Returns a user specified variable datum record. | |
| virtual bool | netSubordinateEntitiesChanged () const |
| virtual void | updateSubordinateEntitiesFromNet () |
| virtual bool | netSubordinateAggregatesChanged () const |
| virtual void | updateSubordinateAggregatesFromNet () |
| virtual const DtGlobalObjectDesignatorList & | netSubordinateEntities () const |
| virtual const DtGlobalObjectDesignatorList & | netSubordinateAggregates () const |
| virtual bool | isANetSubordinate (const DtGlobalObjectDesignator &globalId) |
| Returns true if the given global Id is one of our individual or aggregate subordinates, according to our network data (as specified in our aggregate state repository). | |
| virtual bool | isAggregate () const |
| virtual DtString | type () const |
| Returns the type of net interface object. | |
| virtual DtVrfAggregateStateRepository * | aggregateLocalState () const |
Static Public Member Functions | |
| static const DtSimAggregateRemoteEntityNetInterface * | isAggregateRemoteEntityNetInterface (const DtSimObjectNetInterface *objNetInterface) |
| This function will return the objNetInterface passed in, cast to a DtSimAggregateRemoteEntityNetInterface*, provided the objNetInterface is indeed an aggregate remote entity network interface. | |
| static DtSimAggregateRemoteEntityNetInterface * | isAggregateRemoteEntityNetInterface (DtSimObjectNetInterface *objNetInterface) |
| static DtSimObjectNetInterface * | creator (const DtString &name, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry, bool publishObject) |
Protected Member Functions | |
| DtSimAggregateRemoteEntityNetInterface () | |
| default constructor | |
Protected Attributes | |
| DtGlobalObjectDesignatorList | myPreviousSubEntityList |
| DtGlobalObjectDesignatorList | myPreviousSubAggregateList |
| DtGlobalObjectDesignatorList | myNetSubordinateEntities |
| DtGlobalObjectDesignatorList | myNetSubordinateAggregates |
| DtVariableDatumRecord | myPreviousSubordinateOrderRecord |
Derived from DtSimEntityNetInterface, DtSimAggregateRemoteEntityNetInterface provides an interface between the local representation of a remote aggregate entity and it's network (VR-Link) representation (DtReflectedExtAggregate and DtAggregateStateRepository).
default constructor
| DtSimAggregateRemoteEntityNetInterface::DtSimAggregateRemoteEntityNetInterface | ( | const DtString & | name, |
| DtVrfObject * | simObject, | ||
| DtReaderWriterRegistry * | parentRegistry = 0, |
||
| bool | publishObject = true |
||
| ) |
read/writable constructor
| DtSimAggregateRemoteEntityNetInterface::DtSimAggregateRemoteEntityNetInterface | ( | const DtSimAggregateRemoteEntityNetInterface & | orig, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
| virtual DtSimAggregateRemoteEntityNetInterface::~DtSimAggregateRemoteEntityNetInterface | ( | ) | [virtual] |
destructor
| const DtSimAggregateRemoteEntityNetInterface& DtSimAggregateRemoteEntityNetInterface::operator= | ( | const DtSimAggregateRemoteEntityNetInterface & | orig | ) |
assignment operator
| virtual void DtSimAggregateRemoteEntityNetInterface::updateFromReflectedObject | ( | ) | [virtual] |
this will copy from the reflected aggregate and associated network state repository to the local state repository
Implements DtSimRemoteEntityNetInterface.
| virtual DtReflectedExtAggregate* DtSimAggregateRemoteEntityNetInterface::reflectedAggregate | ( | ) | const [virtual] |
returns the pointer to the VR-Link reflected entity being used to represent this remote entity
| virtual DtExtAggregateStateRepository* DtSimAggregateRemoteEntityNetInterface::aggregateNetworkState | ( | ) | const [virtual] |
returns a pointer to the DtEntityStateRepository created by the DtReflectedEntity
| virtual bool DtSimAggregateRemoteEntityNetInterface::updateStateFromVariableDatum | ( | ) | [virtual] |
Updates local state from variable datum read in from network as part as aggregate state repository.
| virtual bool DtSimAggregateRemoteEntityNetInterface::getUserVariableDatum | ( | int | userRecordNumber, |
| DtVariableDatumRecord & | rec | ||
| ) | [virtual] |
Returns a user specified variable datum record.
| virtual bool DtSimAggregateRemoteEntityNetInterface::netSubordinateEntitiesChanged | ( | ) | const [virtual] |
| virtual void DtSimAggregateRemoteEntityNetInterface::updateSubordinateEntitiesFromNet | ( | ) | [virtual] |
| virtual bool DtSimAggregateRemoteEntityNetInterface::netSubordinateAggregatesChanged | ( | ) | const [virtual] |
| virtual void DtSimAggregateRemoteEntityNetInterface::updateSubordinateAggregatesFromNet | ( | ) | [virtual] |
| virtual const DtGlobalObjectDesignatorList& DtSimAggregateRemoteEntityNetInterface::netSubordinateEntities | ( | ) | const [virtual] |
| virtual const DtGlobalObjectDesignatorList& DtSimAggregateRemoteEntityNetInterface::netSubordinateAggregates | ( | ) | const [virtual] |
| virtual bool DtSimAggregateRemoteEntityNetInterface::isANetSubordinate | ( | const DtGlobalObjectDesignator & | globalId | ) | [virtual] |
Returns true if the given global Id is one of our individual or aggregate subordinates, according to our network data (as specified in our aggregate state repository).
Returns true if the global Id appears in either of the netSubordinateEntities() or netSubordinateAggregates() lists, false if not.
| virtual bool DtSimAggregateRemoteEntityNetInterface::isAggregate | ( | ) | const [inline, virtual] |
Implements DtSimRemoteEntityNetInterface.
| virtual DtString DtSimAggregateRemoteEntityNetInterface::type | ( | ) | const [virtual] |
Returns the type of net interface object.
Strings are defined in netIfTypes.h.
Implements DtSimObjectNetInterface.
Reimplemented in DtVrfAggregateRemoteEntityNetInterface.
| virtual DtVrfAggregateStateRepository* DtSimAggregateRemoteEntityNetInterface::aggregateLocalState | ( | ) | const [virtual] |
| static const DtSimAggregateRemoteEntityNetInterface* DtSimAggregateRemoteEntityNetInterface::isAggregateRemoteEntityNetInterface | ( | const DtSimObjectNetInterface * | objNetInterface | ) | [static] |
This function will return the objNetInterface passed in, cast to a DtSimAggregateRemoteEntityNetInterface*, provided the objNetInterface is indeed an aggregate remote entity network interface.
| static DtSimAggregateRemoteEntityNetInterface* DtSimAggregateRemoteEntityNetInterface::isAggregateRemoteEntityNetInterface | ( | DtSimObjectNetInterface * | objNetInterface | ) | [static] |
| static DtSimObjectNetInterface* DtSimAggregateRemoteEntityNetInterface::creator | ( | const DtString & | name, |
| DtVrfObject * | simObject, | ||
| DtReaderWriterRegistry * | parentRegistry, | ||
| bool | publishObject | ||
| ) | [static] |
Reimplemented in DtVrfAggregateRemoteEntityNetInterface.
DtGlobalObjectDesignatorList DtSimAggregateRemoteEntityNetInterface::myPreviousSubEntityList [protected] |
DtGlobalObjectDesignatorList DtSimAggregateRemoteEntityNetInterface::myPreviousSubAggregateList [protected] |
DtGlobalObjectDesignatorList DtSimAggregateRemoteEntityNetInterface::myNetSubordinateEntities [protected] |
DtGlobalObjectDesignatorList DtSimAggregateRemoteEntityNetInterface::myNetSubordinateAggregates [protected] |
DtVariableDatumRecord DtSimAggregateRemoteEntityNetInterface::myPreviousSubordinateOrderRecord [protected] |