VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions
DtGlobalEnvironmentParameters Class Reference
Inheritance diagram for DtGlobalEnvironmentParameters:
Inheritance graph
[legend]

Public Member Functions

 DtGlobalEnvironmentParameters (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL)
 constructor with parameters to set up read/writability correctly More...
 
 DtGlobalEnvironmentParameters (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL)
 
virtual ~DtGlobalEnvironmentParameters ()
 destructor More...
 
const
DtGlobalEnvironmentParameters
operator= (const DtGlobalEnvironmentParameters &orig)
 assignment operator More...
 
virtual DtVrfObjectParametersclone (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) const
 
virtual DtVrfObjectParametersclone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
 
virtual DtString type () const
 Should return the type of object this is a parameter block for. More...
 
virtual void sendUpdateWhenTimeChangesBy (double)
 
virtual double updateWhenTimeChangesBy () const
 
- 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. More...
 
 DtVrfObjectParameters (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL)
 
virtual ~DtVrfObjectParameters ()
 destructor More...
 
DtVrfObjectParametersoperator= (const DtVrfObjectParameters &orig)
 assignment operator More...
 
virtual bool init ()
 Invoked when created so that deriving classes may do virtual allocation as necessary. More...
 
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. More...
 
virtual void inheritValuesFromThisType (const DtVrfObjectParameters *benefactor)
 
virtual bool createLocalSubComponentTypes ()
 Creates a DtVrfObjectSubComponentTypes type of composed object type. More...
 
virtual bool createRemoteSubComponentTypes ()
 Creates a DtVrfObjectSubComponentTypes type of composed object type. More...
 
virtual
DtVrfObjectSubComponentTypes
localVrfSubComponentTypes () const
 Get local sub-component types. More...
 
virtual
DtVrfObjectSubComponentTypes
remoteVrfSubComponentTypes () const
 Get remote sub-component types. More...
 
virtual void setMinTickPeriod (DtReal minTickPeriod)
 Set the minimum tick period for this object (individual components and the network interface may override) More...
 
virtual DtReal minTickPeriod () const
 get the minimum tick period for this component (individual components and the network interface may override) More...
 
virtual void setMinTickPeriodVariance (DtReal minTickPeriodVariance)
 Set the minimum tick period variance for this component (individual components and the network interface may override) More...
 
virtual DtReal minTickPeriodVariance () const
 Get the minimum tick period variance for this component (individual components and the network interface may override) More...
 
virtual DtForceType forceType () const
 Currently unused. More...
 
virtual void setForceType (const DtForceType force)
 
virtual bool hasGuiKeyword (const DtString &) const
 Returns true if the gui keywords contain the particular keyword specified (the gui keywords are specified in the .entity object) More...
 
virtual const DtStringcategory () const
 Accessor/mutator for myCategory. More...
 
virtual void setCategory (const DtString &category)
 
virtual bool categorySpecified () const
 Returns true of the category was specified in the file. More...
 
virtual const DtStringechelonLevel () const
 Accessor/mutator for myEchelonLevel. More...
 
virtual void setEchelonLevel (const DtString &echelonLevel)
 
virtual bool echelonLevelSpecified () const
 Returns true of the echelon level was specified in the file. More...
 
virtual bool organized () const
 Accessor/mutator for myOrganized. More...
 
virtual void setOrganized (bool organized)
 
virtual const DtRwVisualMetaDatavisualMetaData () const
 Accessor/mutator for myVisualMetaData. More...
 
virtual void setVisualMetaData (const DtRwVisualMetaData &list)
 
virtual const
DtComponentDescriptorList
sensorDescriptorList () const
 Accessor/mutator for mySensorDescriptorList. More...
 
virtual DtComponentDescriptorListsensorDescriptorList ()
 
virtual void setSensorDescriptorList (const DtComponentDescriptorList &list)
 
virtual const
DtComponentDescriptorList
controllerDescriptorList () const
 Accessor/mutator for myControllerDescriptorList. More...
 
virtual DtComponentDescriptorListcontrollerDescriptorList ()
 
virtual void setControllerDescriptorList (const DtComponentDescriptorList &list)
 
virtual const
DtComponentDescriptorList
actuatorDescriptorList () const
 Accessor/mutator for myActuatorDescriptorList. More...
 
virtual DtComponentDescriptorListactuatorDescriptorList ()
 
