 |
VR-Forces 4.10 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces 4.10 Class Documentation
|
Defines the local net interface class that supports aggregates with extended property attributes. More...
Public Member Functions | |
| DtSimAggregateLocalEntityWithPropertiesNetInterface (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true) | |
| read/writable constructor More... | |
| DtSimAggregateLocalEntityWithPropertiesNetInterface (const DtSimAggregateLocalEntityWithPropertiesNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor More... | |
| const DtSimAggregateLocalEntityWithPropertiesNetInterface & | operator= (const DtSimAggregateLocalEntityWithPropertiesNetInterface &orig) |
| assignment operator More... | |
| virtual | ~DtSimAggregateLocalEntityWithPropertiesNetInterface () |
| destructor More... | |
| virtual DtString | type () const |
| Returns the type of net interface object. More... | |
 Public Member Functions inherited from DtLocalExtendedPropertiesNetInterface< DtSimAggregateLocalEntityNetInterface, DtExtAggregateStateRepository > | |
| DtLocalExtendedPropertiesNetInterface (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true) | |
| read/writable constructor More... | |
| DtLocalExtendedPropertiesNetInterface (const DtLocalExtendedPropertiesNetInterface< DtSimAggregateLocalEntityNetInterface, DtExtAggregateStateRepository > &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor More... | |
| const DtLocalExtendedPropertiesNetInterface & | operator= (const DtLocalExtendedPropertiesNetInterface< DtSimAggregateLocalEntityNetInterface, DtExtAggregateStateRepository > &orig) |
| assignment operator More... | |
| virtual | ~DtLocalExtendedPropertiesNetInterface () |
| destructor More... | |
| virtual bool | initExtendedProperties () |
| Initializer. More... | |
| virtual void | onTick () |
| Overridden to tick the ExtendedAttributes object publisher. More... | |
| virtual void | updatePublisher () |
| Calls the base class updatePublisher() and then updates the extended property attributes. More... | |
| virtual void | updateUuid () |
| Updates the UUID to be published to the network. More... | |
| Public Member Functions inherited from DtSimAggregateLocalEntityNetInterface | |
| DtSimAggregateLocalEntityNetInterface (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true) | |
| read/writable constructor More... | |
| DtSimAggregateLocalEntityNetInterface (const DtSimAggregateLocalEntityNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor More... | |
| const DtSimAggregateLocalEntityNetInterface & | operator= (const DtSimAggregateLocalEntityNetInterface &orig) |
| assignment operator More... | |
| virtual | ~DtSimAggregateLocalEntityNetInterface () |
| destructor More... | |
| bool | init (const DtEntityIdentifier &id=DtEntityIdentifier::nullId()) |
| Override to initialize myNextTickTime. More... | |
| virtual void | updateNet () |
| Ticks the publisher, then calls base class version. More... | |
| virtual void | tick () |
| Override base class tick. More... | |
| virtual void | setMinTickPeriod (double minTickPeriod) |
| specifies a minimum tick period (which can also be thought of as More... | |
| virtual double | minTickPeriod () const |
| access the minimum tick period More... | |
| virtual void | setMinTickPeriodVariance (double minTickPeriodVariance) |
| set the variance in the minimum tick time More... | |
| virtual double | minTickPeriodVariance () const |
| access the variance in the minimum tick period More... | |
| virtual void | setNextTickTime (double nextTickTime) |
| The next tick time is normally calculated internally. More... | |
| virtual double | nextTickTime () const |
| access the next tick time More... | |
| virtual bool | createPublisher (const DtEntityIdentifier &id=DtEntityIdentifier::nullId()) |
| Override of base class createPublisher(). Creates a DtVrfExtAggregatePublisher. More... | |
| virtual void | destroyPublisher () |
| Deletes the DtVrfExtAggregatePublisher. More... | |
| virtual DtObjectPublisher * | publisher () |
| Returns the publisher used by this net interface. More... | |
| virtual bool | setAggregatePublisher (DtVrfExtAggregatePublisher *publisher) |
| If the user needs to supply a publisher other than the one created by the network interface, this call can be used. More... | |
| virtual void | setupNetworkRepository () |
| Initialize the DtExtAggregateStateRepository created by the DtVrfExtAggregatePublisher with values from the already initialized local aggregate state repository (DtSimAggregateLocalStateRepository). More... | |
| virtual DtVrfExtAggregatePublisher * | aggregatePublisher () const |
| Returns a pointer to the DtVrfExtAggregatePublisher either created by createPublisher() or set by setAggregatePublisher(). More... | |
| virtual DtExtAggregateStateRepository * | aggregateNetworkState () const |
| Returns a pointer to the DtExtAggregateStateRepository created by the DtVrfExtAggregatePublisher. More... | |
| virtual DtVrfAggregateStateRepository * | aggregateLocalState () const |
| virtual bool | setUserVariableDatum (int userRecordNumber, const DtVariableDatumRecord &record) |
| Adds a user specified variable datum record. More... | |
| virtual bool | getUserVariableDatum (int userRecordNumber, DtVariableDatumRecord &rec) |
| Returns a user specified variable datum record. More... | |
| virtual bool | encodeVariableDatum () |
| Sets information that is going to be used in the variable portion of the aggregate. More... | |
| 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). More... | |
| virtual bool | isPseudoAggregate () const |
| Returns true if this interface supports a pseudo-aggregate entity, false otherwise (true aggregate). More... | |
| virtual bool | isAggregate () const |
| virtual void | setForceUpdate (bool flag) |
| Set to force an update all of attributes on the next tick. More... | |
| virtual RTI::ObjectClassHandle | objectClassHandle () const |
| Returns the HLA object class handle of the published object. More... | |
| Public Member Functions inherited from DtSimLocalEntityNetInterface | |
| DtSimLocalEntityNetInterface (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true) | |
| read/writable constructor More... | |
| 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. More... | |
| const DtSimLocalEntityNetInterface & | operator= (const DtSimLocalEntityNetInterface &orig) |
| assignment operator; see note on copy constructor above. More... | |
| virtual | ~DtSimLocalEntityNetInterface () |
| destructor; calls destroyPublisher(). More... | |
| virtual double | calculateNextTickTime () const |
| The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. More... | |
| 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(). More... | |
| DtVrfObject * | vrfObject () const |
| virtual bool | isLocal () const |
| This network interface is for local entities. More... | |
| Public Member Functions inherited from DtSimEntityNetInterface | |
| DtSimEntityNetInterface (const DtString &name, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true) | |
| read/writable contructor More... | |
| DtSimEntityNetInterface (const DtSimEntityNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor More... | |
| const DtSimEntityNetInterface & | operator= (const DtSimEntityNetInterface &orig) |
| assignment operator More... | |
| virtual | ~DtSimEntityNetInterface () |
| destructor More... | |
| virtual DtBaseEntityStateRepository * | baseEntityNetworkState () const |
| virtual bool | isEntity () const |
| This network interface is for entities, in the DIS - HLA/RPR sense. More... | |
| virtual bool | isEnvironmental () const |
| Public Member Functions inherited from DtSimObjectNetInterface | |
| DtSimObjectNetInterface (const DtString &name, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true) | |
| read/writable constructor Publish object flag indicate whether or not locally simulated objects should actually publish the object on the network. More... | |
| DtSimObjectNetInterface (const DtSimObjectNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor More... | |
| const DtSimObjectNetInterface & | operator= (const DtSimObjectNetInterface &orig) |
| assignment operator More... | |
| virtual | ~DtSimObjectNetInterface () |
| destructor More... | |
| virtual bool | init () |
| Derived classes that need to perform virtual construction my override this function as desired. More... | |
| virtual DtVrfObject * | simObject () const |
| This is a pointer to the simulation object for which this interface was created. More... | |
| virtual DtStateRepository * | networkState () const |
| this is a pointer to the VR-Link network state repository create by either the contained publisher or reflected object More... | |
| virtual int | maxNameLength () const |
| Public Member Functions inherited from DtReaderWriter | |
| DtReaderWriter () | |
| default constructor More... | |
| DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| real constructor Setting the readonly flag prevents object from writing itself to the stream. More... | |
| DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| pseudo-copy constructor More... | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor More... | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator More... | |
| bool | operator== (const DtReaderWriter &) const |
| Equivalence operator. More... | |
| bool | operator!= (const DtReaderWriter &rhs) |
| virtual | ~DtReaderWriter () |
| destructor More... | |
| virtual void | putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Top level call to write itself to file. More... | |
| virtual void | postPutSelf () |
| Called after either version of put self (file or environment). Default is no-op. More... | |
| virtual void | prePutSelf () |
| Called before either version of put self (file or environment). Default is no-op. More... | |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Top level to read itself from an input stream. More... | |
| virtual void | postGetSelf () |
| Called after either version of getSelf (mtl or environment). Default is no-op. More... | |
| virtual void | preGetSelf () |
| Called before either version of get self (file or environment). Default is no-op. More... | |
| virtual void | writeSelf (std::string &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. More... | |
| virtual DtSymbolString | name () const |
| Accessor for name of this readable/writable object. More... | |
| virtual void | addAlias (const DtSymbolString &alias) |
| Add an alias as an alternative name for this object. More... | |
| virtual void | addAlias (const DtString &alias) |
| virtual bool | hasAlias (const DtSymbolString &alias) |
| virtual const aliasContainer & | aliases () const |
| virtual void | setReadonly (bool flag) |
| Set read-only flag. More... | |
| bool | isReadonly () const |
| virtual void | reset () |
| For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More... | |
| virtual int | alignment () const |
| For those items that are sent over the network via HLA, this will give the network alignment. More... | |
| virtual bool | variableIsBound () const |
| virtual void | unbindVariable () |
| Sets the myVariableIsBound flag to false. More... | |
| virtual void | setName (const DtString &) |
| Set the name of the object. More... | |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. More... | |
| virtual const char * | xmlType () const |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. More... | |
| std::string | debugText () const |
| virtual void | bindVariables (DtVariableBindingsList variableBindings) |
| Runs a variable binding pass on this reader writer and any of its children. More... | |
| 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. More... | |
| virtual bool | hasVariableReference () const |
| Returns true if this item or any item in the registry (recursive) is a variable reference. More... | |
| 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. More... | |
| virtual void | recordUpdateTime () const |
| Can be implemented in subclasses to stamp the time when updated. More... | |
| virtual bool | wasUpdatedSince (DtTime t) const |
| Can be implemented in subclasses to return true if an update occurred after the specified time. More... | |
| virtual bool | changedSinceLastChecked () |
| Returns true if this objects value has changed since the last time this function was called. More... | |
| virtual bool | peekChangedSinceLastChecked () const |
| Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More... | |
| virtual void | putData (std::string &fp, int indentLevel=0) |
| Deriving class overrides these to get/put class specific data. More... | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| The specified flags are used for optional values. More... | |
| virtual bool | valueSpecified () const |
| virtual bool | isVariableReference () const |
| Specifies whether or not this reader writer is really a variable that is specified elsewhere. More... | |
| virtual void | setIsVariableReference (bool value) |
| virtual void | clearAllVariableReferenceFlags () |
| Clears out all variable reference flags from all readerwriter items in registry recursively. More... | |
| virtual DtSymbolString | variableName () const |
| The variable name, if this object is a variable reference. More... | |
| virtual void | setVariableName (const DtSymbolString variableName) |
| virtual const DtReaderWriter * | defaultRWValue () const |
| The default value to use if the reader/writer object is a variable and that variable is not specified. More... | |
| virtual DtReaderWriter * | defaultRWValue () |
| virtual void | setDefaultRWValue (DtReaderWriter *) |
| Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More... | |
| virtual bool | checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Give the stream, if the stream contains a default value then set it here. More... | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. More... | |
| DtReaderWriterRegistry & | registry () |
| virtual DtPropertyInterface * | property () |
| virtual const DtPropertyInterface * | property () const |
| virtual DtString | toXml () const |
| virtual DtRwVariableBindings * | generateVariableBindings () const |
| Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More... | |
| virtual bool | toXml (const DtFilename &) const |
| Writes contents of xml result to the given filename. More... | |
| virtual bool | fromXml (const DtString &) |
| Restores object from given xml string. Returns true if valid. More... | |
| virtual bool | fromXmlFile (const DtFilename &) |
| Restores object from given xml file. More... | |
| virtual void | putSelf (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP value) const |
| Override to add attributes of actual data. More... | |
| virtual void | putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const |
| Called when the item is a variable reference. More... | |
| virtual void | getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| virtual void | getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| Gets data from the environment value. More... | |
| virtual void | unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) |
| Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More... | |
| virtual void | getVariableReference (DtEnvironmentSP, DtEnvValueSP value) |
| Called when the item is a variable reference. More... | |
Static Public Member Functions | |
| static DtSimObjectNetInterface * | creator (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry, bool publishObject) |
| Static Public Member Functions inherited from DtLocalExtendedPropertiesNetInterface< DtSimAggregateLocalEntityNetInterface, DtExtAggregateStateRepository > | |
| 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. More... | |
| static DtSimObjectNetInterface * | creator (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry, bool publishObject) |
| 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. More... | |
| 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. More... | |
| static void | setVrfDataTimeThreshold (DtTime time) |
| Sets the time to update the vrf data message. More... | |
| static void | setHeartbeatVariance (double variance) |
| Variance to use for setting heartbeat thresholds. More... | |
| static double | heartbeatVariance () |
| 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. More... | |
| Static Public Member Functions inherited from DtSimObjectNetInterface | |
| static void | setNonVrfUUIDResolver (DtNonVrfUUIDResolver *) |
| Sets the resolver that is to be used when resolving non-VR-Forces uuids. More... | |
| static DtNonVrfUUIDResolver * | nonVrfUUIDResolver () |
| static void | addSimObjectNetInterfaceCreatorFcn (const DtString &type, DtSimObjectNetIfaceCreatorFcn fcn) |
| Adds a net interface creator function to the net interface factory. More... | |
| 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. More... | |
| static int | maxNameLengthForInterfaceType (const DtString &interfaceTypeString) |
| static void | setNonVrfObjectsUUIDScheme (const DtString &) |
| Sets the UUID scheme for non vrf objects. More... | |
| static DtString | nonVrfObjectsUUIDScheme () |
| Static Public Member Functions inherited from DtReaderWriter | |
| static void | putIndent (std::string &fp, int indentLevel) |
| static const DtVariableBindingsList & | nullVariableReference () |
| static void | setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData) |
| static void | setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData) |
| static void | setPutIndent (bool) |
| static bool | putIndent () |
| static const char * | theXmlType () |
| The type that is used when archiving to an XML stream. More... | |
| static const DtFilename & | appPath () |
| Gets the current working directory. More... | |
| static void | setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn) |
| Sets the function to create the DtReaderWriterFactory. More... | |
| static void | createReaderWriterFactory () |
| static void | cleanupFactory () |
| static DtReaderWriterFactory * | factory () |
| static void | setOutputStream (DtOutputStream *stream) |
| static DtOutputStream & | outputStream () |
| static DtReaderWriter * | createFromXmlFile (const DtFilename &, bool createAsProperty=false) |
| Given a filename, returns a newly created reader/writer object from the object found within. More... | |
| static DtReaderWriter * | createFromXml (const DtString &, bool createAsProperty=false) |
| Given a xml string, returns a newly created reader/writer object from the object found within. More... | |
| static DtReaderWriter * | createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false) |
| Given a xml environment, returns a newly created reader/writer object from the object found within. More... | |
| static DtString | getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root) |
| Gets the named attribute from a DtEnvValueSP. More... | |
Defines the local net interface class that supports aggregates with extended property attributes.
Extends DtSimAggregateLocalEntityNetInterface to give it the ability to publish extended properties.
|
protected |
default constructor
| DtSimAggregateLocalEntityWithPropertiesNetInterface::DtSimAggregateLocalEntityWithPropertiesNetInterface | ( | const DtString & | name, |
| DtVrfObject * | vrfObject, | ||
| DtReaderWriterRegistry * | parentRegistry = 0, |
||
| bool | publishObject = true |
||
| ) |
read/writable constructor
| DtSimAggregateLocalEntityWithPropertiesNetInterface::DtSimAggregateLocalEntityWithPropertiesNetInterface | ( | const DtSimAggregateLocalEntityWithPropertiesNetInterface & | orig, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
|
virtual |
destructor
| const DtSimAggregateLocalEntityWithPropertiesNetInterface& DtSimAggregateLocalEntityWithPropertiesNetInterface::operator= | ( | const DtSimAggregateLocalEntityWithPropertiesNetInterface & | orig | ) |
assignment operator
|
virtual |
Returns the type of net interface object.
Strings are defined in netIfTypes.h.
Reimplemented from DtSimAggregateLocalEntityNetInterface.
|
static |