 |
VR-Forces 4.1.1 Class Documentation
|
|
VR-Forces 4.1.1 Class Documentation
|
Class Description: DtSimPseudoAggregateLocalEntityNetInterface. More...
Public Member Functions | |
| DtSimPseudoAggregateLocalEntityNetInterface (const DtString &name, DtVrfObject *object, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true) | |
| read/writable contructor | |
| DtSimPseudoAggregateLocalEntityNetInterface (const DtSimPseudoAggregateLocalEntityNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| const DtSimPseudoAggregateLocalEntityNetInterface & | operator= (const DtSimPseudoAggregateLocalEntityNetInterface &orig) |
| assignment operator | |
| virtual | ~DtSimPseudoAggregateLocalEntityNetInterface () |
| destructor | |
| virtual void | updatePublisher () |
| Override of base class updatePublisher(). | |
| virtual DtSubordinateManager * | subordinates () const |
| Returns the pointer to the entity's state repository's subordinate list. | |
| virtual bool | isPseudoAggregate () const |
| Returns true if this interface supports a pseudo-aggregate entity, false otherwise (true aggregate). | |
| virtual DtString | type () const |
| Returns the type of net interface object. | |
 Public Member Functions inherited from DtSimAggregateLocalEntityNetInterface | |
| DtSimAggregateLocalEntityNetInterface (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true) | |
| read/writable contructor | |
| DtSimAggregateLocalEntityNetInterface (const DtSimAggregateLocalEntityNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| const DtSimAggregateLocalEntityNetInterface & | operator= (const DtSimAggregateLocalEntityNetInterface &orig) |
| assignment operator | |
| virtual | ~DtSimAggregateLocalEntityNetInterface () |
| destructor | |
| bool | init () |
| Override to initialize myNextTickTime. | |
| virtual void | updateNet () |
| Ticks the publisher, then calls base class version. | |
| virtual void | tick () |
| Override base class tick. | |
| virtual void | setMinTickPeriod (double minTickPeriod) |
| specifies a minimum tick period (which can also be thought of as | |
| virtual double | minTickPeriod () const |
| access the minimum tick period | |
| virtual void | setMinTickPeriodVariance (double minTickPeriodVariance) |
| set the variance in the minimum tick time | |
| virtual double | minTickPeriodVariance () const |
| access the variance in the minimum tick period | |
| virtual void | setNextTickTime (double nextTickTime) |
| The next tick time is normally calculated internally. | |
| virtual double | nextTickTime () const |
| access the next tick time | |
| virtual bool | createPublisher () |
| Override of base class createPublisher(). Creates a DtVrfAggregatePublisher. | |
| virtual void | destroyPublisher () |
| Deletes a DtVrfAggregatePublisher. | |
| virtual bool | setAggregatePublisher (DtVrfAggregatePublisher *publisher) |
| If the user needs to supply a publisher other than the one created by the network interface, this call can be used. | |
| virtual void | setupNetworkRepository () |
| Initialize the DtExtAggregateStateRepository created by the DtVrfAggregatePublisher with values from the already initialized local aggregate state repository (DtSimAggregateLocalStateRepository). | |
| virtual DtVrfAggregatePublisher * | aggregatePublisher () const |
| Returns a pointer to the DtVrfAggregatePublisher either created by createPublisher() or set by setAggregatePublisher(). | |
| virtual DtExtAggregateStateRepository * | aggregateNetworkState () const |
| Returns a pointer to the DtExtAggregateStateRepository created by the DtVrfAggregatePublisher. | |
| virtual DtVrfAggregateStateRepository * | aggregateLocalState () const |
| virtual bool | setUserVariableDatum (int userRecordNumber, const DtVariableDatumRecord &record) |
| Adds a user specified variable datum record. | |
| virtual bool | getUserVariableDatum (int userRecordNumber, DtVariableDatumRecord &rec) |
| Returns a user specified variable datum record. | |
| virtual bool | encodeVariableDatum () |
| Sets information that is going to be used in the variable portion of the aggregate. | |
| 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 void | setForceUpdate (bool flag) |
| Set to force an update all of attributes on the next tick. | |
| Public Member Functions inherited from DtSimLocalEntityNetInterface | |
| DtSimLocalEntityNetInterface (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true) | |
| read/writable contructor | |
| DtSimLocalEntityNetInterface (const DtSimLocalEntityNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor; NOTE: The publisher is not copied, because VR-Link does not provide a copy constructor (or clone or assignment function) for a publisher. | |
| const DtSimLocalEntityNetInterface & | operator= (const DtSimLocalEntityNetInterface &orig) |
| assignment operator; see note on copy constructor above. | |
| virtual | ~DtSimLocalEntityNetInterface () |
| destructor; calls destroyPublisher(). | |
| virtual void | onTick () |
| Checks if VR-Forces-specific data has changed. | |
| virtual double | calculateNextTickTime () const |
| The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. | |
| virtual bool | publisherUserSupplied () const |
| A true return indicates that the publisher currently used by the interface was supplied by the user rather than created by init(). | |
| DtVrfObject * | vrfObject () const |
| virtual bool | isLocal () const |
| This network interface is for local entities. | |
| Public Member Functions inherited from DtSimEntityNetInterface | |
| DtSimEntityNetInterface (const DtString &name, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true) | |
| read/writable contructor | |
| DtSimEntityNetInterface (const DtSimEntityNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| const DtSimEntityNetInterface & | operator= (const DtSimEntityNetInterface &orig) |
| assignment operator | |
| virtual | ~DtSimEntityNetInterface () |
| destructor | |
| virtual DtBaseEntityStateRepository * | baseEntityNetworkState () const |
| virtual bool | isEntity () const |
| This network interface is for entities, in the DIS - HLA/RPR sense. | |
| virtual bool | isEnvironmental () const |
| Public Member Functions inherited from DtSimObjectNetInterface | |
| DtSimObjectNetInterface (const DtString &name, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true) | |
| read/writable contructor Publish object flag indicate whether or not locally simulated objects should actually publish the object on the network. | |
| DtSimObjectNetInterface (const DtSimObjectNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| const DtSimObjectNetInterface & | operator= (const DtSimObjectNetInterface &orig) |
| assignment operator | |
| virtual | ~DtSimObjectNetInterface () |
| destructor | |
| virtual DtVrfObject * | simObject () const |
| This is a pointer to the simulation object for which this interface was created. | |
| virtual DtStateRepository * | networkState () const |
| this is a pointer to the VR-Link network state repository create by either the contained publisher or reflected object | |
| virtual int | maxNameLength () const |
| Public Member Functions inherited from DtReaderWriter | |
| DtReaderWriter () | |
| default constructor | |
| DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| real constructor Setting the readonly flag prevents object from writing itself to the stream. | |
| DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator | |
| virtual | ~DtReaderWriter () |
| destructor | |
| virtual void | putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Top level call to write itself to file. | |
| virtual void | getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Top level to read itself from an input stream. | |
| virtual void | writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry. | |
| virtual DtSymbolString | name () const |
| Accessor for name of this readable/writable object. | |
| virtual void | addAlias (const DtSymbolString &alias) |
| Add an alias as an alternative name for this object. | |
| virtual bool | hasAlias (const DtSymbolString &alias) |
| virtual const aliasContainer & | aliases () const |
| virtual void | setReadonly (bool flag) |
| Set read-only flag. | |
| virtual bool | isReadonly () const |
| virtual bool | variableIsBound () const |
| virtual void | unbindVariable () |
| Sets the myVariableIsBound flag to false. | |
| virtual void | setName (const DtString &) |
| Set the name of the object. | |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. | |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. | |
| virtual void | bindVariables (DtVariableBindingsList variableBindings) |
| Runs a variable binding pass on this reader writer and any of its children. | |
| virtual std::list < DtVariableNameType > | unboundVariables () const |
| bool | invalid () const |
| virtual bool | hasChild (const DtReaderWriter *p) const |
| Returns true if this variable has a child p in it's chain. | |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| The specified flags are used for optional values. | |
| virtual bool | valueSpecified () const |
| The specified flags are used for optional values. | |
| virtual bool | isVariableReference () const |
| Specifies whether or not this reader writer is really a variable that is specified elsewhere. | |
| virtual void | setIsVariableReference (bool value) |
| virtual DtSymbolString | variableName () const |
| The variable name, if this object is a variable reference. | |
| virtual void | setVariableName (const DtSymbolString variableName) |
| The variable name, if this object is a variable reference. | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. | |
| DtReaderWriterRegistry & | registry () |
| Collection of child DtReaderWriter nodes owned by this object. | |
Static Public Member Functions | |
| static DtSimPseudoAggregateLocalEntityNetInterface * | isPseudoAggregateLocalEntityNetInterface (const DtSimObjectNetInterface *objNetInterface) |
| This function will return the objNetInterface passed in, cast to a DtSimPseudoAggregateLocalEntityNetInterface*, provided the objNetInterface is indeed a pseudo-aggregate local entity network interface. | |
| static DtSimObjectNetInterface * | creator (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry, bool publishObject) |
| Static Public Member Functions inherited from DtSimAggregateLocalEntityNetInterface | |
| static DtSimAggregateLocalEntityNetInterface * | isAggregateLocalEntityNetInterface (const DtSimObjectNetInterface *objNetInterface) |
| This function will return the objNetInterface passed in, cast to a DtSimAggregateLocalEntityNetInterface*, provided the objNetInterface is indeed an aggregate local entity network interface. | |
| Static Public Member Functions inherited from DtSimLocalEntityNetInterface | |
| static bool | isVrfGlobalId (const DtGlobalObjectDesignator &identifier) |
| Returns true if given global object Id is a VR-Forces encoded global Id and false if it is not. | |
| static DtSimLocalEntityNetInterface * | isLocalEntityNetInterface (const DtSimObjectNetInterface *objNetInterface) |
| This function will return the objNetInterface passed in, cast to a DtSimLocalEntityNetInterface*, provided the objNetInterface is indeed an local entity network interface. | |
| static void | setVrfDataTimeThreshold (DtTime time) |
| Sets the time to update the vrf data message. | |
| Static Public Member Functions inherited from DtSimEntityNetInterface | |
| static DtSimEntityNetInterface * | isEntityNetInterface (const DtSimObjectNetInterface *objNetInterface) |
| This function will return the objNetInterface passed in, cast to a DtSimEntityNetInterface*, provided the objNetInterface is indeed an entity network interface. | |
| Static Public Member Functions inherited from DtSimObjectNetInterface | |
| static void | addSimObjectNetInterfaceCreatorFcn (const DtString &type, DtSimObjectNetIfaceCreatorFcn fcn) |
| Adds a net interface creator function to the net interface factory. | |
| static void | setFactory (DtSimObjectNetInterfaceFactory *factory) |
| static DtSimObjectNetInterfaceFactory * | factory () |
| static DtSimObjectNetInterface * | createNetInterface (const DtString &name, const DtString &type, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true) |
| Creates a new net interface object using the factory. | |
| static int | maxNameLengthForInterfaceType (const DtString &interfaceTypeString) |
| Static Public Member Functions inherited from DtReaderWriter | |
| static void | putIndent (FILE *fp, int indentLevel) |
| static const DtVariableBindingsList & | nullVariableReference () |
| static void | setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData) |
| static void | setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData) |
| static const DtFilename & | appPath () |
| Gets the current working directory. | |
Protected Member Functions | |
| DtSimPseudoAggregateLocalEntityNetInterface () | |
| default constructor | |
| Protected Member Functions inherited from DtSimAggregateLocalEntityNetInterface | |
| DtSimAggregateLocalEntityNetInterface () | |
| default constructor | |
| virtual bool | updateVrfDataAsSeenByRemote () |
| Updates into network state. | |
| Protected Member Functions inherited from DtSimLocalEntityNetInterface | |
| DtSimLocalEntityNetInterface () | |
| default constructor | |
| Protected Member Functions inherited from DtSimEntityNetInterface | |
| DtSimEntityNetInterface () | |
| default constructor | |
| Protected Member Functions inherited from DtSimObjectNetInterface | |
| DtSimObjectNetInterface () | |
| default constructor | |
| Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. | |
| virtual void | bindLocalVariables (const DtVariableBindingsList &variableBindings) |
| Checks to see if this RW object is a variable reference that can be bound using the provided bindings. | |
| virtual void | putData (FILE *fp, int indentLevel=0) |
| Deriving class overrides these to get/put class specific data. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| Deriving class overrides these to get/put class specific data. | |
Additional Inherited Members | |
| Public Types inherited from DtReaderWriter | |
| typedef std::vector < DtSymbolString > | aliasContainer |
| typedef std::vector < DtSymbolString >::iterator | aliasIter |
| typedef std::vector < DtSymbolString > ::const_iterator | aliasConstIter |
| typedef std::pair < DtSymbolString, DtString > | DtVariableNameType |
| Protected Attributes inherited from DtSimAggregateLocalEntityNetInterface | |
| DtVrfAggregatePublisher * | myAggregatePublisher |
| double | myMinTickPeriod |
| double | myMinTickPeriodVariance |
| double | myNextTickTime |
| bool | myFirstPause |
| bool | myForceUpdate |
| Static Protected Attributes inherited from DtSimObjectNetInterface | |
| static DtSimObjectNetInterfaceFactory * | theFactory |
Class Description: DtSimPseudoAggregateLocalEntityNetInterface.
Derived from DtSimAggregateLocalEntityNetInterface, this class provides an interface between a pseudo-aggregate local entity (an aggregate entity that has seperatedly modelled subordinate entities) and its network (VR-Link) representation (A DtAggregatePublisher).
|
protected |
default constructor
| DtSimPseudoAggregateLocalEntityNetInterface::DtSimPseudoAggregateLocalEntityNetInterface | ( | const DtString & | name, |
| DtVrfObject * | object, | ||
| DtReaderWriterRegistry * | parentRegistry = 0, |
||
| bool | publishObject = true |
||
| ) |
read/writable contructor
| DtSimPseudoAggregateLocalEntityNetInterface::DtSimPseudoAggregateLocalEntityNetInterface | ( | const DtSimPseudoAggregateLocalEntityNetInterface & | orig, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
|
virtual |
destructor
| const DtSimPseudoAggregateLocalEntityNetInterface& DtSimPseudoAggregateLocalEntityNetInterface::operator= | ( | const DtSimPseudoAggregateLocalEntityNetInterface & | orig | ) |
assignment operator
|
virtual |
Override of base class updatePublisher().
Updates the network state repository with information about the entity's subordinates, and then calls the base class updatePublisher (which also ticks the publisher).
Reimplemented from DtSimAggregateLocalEntityNetInterface.
|
virtual |
Returns the pointer to the entity's state repository's subordinate list.
|
inlinevirtual |
Returns true if this interface supports a pseudo-aggregate entity, false otherwise (true aggregate).
Reimplemented from DtSimAggregateLocalEntityNetInterface.
|
virtual |
Returns the type of net interface object.
Strings are defined in netIfTypes.h.
Reimplemented from DtSimAggregateLocalEntityNetInterface.
|
static |
This function will return the objNetInterface passed in, cast to a DtSimPseudoAggregateLocalEntityNetInterface*, provided the objNetInterface is indeed a pseudo-aggregate local entity network interface.
|
static |
Reimplemented from DtSimAggregateLocalEntityNetInterface.