virtual void setActuatorDescriptorList (const DtComponentDescriptorList &list)
 
virtual const
DtConnectionDescriptorList
connectionDescriptorList () const
 Accessor/mutator for myConnectionDescriptorList. More...
 
virtual
DtConnectionDescriptorList
connectionDescriptorList ()
 
virtual void setConnectionDescriptorList (const DtConnectionDescriptorList &list)
 
virtual DtDeadReckonTypes deadReckoningAlgorithm () const
 Accessor/mutator for myDeadReckoningAlgorithm. More...
 
virtual void setDeadReckoningAlgorithm (DtDeadReckonTypes deadReckoningAlgorithm)
 
virtual const
DtRwNavigationParameters
navigationParameters () const
 Accessor/mutator for myNavigationParameters. More...
 
virtual DtRwNavigationParametersnavigationParameters ()
 
virtual void setNavigationParameters (const DtRwNavigationParameters &parameters)
 
virtual const
DtRwDeadReckonThresholds
deadReckoningThresholds () const
 Accessor/mutator for myDeadReckoningThresholds. More...
 
virtual void setDeadReckoningThresholds (const DtRwDeadReckonThresholds &deadReckoningThresholds)
 
virtual DtReal mass () const
 Accessor/mutator for myMass. More...
 
virtual void setMass (const DtReal mass)
 
virtual const
DtRwSensorSignatureList
sensorSignatureList () const
 Accessor/mutator for mySensorSignatureList. More...
 
virtual DtRwSensorSignatureListsensorSignatureList ()
 
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.) More...
 
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. More...
 
virtual void setAttachedObjects (const DtVrfSubObjectParameterList &attachedObjects)
 
virtual
DtVrfObjectSubComponentTypes
localSubComponentTypes () const
 Get local sub-component types. More...
 
virtual
DtVrfObjectSubComponentTypes
remoteSubComponentTypes () const
 Get remote sub-component types. More...
 
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. More...
 
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. More...
 
virtual const Dt3dBoundingVolume * boundingVolume () const
 Set/get the bounding volume of the object. More...
 
virtual void setBoundingVolume (const Dt3dBoundingVolume &newBoundingVolume)
 Set the bounding volume of the object. More...
 
virtual void setBoundingVolume (const DtVector &localBvolDiagonal, const DtVector &offset=DtVector::zero())
 Set the bounding volume from its components. More...
 
virtual
DtSimBoundingGeometry::DtSimBoundingGeometryType 
boundingGeometryType () const
 Set/get the bounding geometry type of the object. More...
 
virtual void setBoundingGeometryType (DtSimBoundingGeometry::DtSimBoundingGeometryType type)
 
virtual double draft () const
 For convenience– computes the draft from bounding volume. More...
 
virtual DtAggregateFormation formation () const
 Accessor/mutator for myFormationType. More...
 
virtual void setFormation (DtAggregateFormation formation)
 
virtual DtU32 appearance () const
 Accessor/mutator for myDefaultAppearance. More...
 
virtual void setAppearance (const DtU32 appearance)
 
virtual bool appearanceSpecified () const
 
virtual const DtStringdisplayName () const
 Accessor/mutator for myDisplayName. More...
 
virtual void setDisplayName (const DtString &s)
 
virtual const DtEntityType & defaultEntityType () const
 Accessor/mutator for myDefaultEntityType. More...
 
virtual void setDefaultEntityType (const DtEntityType &s)
 
virtual const DtStringdisplayDescription () const
 Accessor/mutator for myDisplayDescription. More...
 
virtual void setDisplayDescription (const DtString &s)
 
virtual const DtStringengagementRules () const
 Accessor/mutator for myEngagementRules. More...
 
virtual void setEngagementRules (const DtString &engagementRules)
 
virtual const
DtSimResourceManager
resourceManager () const
 Accessor/mutator for myResourceManager. More...
 
virtual void setResourceManager (const DtSimResourceManager &resourceManager)
 
virtual void setStateRepositoryUserExtensionType (const DtString &type)
 Accessor/mutator for myStateRepositoryUserExtensionType. More...
 
virtual const DtStringstateRepositoryUserExtensionType () const
 
virtual DtObjectType objectType () const
 Accessor/mutator for myObjectType. More...
 
virtual void setObjectType (const DtObjectType &objectType)
 
