 |
VR-Forces 4.7 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces 4.7 Class Documentation
|
DtVrfObjectParameters; holds all of the configurable parameters for the DtVrfObjectStateRepository class. More...
Public Member Functions | |
| DtRandomizedObjectParameters (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL) | |
| Constructor with parameters to set up read/writability correctly. | |
| DtRandomizedObjectParameters (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL) | |
| virtual | ~DtRandomizedObjectParameters () |
| destructor | |
| virtual DtVrfObjectParameters * | clone (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) const |
| virtual DtVrfObjectParameters * | clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const |
| virtual bool | init () |
| Invoked when created so that deriving classes may do virtual allocation as necessary. | |
| virtual DtString | type () const |
| Returns a string identifying the type of parameter descriptor. | |
| virtual DtObjectType | pickRandomSimulationObject () const |
| Picks a random simulation object from the subordinate list. | |
| virtual bool | inheritValues (const DtVrfObjectParameters *benefactor) |
| Values left unspecified may be inherited from a parameter block of the same type, typically an ancestor in the DIS/RPR entity type hierarchy. | |
| virtual void | inheritValuesFromThisType (const DtVrfObjectParameters *benefactor) |
 Public Member Functions inherited from DtVrfObjectParameters | |
| DtVrfObjectParameters (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL) | |
| Constructor with parameters to set up read/writability correctly. | |
| DtVrfObjectParameters (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL) | |
| virtual | ~DtVrfObjectParameters () |
| destructor | |
| DtVrfObjectParameters & | operator= (const DtVrfObjectParameters &orig) |
| assignment operator | |
| virtual bool | createLocalSubComponentTypes () |
| Creates a DtVrfObjectSubComponentTypes type of composed object type. | |
| virtual bool | createRemoteSubComponentTypes () |
| Creates a DtVrfObjectSubComponentTypes type of composed object type. | |
| virtual DtVrfObjectSubComponentTypes * | localVrfSubComponentTypes () const |
| Get local sub-component types. | |
| virtual DtVrfObjectSubComponentTypes * | remoteVrfSubComponentTypes () const |
| Get remote sub-component types. | |
| virtual void | setMinTickPeriod (DtReal minTickPeriod) |
| Set the minimum tick period for this object (individual components and the network interface may override) | |
| virtual DtReal | minTickPeriod () const |
| get the minimum tick period for this component (individual components and the network interface may override) | |
| virtual void | setMinTickPeriodVariance (DtReal minTickPeriodVariance) |
| Set the minimum tick period variance for this component (individual components and the network interface may override) | |
| virtual DtReal | minTickPeriodVariance () const |
| Get the minimum tick period variance for this component (individual components and the network interface may override) | |
| virtual DtForceType | forceType () const |
| Currently unused. | |
| virtual void | setForceType (const DtForceType force) |
| virtual const DtString & | category () const |
| Accessor/mutator for myCategory. | |
| virtual void | setCategory (const DtString &category) |
| virtual bool | categorySpecified () const |
| Returns true of the category was specified in the file. | |
| virtual const DtString & | echelonLevel () const |
| Accessor/mutator for myEchelonLevel. | |
| virtual void | setEchelonLevel (const DtString &echelonLevel) |
| virtual bool | echelonLevelSpecified () const |
| Returns true of the echelon level was specified in the file. | |
| virtual bool | organized () const |
| Accessor/mutator for myOrganized. | |
| virtual void | setOrganized (bool organized) |
| virtual const DtRwVisualMetaData & | visualMetaData () const |
| Accessor/mutator for myVisualMetaData. | |
| virtual void | setVisualMetaData (const DtRwVisualMetaData &list) |
| virtual const DtComponentDescriptorList & | sensorDescriptorList () const |
| Accessor/mutator for mySensorDescriptorList. | |
| virtual DtComponentDescriptorList & | sensorDescriptorList () |
| virtual void | setSensorDescriptorList (const DtComponentDescriptorList &list) |
| virtual const DtComponentDescriptorList & | controllerDescriptorList () const |
| Accessor/mutator for myControllerDescriptorList. | |
| virtual DtComponentDescriptorList & | controllerDescriptorList () |
| virtual void | setControllerDescriptorList (const DtComponentDescriptorList &list) |
| virtual const DtComponentDescriptorList & | actuatorDescriptorList () const |
| Accessor/mutator for myActuatorDescriptorList. | |
| virtual DtComponentDescriptorList & | actuatorDescriptorList () |
| virtual void | setActuatorDescriptorList (const DtComponentDescriptorList &list) |
| virtual const DtConnectionDescriptorList & | connectionDescriptorList () const |
| Accessor/mutator for myConnectionDescriptorList. | |
| virtual DtConnectionDescriptorList & | connectionDescriptorList () |
| virtual void | setConnectionDescriptorList (const DtConnectionDescriptorList &list) |
| virtual DtDeadReckonTypes | deadReckoningAlgorithm () const |
| Accessor/mutator for myDeadReckoningAlgorithm. | |
| virtual void | setDeadReckoningAlgorithm (DtDeadReckonTypes deadReckoningAlgorithm) |
| virtual const DtRwNavigationParameters & | navigationParameters () const |
| Accessor/mutator for myNavigationParameters. | |
| virtual DtRwNavigationParameters & | navigationParameters () |
| virtual void | setNavigationParameters (const DtRwNavigationParameters ¶meters) |
| virtual const DtRwDeadReckonThresholds & | deadReckoningThresholds () const |
| Accessor/mutator for myDeadReckoningThresholds. | |
| virtual void | setDeadReckoningThresholds (const DtRwDeadReckonThresholds &deadReckoningThresholds) |
| virtual DtReal | mass () const |
| Accessor/mutator for myMass. | |
| virtual void | setMass (const DtReal mass) |
| virtual const DtRwSensorSignatureList & | sensorSignatureList () const |
| Accessor/mutator for mySensorSignatureList. | |
| virtual DtRwSensorSignatureList & | sensorSignatureList () |
| virtual const DtVrfSubObjectParameterList & | subordinateObjects () const |
| List of subordinates objects to create if fully instantiating from the parameter entry (ignored when object is being created by an AggregateAs message, eg.) | |
| virtual void | setSubordinateObjects (const DtVrfSubObjectParameterList &subordinateObjects) |
| virtual const DtVrfSubObjectParameterList & | attachedObjects () const |
| Note that attached objects are not fully supported yet (still need to modify our network interfaces to support the new VR-Link / RPR mechanism for publishing attached objects) and so this list is currently ignored. | |
| virtual void | setAttachedObjects (const DtVrfSubObjectParameterList &attachedObjects) |
| virtual DtVrfObjectSubComponentTypes * | localSubComponentTypes () const |
| Get local sub-component types. | |
| virtual DtVrfObjectSubComponentTypes * | remoteSubComponentTypes () const |
| Get remote sub-component types. | |
| virtual void | putData (std::string &fp, int indentLevel=0) |
| putData writes our type, which is provided by the virtual type accessor of the deriving class. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| getData is just used to get us past the type in the data stream, since it's not actual stored. | |
| virtual const Dt3dBoundingVolume * | boundingVolume () const |
| Set/get the bounding volume of the object. | |
| virtual void | setBoundingVolume (const Dt3dBoundingVolume &newBoundingVolume) |
| Set the bounding volume of the object. | |
| virtual void | setBoundingVolume (const DtVector &localBvolDiagonal, const DtVector &offset=DtVector::zero()) |
| Set the bounding volume from its components. | |
| virtual DtSimBoundingGeometry::DtSimBoundingGeometryType | boundingGeometryType () const |
| Set/get the bounding geometry type of the object. | |
| virtual void | setBoundingGeometryType (DtSimBoundingGeometry::DtSimBoundingGeometryType type) |
| virtual double | draft () const |
| For convenience– computes the draft from bounding volume. | |
| virtual DtAggregateFormation | formation () const |
| Accessor/mutator for myFormationType. | |
| virtual void | setFormation (DtAggregateFormation formation) |
| virtual DtU32 | appearance () const |
| Accessor/mutator for myDefaultAppearance. | |
| virtual void | setAppearance (const DtU32 appearance) |
| virtual bool | appearanceSpecified () const |
| virtual const DtString & | displayName () const |
| Accessor/mutator for myDisplayName. | |
| virtual void | setDisplayName (const DtString &s) |
| virtual const DtEntityType & | defaultEntityType () const |
| Accessor/mutator for myDefaultEntityType. | |
| virtual void | setDefaultEntityType (const DtEntityType &s) |
| virtual const DtString & | displayDescription () const |
| Accessor/mutator for myDisplayDescription. | |
| virtual void | setDisplayDescription (const DtString &s) |
| virtual const DtString & | engagementRules () const |
| Accessor/mutator for myEngagementRules. | |
| virtual void | setEngagementRules (const DtString &engagementRules) |
| virtual const DtSimResourceManager & | resourceManager () const |
| Accessor/mutator for myResourceManager. | |
| virtual void | setResourceManager (const DtSimResourceManager &resourceManager) |
| virtual void | setStateRepositoryUserExtensionType (const DtString &type) |
| Accessor/mutator for myStateRepositoryUserExtensionType. | |
| virtual const DtString & | stateRepositoryUserExtensionType () const |
| virtual DtObjectType | objectType () const |
| Accessor/mutator for myObjectType. | |
| virtual void | setObjectType (const DtObjectType &objectType) |
| virtual DtObjectType | matchType () const |
| Accessor/mutator for myMatchType. | |
| virtual void | setMatchType (const DtObjectType &objectType) |
| virtual bool | taskedBySuperiorUponTaskComplete () const |
| Flag indicating whether or not entity should always go into a 'tasked by superior' state upon completion of a top-level task (a non-subtask task). | |
| virtual void | setTaskedBySuperiorUponTaskComplete (bool trueOrFalse) |
| virtual void | setRangeRingPublisherTickTime (double) |
| Tick time for range ring publisher in simulation seconds. Default is -1 (as fast as possible) | |
| virtual double | rangeRingPublisherTickTime () const |
| void | setParameterType (const DtString &) |
| Sets/gets type of parameter. | |
| const DtString & | parameterType () const |
| virtual void | setStateRepositoryUserExtension (const DtVrfStateRepositoryUserExtension &userExtension) |
| State repository user extension data (extensible at the base class DtVrfObjectStateRepository). | |
| virtual DtVrfStateRepositoryUserExtension * | stateRepositoryUserExtension () const |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Override so we can figure out what kind of DtVrfStateRepositoryUserExtension to instantiate before calling down to base class version to actually load the parameters. | |
| virtual DtTime | underFireTime () const |
| virtual void | setUnderFireTime (DtTime time) |
| virtual bool | underFireTimeSpecified () const |
| virtual DtReal | underFireDistance () const |
| virtual void | setUnderFireDistance (DtReal underFireDistance) |
| virtual bool | underFireDistanceSpecified () const |
| virtual const DtAutoConnectionsListPtr & | autoConnections () const |
| virtual DtAutoConnectionsListPtr & | autoConnections () |
| virtual const std::list < DtSimArtPartDescriptor * > * | completeArtPartList () const |
| virtual void | connectSystems () |
| Creates entity-level connections between systems based on sysdef metadata. | |
| bool | operator== (const DtVrfObjectParameters &) const |
| Equality operator. Simply compares the contents of the registry. | |
| bool | operator!= (const DtVrfObjectParameters &) const |
| virtual DtEnvironmentSP | xmlEnvironment () |
| virtual DtEnvValueSP | objectNode () |
| virtual const DtReaderWriter * | findVariableBinding (const DtString &) const |
| Find a variable binding from the original items in getSelf. Only valid if getSelf was called for this object. | |
| virtual const DtVariableBindingsList & | variableBindingsFromLoad () const |
| virtual DtReaderWriterRegistryData * | findProperty (const DtString &rwName) const |
| Returns a property value as defined in the registry (first look) or the additional parameter data (second look) | |
| virtual const DtRwProperties & | parameterData () const |
| Return parameter data accessor. | |
| virtual DtRwProperties & | parameterData () |
| virtual const DtRwProperties & | stateData () const |
| Return state data. | |
| virtual DtRwProperties & | stateData () |
| virtual void | setPublishParameterData (bool) |
| Set to true if the parameter data is to be published in the extended data portion of the object. | |
| virtual bool | publishParameterData () const |
| virtual void | setUiFilename (const DtString &uiFilename) |
| virtual DtString | uiFilename () const |
| virtual void | setCanCreateAsNew (bool) |
| virtual bool | canCreateAsNew () const |
| virtual void | setCanMoveOntoEmbarked (bool) |
| Whether or not this object can be embarked on by checking as to whether or not and entity is moving near it and intersects it at a test location. | |
| virtual bool | canMoveOntoEmbarked () const |
| virtual const DtComponentSystemDescriptorList & | systemDescriptorList () const |
| See mySystemDescriptorList. | |
| virtual DtComponentSystemDescriptorList & | systemDescriptorList () |
| virtual void | setSystemDescriptorList (const DtComponentSystemDescriptorList &list) |
| virtual const DtRwBoolean | deadReckoningAllowGuiOverrides () const |
| Accessor/mutator for myDeadReckoningAllowGuiOverrides. | |
| virtual void | setDeadReckoningAllowGuiOverrides (bool allow) |
| virtual const DtRadioDescriptorList & | radioDescriptorList () const |
| See myRadioDescriptorList. | |
| virtual DtRadioDescriptorList & | radioDescriptorList () |
| virtual const DtSimSector & | initialSectorOfResponsibility () const |
| virtual void | setInitialSectorOfResponsibility (const DtSimSector &sor) |
| virtual DtTaskExecutionRules & | taskExecutionRules () |
| virtual const DtTaskExecutionRules & | taskExecutionRules () const |
| virtual void | setTaskExecutionRulesFilename (const DtFilename &) |
| virtual const DtReaderWriterFile & | taskExecutionRulesFilename () const |
| virtual void | setHlaFomClass (const DtString &) |
| virtual const DtString & | hlaFomClass () 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) | |
| pseudo-copy constructor | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator | |
| bool | operator== (const DtReaderWriter &) const |
| Equivalence operator. | |
| bool | operator!= (const DtReaderWriter &rhs) |
| virtual | ~DtReaderWriter () |
| destructor | |
| 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. | |
| virtual void | postPutSelf () |
| Called after either version of put self (file or environment). Default is no-op. | |
| virtual void | prePutSelf () |
| Called before either version of put self (file or environment). Default is no-op. | |
| virtual void | postGetSelf () |
| Called after either version of getSelf (mtl or environment). Default is no-op. | |
| virtual void | preGetSelf () |
| Called before either version of get self (file or environment). Default is no-op. | |
| 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. | |
| 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 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. | |
| 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. | |
| virtual int | alignment () const |
| For those items that are sent over the network via HLA, this will give the network alignment. | |
| 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 const char * | xmlType () const |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. | |
| std::string | debugText () const |
| 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 bool | hasVariableReference () const |
| Returns true if this item or any item in the registry (recursive) is a variable reference. | |
| 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 | recordUpdateTime () const |
| Can be implemented in subclasses to stamp the time when updated. | |
| virtual bool | wasUpdatedSince (DtTime t) const |
| Can be implemented in subclasses to return true if an update occurred after the specified time. | |
| virtual bool | changedSinceLastChecked () |
| Returns true if this objects value has changed since the last time this function was called. | |
| virtual bool | peekChangedSinceLastChecked () const |
| Returns the value that changedSinceLastChecked would return but does not reset the internal flag. | |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| The specified flags are used for optional values. | |
| virtual bool | valueSpecified () const |
| 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 void | clearAllVariableReferenceFlags () |
| Clears out all variable reference flags from all readerwriter items in registry recursively. | |
| virtual DtSymbolString | variableName () const |
| The variable name, if this object is a variable reference. | |
| 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. | |
| virtual DtReaderWriter * | defaultRWValue () |
| virtual void | setDefaultRWValue (DtReaderWriter *) |
| Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. | |
| 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. | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. | |
| 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. | |
| virtual bool | toXml (const DtFilename &) const |
| Writes contents of xml result to the given filename. | |
| virtual bool | fromXml (const DtString &) |
| Restores object from given xml string. Returns true if valid. | |
| virtual bool | fromXmlFile (const DtFilename &) |
| Restores object from given xml file. | |
| virtual void | putSelf (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP value) const |
| Override to add attributes of actual data. | |
| virtual void | putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const |
| Called when the item is a variable reference. | |
| 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. | |
| 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. | |
| virtual void | getVariableReference (DtEnvironmentSP, DtEnvValueSP value) |
| Called when the item is a variable reference. | |
Static Public Member Functions | |
| static DtVrfObjectParameters * | creator (DtEnvironmentSP env, DtEnvValueSP *objectNode) |
| | |
| Static Public Member Functions inherited from DtVrfObjectParameters | |
| static DtVrfObjectParameters * | createParameters (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL) |
| static DtVrfObjectParameters * | createParameters (const char *name, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL) |
| static DtVrfObjectParameterFactory * | factory () |
| static void | setFactory (DtVrfObjectParameterFactory *factory) |
| static void | addParameterCreatorFcn (const DtString &type, DtSimObjectParametersCreatorFcn fcn) |
| 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. | |
| static const DtFilename & | appPath () |
| Gets the current working directory. | |
| static void | setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn) |
| Sets the function to create the DtReaderWriterFactory. | |
| static void | createReaderWriterFactory () |
| static void | cleanupFactory () |
| 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. | |
| static DtReaderWriter * | createFromXml (const DtString &, bool createAsProperty=false) |
| Given a xml string, returns a newly created reader/writer object from the object found within. | |
| static DtReaderWriter * | createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false) |
| Given a xml environment, returns a newly created reader/writer object from the object found within. | |
| static DtString | getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root) |
| Gets the named attribute from a DtEnvValueSP. | |
Protected Member Functions | |
| DtRandomizedObjectParameters (const DtRandomizedObjectParameters &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor. Use clone instead. | |
| DtRandomizedObjectParameters (const DtRandomizedObjectParameters &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| Protected Member Functions inherited from DtVrfObjectParameters | |
| DtVrfObjectParameters (const DtVrfObjectParameters &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor. Use clone instead. | |
| DtVrfObjectParameters (const DtVrfObjectParameters &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| virtual DtVrfSubObjectParameterList * | createSubordinateObjectsList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry) const |
| Returns a newly created instance of a DtVrfObjectSubComponentTypes, which gets assigned ot mySubordinateObjects in init(). | |
| virtual DtVrfSubObjectParameterList * | createAttachedObjectsList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry) const |
| Returns a newly created instance of a DtVrfObjectSubComponentTypes, which gets assigned ot myAttachedObjects in init(). | |
| virtual void | rebuildArtPartList () |
| Clears out and rebuilds myCompleteArtPartList. | |
| virtual void | addArtPartsFromSystem (DtComponentSystemDescriptor *systemDesc, std::list< DtSimArtPartDescriptor * > &artPartList) |
| Adds any art parts defined within a system to the list. | |
| virtual void | createAutomaticConnections (DtRwAutoConnection *autoConnection) |
| Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. | |
Additional Inherited Members | |
| Public Types inherited from DtVrfObjectParameters | |
| typedef DtRwTemplatedListPtr < DtRwAutoConnection, true > | DtAutoConnectionsListPtr |
| Protected Attributes inherited from DtVrfObjectParameters | |
| DtObjectType | myMatchType |
| An extended form of the DIS/RPR FOM entity enumerated type. | |
| DtObjectType | myObjectType |
| DtTaskExecutionRules | myTaskExecutionRules |
| Task execution rules. | |
| DtString | myParameterType |
| String that keeps the type of parameter this is Local only – not part of descriptor. | |
| std::list < DtSimArtPartDescriptor * > | myCompleteArtPartList |
| A list containing all the art part descriptors from actuators directly on the entity and those in systems as well. | |
| DtEnvValueSP | myObjectNode |
| DtEnvironmentSP | myEnvironment |
| DtAutoConnectionsListPtr | myAutoConnections |
| DtRwProperties | myParameterData |
| Properies that are specific to this parameter as read from the OPE file. | |
| DtRwProperties | myStateData |
| Properties that will be added to the state repository of this particular entity. | |
| DtRwReal | myRangeRingPublisherTickTime |
| The tick time of the range ring "publisher" for range ring parameter and state data. | |
| DtRwBoolean | myPublishParameterData |
| Parameter Name: publish-parameter-data Parameter Description: Set to true to publish the parameter data in the extended object data under the parameters name. | |
| DtRwBoolean | myIlluminationRecalcTime |
| Parameter Name: illumination-recalc-time Parameter Description: Amount of time (in seconds) to recalculate entity illumination value based on location and time of day Parameter Units: Parameter Default Value: 3000 (5 minutes) | |
| DtRwString | myDisplayName |
| Parameter Name: display-name Parameter Description: Name to display to user in Simulation Object Editor Parameter Units: Parameter Default Value: | |
| DtRwString | myDisplayDescription |
| Parameter Name: display-description Parameter Description: Description of parameter to display in Simulation Object Editor Parameter Units: Parameter Default Value: | |
| DtRwString | myUiFilename |
| Parameter Name: ui-filename Parameter Description: name of the .ui file used to configure this entity in the Simulation Object Editor. | |
| DtRwBoolean | myCanCreateAsNew |
| Parameter Name: can-create-as-new Parameter Description: Only for Simulation Object Editor. | |
| DtRwBoolean | myCanMoveOntoEmbarked |
| Parameter Name: can-move-onto-embarked Parameter Description: Whether or not this object can be embarked on by checking as to whether or not and entity is moving near it and intersects it at a test location. | |
| DtRwString | myHlaFomClass |
| Parameter Name: hla-fom-class Parameter Description: Specifies the HLA FOM class to be published. | |
| DtRwEntityType | myDefaultEntityType |
| Parameter Name: display-entity-type Parameter Description: Default entity type for platform to use in Simulation Object Editor Parameter Units: Parameter Default Value: | |
| DtRwVisualMetaData | myVisualMetaData |
| Parameter Name: visual-meta-data Parameter Description: If defined how the visual meta data will initially be set when this object is created Parameter Units: Parameter Default Value: | |
| DtVariableBindingsList | myGetSelfVariableBindings |
| Local copy of variable bindings used to seed this parameter entry. | |
| DtRwBoundingGeometryType | myBoundingGeometryType |
| Parameter Name: bounding-geometry-type Parameter Description: Describes an object's bounding volume, bounding area, or lack of bounding geometry (in the case of a true point object). | |
| DtRwBoundingVolume | myBvol |
| Parameter Name: bounding-volume Parameter Description: Specifies the bounding volume around an object. | |
| DtVrfObjectSubComponentTypes * | myLocalSubComponentTypes |
| Parameter Name: local-objects Parameter Description: Specifies the state-repository, net-interface, task-manager, radio, and component-manager to be used by locally simulated objects. | |
| DtVrfObjectSubComponentTypes * | myRemoteSubComponentTypes |
| Parameter Name: remote-objects Parameter Description: Specifies the state-repository, net-interface, task-manager, radio, and component-manager to be used for remotely simulated objects. | |
| DtRwFormationType | myFormationType |
| Parameter Name: formation Parameter Description: (Optional) One of the following: | |
| DtRwAppearance | myDefaultAppearance |
| Parameter Name: default-appearance Parameter Description: Unsigned int used to set default valus for the DIS/RPR appearance bits. | |
| DtRwForceType | myForceType |
| Parameter Name: force-type Parameter Description: The force to which the object belongs. | |
| DtRwString | myCategory |
| Parameter Name: category Parameter Description: The category string to use when creating an echelon ID. | |
| DtRwString | myEchelonLevel |
| Parameter Name: echelon-level Parameter Description: The echelon level to use for this entity when creating an echelon ID. | |
| DtRwBoolean | myOrganized |
| Parameter Name: is-organized Parameter Description: Specifies that the entity is part of the entity hierarchy and requires an echelon ID. | |
| DtRwReal | myMinTickPeriod |
| Parameter Name: min-tick-period Parameter Description: Specifies the shortest period of time, in seconds, that can elapse between ticks of an entity's components. | |
| DtRwReal | myMinTickPeriodVariance |
| Parameter Name: min-tick-period-variance Parameter Description: Specifies an amount within which the min-tick-period can vary. | |
| DtRwDeadReckonTypes | myDeadReckoningAlgorithm |
| Parameter Name: dr-algorithm Parameter Description: The VR-Link dead-reckoning algorithm to use when publishing this entity. | |
| DtRwNavigationParameters | myNavigationParameters |
| DtRwDeadReckonThresholds | myDeadReckoningThresholds |
| Parameter Name: dr-thresholds Parameter Description: The translation, rotation, and aggregate dimension thresholds used when publishing this entity. | |
| DtRwBoolean | myDeadReckoningAllowGuiOverrides |
| DtRadioDescriptorList | myRadioDescriptorList |
| Parameter Name: radios Parameter Description: List of all radios on the entity. | |
| DtComponentSystemDescriptorList | mySystemDescriptorList |
| Parameter Name: systems Parameter Description: List of system descriptors. | |
| DtComponentDescriptorList | mySensorDescriptorList |
| Parameter Name: sensors Parameter Description: List of sensor controller component descriptors. | |
| DtComponentDescriptorList | myControllerDescriptorList |
| Parameter Name: controllers Parameter Description: List of controller component descriptors. | |
| DtComponentDescriptorList | myActuatorDescriptorList |
| Parameter Name: actuators Parameter Description: List of actuator component descriptors. | |
| DtConnectionDescriptorList | myConnectionDescriptorList |
| Parameter Name: connections Parameter Description: The connections (Example 5.2, line 19) entry specifies how the components connect to one another (through ports, port groups, or both). | |
| DtRwReal | myMass |
| Parameter Name: mass Parameter Description: The mass of the entity. | |
| DtRwSensorSignatureList | mySensorSignatureList |
| Parameter Name: sensor-signatures Parameter Description: Parameter Default Value: | |
| DtVrfSubObjectParameterList * | mySubordinateObjects |
| Parameter Name: subordinate-objects Parameter Description: (Optional) List of entries specifying subordinate objects to be created as part of an aggregate object. | |
| DtVrfSubObjectParameterList * | myAttachedObjects |
| Parameter Name: attached-objects Parameter Description: Parameter Default Value: . | |
| DtRwString | myEngagementRules |
| Parameter Name: engagement-rules Parameter Description: (Optional) The engagement rules the entity will use unless/until changed by a set engagement rules message. | |
| DtSimResourceManager | myResourceManager |
| Parameter Name: resources Parameter Description: Specifies the types and amount of resources the entity has. | |
| DtRwString | myStateRepositoryUserExtensionType |
| Parameter Name: state-repository-extension-type Parameter Description: Type of state repository extensions class to instantiate. | |
| DtRwBoolean | myTaskedBySuperiorUponTaskComplete |
| Parameter Name: tasked-by-superior-upon-task-complete Parameter Description: Flag indicating whether or not subordinates should automatically resume a tasked-by-superior status upon completing an independent task. | |
| DtVrfStateRepositoryUserExtension * | myStateRepositoryUserExtension |
| Parameter Name: user-extension Parameter Description: Extension to the state repository class. | |
| DtRwTime | myUnderFireTime |
| Parameter Name: under-fire-time Parameter Description: Deprecated. | |
| DtRwReal | myUnderFireDistance |
| Parameter Name: under-fire-distance Parameter Description: Deprecated. | |
| DtSimSector | myInitialSectorOfResponsibility |
| Parameter Name: initial-sector-of-responsibility Parameter Description: The sector of responsibility for this entity when the entity is first created. | |
| DtReaderWriterFile | myTaskExecutionRulesFilename |
| Parameter Name: task-execution-rules Parameter Description: The name of the file that contains the task execution rules for this entity. | |
| Static Protected Attributes inherited from DtVrfObjectParameters | |
| static DtVrfObjectParameterFactory * | theFactory |
DtVrfObjectParameters; holds all of the configurable parameters for the DtVrfObjectStateRepository class.
Instances of DtRandomizedObjectParameters are a signal to creaete one of the subordinate objects randomly from an even distribution of objects. Call the pickRandomSimulationObject() method to return one of the random objects
| DtRandomizedObjectParameters::DtRandomizedObjectParameters | ( | const DtString & | name = DtString::nullString(), |
| DtReaderWriterRegistry * | parentRegistry = NULL, |
||
| DtEnvironmentSP | env = DtEnvironmentSP(), |
||
| DtEnvValueSP * | objectNode = NULL |
||
| ) |
Constructor with parameters to set up read/writability correctly.
| DtRandomizedObjectParameters::DtRandomizedObjectParameters | ( | const DtSymbolString & | name, |
| DtReaderWriterRegistry * | parentRegistry = NULL, |
||
| DtEnvironmentSP | env = DtEnvironmentSP(), |
||
| DtEnvValueSP * | objectNode = NULL |
||
| ) |
|
virtual |
destructor
|
protected |
copy constructor. Use clone instead.
|
protected |
|
virtual |
Reimplemented from DtVrfObjectParameters.
|
virtual |
Reimplemented from DtVrfObjectParameters.
|
virtual |
Invoked when created so that deriving classes may do virtual allocation as necessary.
Makes a lot of the members read-only so they will not be saved.
Reimplemented from DtVrfObjectParameters.
|
virtual |
Returns a string identifying the type of parameter descriptor.
Used to create the descriptor on read from a parameter database file. ((Required) The value must be in quotation marks. Type strings are defined in vrfParamTypes.h.
Reimplemented from DtVrfObjectParameters.
|
static |
Reimplemented from DtVrfObjectParameters.
|
virtual |
Picks a random simulation object from the subordinate list.
|
virtual |
Values left unspecified may be inherited from a parameter block of the same type, typically an ancestor in the DIS/RPR entity type hierarchy.
For example, US ground vehicle (1 1 225 0 0 0 0) and US Large wheeled utility vehicle (1 1 225 7 0 0 0) might both have DtGroundVehicleParameters parameter blocks. If some or even all parameters are left unspecified for (1 1 225 7 0 0 0), it can inherit them from (1 1 225 0 0 0 0), its DIS/RPR ancestor.
The direct ancestor of a parameter block might use a parameter type that is different (and most likely a class the parameter block is derived from). Every parameter block type also knows how to inherit from the type it is derived from.
Reimplemented from DtVrfObjectParameters.
|
virtual |
Reimplemented from DtVrfObjectParameters.