virtual DtObjectType matchType () const
 Accessor/mutator for myMatchType. More...
 
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). More...
 
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) More...
 
virtual double rangeRingPublisherTickTime () const
 
void setParameterType (const DtString &)
 Sets/gets type of parameter. More...
 
const DtStringparameterType () const
 
virtual void setStateRepositoryUserExtension (const DtVrfStateRepositoryUserExtension &userExtension)
 State repository user extension data (extensible at the base class DtVrfObjectStateRepository). More...
 
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. More...
 
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 DtAutoConnectionsListPtrautoConnections ()
 
virtual const std::list
< DtSimArtPartDescriptor * > * 
configuredArtPartList () const
 
virtual const std::list
< DtSimArtPartDescriptor * > * 
componentDefaultArtPartList () const
 
virtual void connectSystems ()
 Creates entity-level connections between systems based on sysdef metadata. More...
 
bool operator== (const DtVrfObjectParameters &) const
 Equality operator. Simply compares the contents of the registry. More...
 
bool operator!= (const DtVrfObjectParameters &) const
 
virtual DtEnvironmentSP xmlEnvironment ()
 
virtual DtEnvValueSP objectNode ()
 
virtual const DtReaderWriterfindVariableBinding (const DtString &) const
 Find a variable binding from the original items in getSelf. Only valid if getSelf was called for this object. More...
 
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) More...
 
virtual const DtRwPropertiesparameterData () const
 Return parameter data accessor. More...
 
virtual DtRwPropertiesparameterData ()
 
virtual const DtRwPropertiesstateData () const
 Return state data. More...
 
virtual DtRwPropertiesstateData ()
 
virtual void setPublishParameterData (bool)
 Set to true if the parameter data is to be published in the extended data portion of the object. More...
 
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. More...
 
virtual bool canMoveOntoEmbarked () const
 
virtual void rebuildArtPartList ()
 Clears out and rebuilds the articulated part list. More...
 
virtual void updatePartOverridesFromActuator (DtSimArtPartDescriptor &artPartDescriptor, const DtComponentDescriptor &actuatorDescriptor, const DtString &systemName=DtString::nullString())
 Some older actuator descriptors may contain settings that override the art part settings. More...
 
virtual const
DtComponentSystemDescriptorList
systemDescriptorList () const
 See mySystemDescriptorList. More...
 
virtual
DtComponentSystemDescriptorList
systemDescriptorList ()
 
virtual void setSystemDescriptorList (const DtComponentSystemDescriptorList &list)
 
virtual const DtRwBoolean deadReckoningAllowGuiOverrides () const
 Accessor/mutator for myDeadReckoningAllowGuiOverrides. More...
 
virtual void setDeadReckoningAllowGuiOverrides (bool allow)
 
virtual const
DtRadioDescriptorList
radioDescriptorList () const
 See myRadioDescriptorList. More...
 
virtual DtRadioDescriptorListradioDescriptorList ()
 
virtual const DtSimSectorinitialSectorOfResponsibility () const
 
virtual void setInitialSectorOfResponsibility (const DtSimSector &sor)
 
virtual DtTaskExecutionRulestaskExecutionRules ()
 
virtual const
DtTaskExecutionRules
taskExecutionRules () const
 
virtual void setTaskExecutionRulesFilename (const DtFilename &)
 
virtual const DtReaderWriterFiletaskExecutionRulesFilename () const
 
virtual void setHlaFomClass (const DtString &)
 
virtual const DtStringhlaFomClass () const
 
virtual void setArtPartList (const DtSimArtPartDescriptorList &partList)
 
virtual const
DtSimArtPartDescriptorList
artPartList () 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 DtReaderWriteroperator= (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 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 aliasContaineraliases () 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 charreaderWriterType () const
 Used to supply a string type that this reader writer type is. More...
 
virtual const charxmlType () 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 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 DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified. More...
 
virtual DtReaderWriterdefaultRWValue ()
 
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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object. More...
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () 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 DtVrfObjectParameterscreator (DtEnvironmentSP env, DtEnvValueSP *objectNode)
 
- Static Public Member Functions inherited from DtVrfObjectParameters
static DtVrfObjectParameterscreateParameters (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL)
 
static DtVrfObjectParameterscreateParameters (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 DtVrfObjectParameterscreator (DtEnvironmentSP env, DtEnvValueSP *objectNode)
 
- 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 chartheXmlType ()
 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 DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 Given a filename, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 Given a xml string, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromEnvironment (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...
 

Protected Member Functions

 DtGlobalEnvironmentParameters (const DtGlobalEnvironmentParameters &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor. Use clone instead... More...
 
 DtGlobalEnvironmentParameters (const DtGlobalEnvironmentParameters &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. More...
 
 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(). More...
 
virtual
DtVrfSubObjectParameterList
createAttachedObjectsList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry) const
 Returns a newly created instance of a DtVrfObjectSubComponentTypes, which gets assigned ot myAttachedObjects in init(). More...
 
virtual void addArtPartsFromSystem (DtComponentSystemDescriptor *systemDesc, std::list< DtSimArtPartDescriptor * > &artPartList, std::set< DtArtPartType > &partTypesAdded)
 Adds any art parts defined within a system to the list. More...
 
virtual void createAutomaticConnections (DtRwAutoConnection *autoConnection)
 
virtual void addArtPartDescriptorProcessor (const DtString &componentType, const ArtPartDescriptorProcessor &fcn)
 Adds a special function for processing additional art part information from a component descriptor. More...
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter. More...
 

Protected Attributes

parameters

These parameters are available for setting in the OPD files.

{@ Parameter Name: send-repository-update-when-time-changed-by-seconds
Parameter Description: Amount of time (in seconds) at which to publish the global environment when simulation date/time has changed. Default is 1 second

DtRwReal mySendUpdateWhenTimeChangesBy
 
- Protected Attributes inherited from DtVrfObjectParameters
DtObjectType myMatchType
 An extended form of the DIS/RPR FOM entity enumerated type. More...
 
DtObjectType myObjectType
 
DtTaskExecutionRules myTaskExecutionRules
 Task execution rules. More...
 
DtString myParameterType
 String that keeps the type of parameter this is Local only – not part of descriptor. More...
 
std::list
< DtSimArtPartDescriptor * > 
myConfiguredArtPartList
 A list containing all the art part descriptors for parts that will be available to the entity. More...
 
std::list
< DtSimArtPartDescriptor * > 
myComponentDefaultArtPartList
 A list containing all the art part descriptor default settings from attached actuators. More...
 
DtEnvValueSP myObjectNode
 
DtEnvironmentSP myEnvironment
 
DtAutoConnectionsListPtr myAutoConnections
 
DtRwProperties myParameterData
 Properties that are specific to this parameter as read from the OPE file. More...
 
DtRwProperties myStateData
 Properties that will be added to the state repository of this particular entity. More...
 
DtRwReal myRangeRingPublisherTickTime
 The tick time of the range ring "publisher" for range ring parameter and state data. More...
 
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. More...
 
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) More...
 
DtRwString myDisplayName
 Parameter Name: display-name
Parameter Description: Name to display to user in Simulation Object Editor Parameter Units: Parameter Default Value: More...
 
DtRwString myDisplayDescription
 Parameter Name: display-description
Parameter Description: Description of parameter to display in Simulation Object Editor Parameter Units: Parameter Default Value: More...
 
DtRwString myUiFilename
 Parameter Name: ui-filename
Parameter Description: name of the .ui file used to configure this entity in the Simulation Object Editor. More...
 
DtRwBoolean myCanCreateAsNew
 Parameter Name: can-create-as-new
Parameter Description: Only for Simulation Object Editor. More...
 
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. More...
 
DtRwString myHlaFomClass
 Parameter Name: hla-fom-class Parameter Description: Specifies the HLA FOM class to be published. More...
 
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: More...
 
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: More...
 
DtSimArtPartDescriptorList myArtPartList
 Parameter Name: art-parts
Parameter Description: List of configured articulated parts on this type of entity. More...
 
DtVariableBindingsList myGetSelfVariableBindings
 Local copy of variable bindings used to seed this parameter entry. More...
 
ArtPartDescProcMap myArtPartDescProcs
 
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). More...
 
DtRwBoundingVolume myBvol
 Parameter Name: bounding-volume Parameter Description: Specifies the bounding volume around an object. More...
 
DtVrfObjectSubComponentTypesmyLocalSubComponentTypes
 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. More...
 
DtVrfObjectSubComponentTypesmyRemoteSubComponentTypes
 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. More...
 
DtRwFormationType myFormationType
 Parameter Name: formation
Parameter Description: (Optional) One of the following: More...
 
DtRwAppearance myDefaultAppearance
 Parameter Name: default-appearance
Parameter Description: Unsigned int used to set default valus for the DIS/RPR appearance bits. More...
 
DtRwForceType myForceType
 Parameter Name: force-type Parameter Description: The force to which the object belongs. More...
 
DtRwString myCategory
 Parameter Name: category Parameter Description: The category string to use when creating an echelon ID. More...
 
DtRwString myEchelonLevel
 Parameter Name: echelon-level Parameter Description: The echelon level to use for this entity when creating an echelon ID. More...
 
DtRwBoolean myOrganized
 Parameter Name: is-organized Parameter Description: Specifies that the entity is part of the entity hierarchy and requires an echelon ID. More...
 
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. More...
 
DtRwReal myMinTickPeriodVariance
 Parameter Name: min-tick-period-variance Parameter Description: Specifies an amount within which the min-tick-period can vary. More...
 
DtRwDeadReckonTypes myDeadReckoningAlgorithm
 Parameter Name: dr-algorithm Parameter Description: The VR-Link dead-reckoning algorithm to use when publishing this entity. More...
 
DtRwNavigationParameters myNavigationParameters
 
DtRwDeadReckonThresholds myDeadReckoningThresholds
 Parameter Name: dr-thresholds Parameter Description: The translation, rotation, and aggregate dimension thresholds used when publishing this entity. More...
 
DtRwBoolean myDeadReckoningAllowGuiOverrides
 
DtRadioDescriptorList myRadioDescriptorList
 Parameter Name: radios Parameter Description: List of all radios on the entity. More...
 
DtComponentSystemDescriptorList mySystemDescriptorList
 Parameter Name: systems Parameter Description: List of system descriptors. More...
 
DtComponentDescriptorList mySensorDescriptorList
 Parameter Name: sensors Parameter Description: List of sensor controller component descriptors. More...
 
DtComponentDescriptorList myControllerDescriptorList
 Parameter Name: controllers Parameter Description: List of controller component descriptors. More...
 
DtComponentDescriptorList myActuatorDescriptorList
 Parameter Name: actuators Parameter Description: List of actuator component descriptors. More...
 
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). More...
 
DtRwReal myMass
 Parameter Name: mass Parameter Description: The mass of the entity. More...
 
DtRwSensorSignatureList mySensorSignatureList
 Parameter Name: sensor-signatures Parameter Description: Parameter Default Value: More...
 
DtVrfSubObjectParameterListmySubordinateObjects
 Parameter Name: subordinate-objects
Parameter Description: (Optional) List of entries specifying subordinate objects to be created as part of an aggregate object. More...
 
DtVrfSubObjectParameterListmyAttachedObjects
 Parameter Name: attached-objects
Parameter Description:
Parameter Default Value:
. More...
 
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. More...
 
DtSimResourceManager myResourceManager
 Parameter Name: resources Parameter Description: Specifies the types and amount of resources the entity has. More...
 
DtRwString myStateRepositoryUserExtensionType
 Parameter Name: state-repository-extension-type
Parameter Description: Type of state repository extensions class to instantiate. More...
 
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. More...
 
DtVrfStateRepositoryUserExtensionmyStateRepositoryUserExtension
 Parameter Name: user-extension
Parameter Description: Extension to the state repository class. More...
 
DtRwTime myUnderFireTime
 Parameter Name: under-fire-time
Parameter Description: Deprecated. More...
 
DtRwReal myUnderFireDistance
 Parameter Name: under-fire-distance
Parameter Description: Deprecated. More...
 
DtSimSector myInitialSectorOfResponsibility
 Parameter Name: initial-sector-of-responsibility
Parameter Description: The sector of responsibility for this entity when the entity is first created. More...
 
DtReaderWriterFile myTaskExecutionRulesFilename
 Parameter Name: task-execution-rules Parameter Description: The name of the file that contains the task execution rules for this entity. More...
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object. More...
 
bool myInvalid
 Set to true if there is a problem reading this item. More...
 
bool myChangedFlag
 Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...
 

Additional Inherited Members

- Public Types inherited from DtVrfObjectParameters
typedef DtRwTemplatedListPtr
< DtRwAutoConnection, true > 
DtAutoConnectionsListPtr
 
- 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::vector< DtFilename > SearchPaths
 
typedef std::pair
< DtSymbolString, DtString
DtVariableNameType
 
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
 
- Protected Types inherited from DtVrfObjectParameters
typedef void(* ArtPartDescriptorProcessor )(const DtComponentDescriptor &compDesc, DtSimArtPartDescriptor &artPartDesc)
 
typedef std::map< DtString,
ArtPartDescriptorProcessor
ArtPartDescProcMap
 
- Static Protected Member Functions inherited from DtVrfObjectParameters
static void artPartWeaponDescriptorProcessor (const DtComponentDescriptor &compDesc, DtSimArtPartDescriptor &artPartDesc)
 
static void artPartHumanGunDescriptorProcessor (const DtComponentDescriptor &compDesc, DtSimArtPartDescriptor &artPartDesc)
 
static void artPartBallisticGunDescriptorProcessor (const DtComponentDescriptor &compDesc, DtSimArtPartDescriptor &artPartDesc)
 
static void artPartAzimuthMountDescriptorProcessor (const DtComponentDescriptor &compDesc, DtSimArtPartDescriptor &artPartDesc)
 
static void artPartElevationMountDescriptorProcessor (const DtComponentDescriptor &compDesc, DtSimArtPartDescriptor &artPartDesc)
 
static void artPartTurretDescriptorProcessor (const DtComponentDescriptor &compDesc, DtSimArtPartDescriptor &artPartDesc)
 
static void artPartSensorGimbalDescriptorProcessor (const DtComponentDescriptor &compDesc, DtSimArtPartDescriptor &artPartDesc)
 
static void artPartSwingingPartDescriptorProcessor (const DtComponentDescriptor &compDesc, DtSimArtPartDescriptor &artPartDesc)
 
static void artPartTranslatablePartDescriptorProcessor (const DtComponentDescriptor &compDesc, DtSimArtPartDescriptor &artPartDesc)
 
- Static Protected Attributes inherited from DtVrfObjectParameters
static
DtVrfObjectParameterFactory
theFactory
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Constructor & Destructor Documentation

DtGlobalEnvironmentParameters::DtGlobalEnvironmentParameters ( const DtString name = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = NULL,
DtEnvironmentSP  env = DtEnvironmentSP(),
DtEnvValueSP *  objectNode = NULL 
)

constructor with parameters to set up read/writability correctly

DtGlobalEnvironmentParameters::DtGlobalEnvironmentParameters ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL,
DtEnvironmentSP  env = DtEnvironmentSP(),
DtEnvValueSP *  objectNode = NULL 
)
virtual DtGlobalEnvironmentParameters::~DtGlobalEnvironmentParameters ( )
virtual

destructor

DtGlobalEnvironmentParameters::DtGlobalEnvironmentParameters ( const DtGlobalEnvironmentParameters orig,
const DtString name = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = NULL 
)
protected

copy constructor. Use clone instead...

DtGlobalEnvironmentParameters::DtGlobalEnvironmentParameters ( const DtGlobalEnvironmentParameters orig,
const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
)
protected

Member Function Documentation

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

assignment operator

virtual DtVrfObjectParameters* DtGlobalEnvironmentParameters::clone ( const DtString name = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = NULL 
) const
virtual

Reimplemented from DtVrfObjectParameters.

virtual DtVrfObjectParameters* DtGlobalEnvironmentParameters::clone ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const
virtual

Reimplemented from DtVrfObjectParameters.

virtual DtString DtGlobalEnvironmentParameters::type ( ) const
virtual

Should return the type of object this is a parameter block for.

Use the strings in vrfParamTypes.h.

Reimplemented from DtVrfObjectParameters.

static DtVrfObjectParameters* DtGlobalEnvironmentParameters::creator ( DtEnvironmentSP  env,
DtEnvValueSP *  objectNode 
)
static

Returns
Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.
virtual void DtGlobalEnvironmentParameters::sendUpdateWhenTimeChangesBy ( double  )
virtual
virtual double DtGlobalEnvironmentParameters::updateWhenTimeChangesBy ( ) const
virtual

Member Data Documentation

DtRwReal DtGlobalEnvironmentParameters::mySendUpdateWhenTimeChangesBy
protected

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)