DtVrfObject Class Reference

DtVrfObject is used to represent any type of simulated object (entities, aggregate, control objects) in a VR-Forces application. More...

Inheritance diagram for DtVrfObject:

Public Types
typedef std::list < DtLuaScriptInterfaceExtension::CreatorUserPair >	ScriptInterfaceExtensions
typedef std::pair < DtVrfObjectCallbackFunction, void * >	DtVrfObjectCallbackDataPair
	Definitions of container types used in the postInitFromParameters callback mechansim.
typedef std::pair< DtVrfObject *, DtVrfObjectCallbackDataPair >	DtVrfObjectCallbackDataPair2
	Definitions of container types used in the postInitFromParameters callback mechansim.
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 )()

Public Member Functions
	DtVrfObject (const DtObjectType &objectType, DtVrfObjectManager *vrfObjectManager, bool createLocalObject=true, bool publishLocalObject=true, const DtEntityIdentifier &objectIdentifier=DtEntityIdentifier::nullId(), const DtGlobalObjectDesignator *globalId=0, DtReflectedObject *reflectedObject=0, const DtString &objectName=DtString::nullString(), const DtString &objectLabel=DtString::nullString(), DtForceType forceType=DtForceOther, const DtList *vertices=0, const DtTaitBryan *orientation=0, bool projection=false, bool closedFigure=false, const DtAppearance &appearance=DtAppearance::nullAppearance(), const DtString &readerWriterName="vrf-object", DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtVrfObject ()
	destructor
virtual bool	create ()
	Virtual construction - must be called before any other member functions are called.
virtual void	createCommunicationsInterface ()
	Allows an external process to invoke creation of a communications interface, if myCommunicationInterface is NULL.
virtual void	createCommunicationsInterface (const DtRadioDescriptorList &descList)
	Allows an external process to invoke creation of a communications interface, if myCommunicationInterface is NULL, and pass a radio descriptor list.
virtual void	createSetDataManager ()
	Allows an external process to invoke creation of a DtSetDataManager, if mySetDataManager is NULL.
virtual int	vrfSessionId () const
	Return the session id of this object.
virtual bool	init ()
	Initialization - must be called after create() and before any other member functions are called.
virtual void	preprocess ()
	Called by create().
virtual void	tick ()
	Ticks object's organization manager, task manager, and component manager, and then calls down to base class tick.
virtual bool	createRepository (DtVrfObjectParameters *parameterEntry)
	Override createRepository() to check if repository created in base class version is a DtSimVrfObjectBaseStateRepository (or a derived type).
virtual bool	createTaskManager ()
virtual bool	createScriptInterfaceHandler ()
virtual bool	createComponentManager ()
virtual bool	createVrfObjectPlanManager ()
	Creates myVrfObjectPlanManager based on the type specified in mySubComponentTypes.
virtual bool	createRadio ()
virtual double	illumination () const
	How illuminated this object is.
virtual DtVrfObject *	weather () const
	Returns the weather object last calculated when the illumination was updated.
virtual MAKVRinTerra::DtFeatureGeometry	featureGeometry () const
	Compute DtFeatureGeometry representation of object geometry.
virtual void	updateIllumination ()
	Updates illumination value by providing local position to environmnt manager to calculate illumination value.
virtual void	updateWeather ()
	Updates weather object at the entities location.
virtual void	setRangeRingsParametersPublisherTickRange (double d)
	Sets the tick rate for updating range rings. Default is 5 seconds plus a random value (set in the range ring publisher)
virtual void	createAndInitializeRangeRingsParameterPublisher ()
	Creates range ring publisher and sets tick rate to 5 seconds plus a random value (set in the range ring publisher)
virtual bool	needsIlluminationUpdate ()
	Returns true if the entity has moved more than half a degree since (either in lat or lon) the last time the illumination was checked or the calculation time has changed.
virtual bool	needsWeatherAreaUpdate ()
	Returns true if the entity has moved more than half a degree since (either in lat or lon) the last time the illumination was checked or the calculation time has changed for weather.
virtual const DtSimManager *	simManager () const
	Get a pointer to our sim manager.
virtual DtSimManager *	simManager ()
virtual DtSimTaskManager *	taskManager () const
	Get pointers to our various types of subcomponents.
virtual DtScriptInterfaceHandler *	scriptInterfaceHandler () const
virtual DtSimComponentManager *	componentManager () const
virtual DtVrfObjectPlanManager *	vrfObjectPlanManager () const
virtual DtSimRadio *	radio () const
virtual DtVrfObjectStateRepository *	vrfState () const
virtual DtExtent	extent () const
	Returns the extent of the vrfObject, if the vrfObject has one.
virtual void	expandExtent (DtExtent &extent) const
	If the vrfObject has geometry, and thus an extent, then this function expands the specified extent to include the vrfObjects extent.
virtual void	sendVrfObjectCreated (unsigned long requestId=0, bool requestCreated=true)
	Create and send a DtVrfObjectCreated message about ourself.
virtual void	setupFromMessageContent (DtIfModifyVrfObject *ifModVrfObject)
	Setup self from interface messages.
virtual bool	isVrfSimulatedObject ()
	Returns true if object is being simulated by a VR-Forces-simulated object, false if not.
virtual void	setIsVrfSimulatedObject (bool b)
virtual bool	isSimulatingComponents () const
	returns true if object is simulating components VR-Forces components can be attached to non- VR-Forces entities.
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=true, const DtFilename &path=DtReaderWriter::appPath())
	Override to write out <use-default> string for unspecified parameters.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Override to do additional setup required when reading older oob, ovl files.
virtual bool	setObjectName (const DtString &name, bool rename=true)
	Override to inform the vrfObjectManager when the name changes.
virtual void	addNameAlias (const DtString &name)
	Adds a new string which can be used to reference this object by name.
virtual void	unregisterAliases ()
	Unregisters all aliases with object manager and removes the aliases from the local alias list.
virtual void	addVrfObjectChangedCallback (DtVrfObjectCallbackFunction function, void *userData)
	WARNING: These methods are obsolete but have been retained for backward compatibility.
virtual void	removeVrfObjectChangedCallback (DtVrfObjectCallbackFunction function, void *userData)
virtual void	addVrfObjectPredicateCallback (DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
	Add/remove a callback function to be invoked when the DtVrfObject predicate object associated with it returns true().
virtual void	removeVrfObjectPredicateCallback (DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
virtual int	predicateCallbackCount () const
	For testing.
virtual void	invokeVrfObjectPredicateCallbacks ()
	Called each tick.
virtual void	setCoordinateSystem (const Coordinate_System *coordinateSystem)
	Sets the coordinate system in mySimState (a DtVrfObjectStateRepository) and in myOvlVertices.
virtual const DtVrfObjectManager *	simObjectManager () const
virtual DtVrfObjectManager *	simObjectManager ()
virtual void	setSimObjectManager (DtVrfObjectManager *simObjectManager)
virtual bool	createNetInterface ()
virtual void	setGlobalId (const DtGlobalObjectDesignator &id)
	Set/get the entity's global Id.
virtual const DtGlobalObjectDesignator &	globalId () const
virtual bool	baseSetObjectName (const DtString &name)
	Set/get the name of the object.
virtual const DtString &	objectName () const
virtual const DtString &	objectLabel () const
	Set/get the label of the object.
virtual void	setObjectLabel (const DtString &objectLabel)
virtual const DtString &	overlayParent () const
	Set/get the overlay parent of the object.
virtual void	setOverlayParent (const DtString &overlayParent)
virtual DtStateRepository *	netState ()
	VR-Link network state repository.
virtual const DtStateRepository *	netState () const
virtual DtSimObjectNetInterface *	netInterface ()
	VR-Forces network interface.
virtual const DtSimObjectNetInterface *	netInterface () const
virtual void	setNetInterface (DtSimObjectNetInterface *netInterface)
virtual void	setObjectIdentifier (const DtEntityIdentifier &objectId)
	Set/get the object identifier (DIS/RPR site:host:entity).
virtual const DtEntityIdentifier &	objectIdentifier () const
virtual bool	isLocal () const
	Returns true if object is local (has the same simulation address as the manager), false if not.
virtual DtString	type () const
	set by factory on creation
virtual DtString	objectClassType () const
virtual void	setObjectClassType (const DtString &objectClassType)
	same as type()
virtual void	clearVerticesChangedCallbacks ()
	Clear out vertices changed callback list.
virtual void	clearRelativeVerticesChangedCallbacks ()
	Clear out relative vertices changed callback list.
virtual void	clearPredicateCallbacks ()
	Clear out object predicate callback list.
virtual void	processObjectAboutToBeRemoved (DtVrfObject *)
virtual DtSimObjectStateRepository *	simState ()
virtual const DtSimObjectStateRepository *	simState () const
virtual void	setSimState (DtVrfObjectStateRepository *simState)
void	setEntityType (const DtEntityType &entityType)
const DtEntityType &	entityType () const
void	setDestroyed (bool destroyed)
bool	isDestroyed () const
virtual void	place (const DtVector &location, bool *dataAvailable=0, bool requireAllData=false)
	place entity at 'location', on the ground, keeping its current heading
virtual void	place (const DtReal heading, bool *dataAvailable=0, bool requireAllData=false)
	give entity the specified 'heading', but stay at its current location
virtual void	place (const DtVector &location, const DtReal heading, bool *dataAvailable=0, bool requireAllData=false)
	place entity at specified 'location' and 'heading' on the ground
const DtString &	echelonIdString () const
virtual DtVrfObject *	leadEntity () const
virtual const DtString &	firstSubordinate () const
virtual const DtString &	lastSubordinate () const
virtual const DtString &	firstHealthySubordinate () const
	Returns first healthy subordinate if it exists, 0 if not.
virtual void	echelonIdChanged ()
virtual const DtObjectId &	objectId () const
virtual const DtObjectType &	objectType () const
virtual bool	isEmbarked () const
virtual bool	isEmbarkedOn (const DtString &parent) const
DtAttachedTerrain *	terrainAttachedTo ()
const DtAttachedTerrain *	terrainAttachedTo () const
virtual const DtPhysicalWorld *	physicalWorld () const
virtual DtPhysicalWorld *	physicalWorld ()
void	setAboutToBeRemoved (bool)
	Set to true when object is about to be removed.
bool	aboutToBeRemoved () const
virtual DtSetDataManager *	setDataManager ()
virtual const DtSetDataManager *	setDataManager () const
virtual DtVrfObjectCommunicationInterface *	communicationInterface ()
virtual DtVrfObjectTerrainPreloadManager *	terrainPreloadManager ()
DtVrfObjectSubComponentTypes *	vrfSubComponentTypes () const
	For use in virtual construction.
virtual bool	hasPlan () const
virtual bool	executingPlan () const
virtual bool	isCurrentlyTasked () const
virtual DtU8	getNextEmitterSystemId ()
virtual void	addScriptExtension (DtLuaScriptInterfaceExtension::CreatorFcn extension, void *usr)
	Add a lua script extension for this entity only.
virtual void	removeScriptExtension (DtLuaScriptInterfaceExtension::CreatorFcn extension, void *usr)
	Remove a lua script extension that was previously added.
virtual const ScriptInterfaceExtensions &	scriptExtensions () const
virtual DtVrfUnderwaterAcoustics *	underwaterAcoustics ()
	Accesses acoustics publisher. Use to set sonar or propulstion noise.
virtual DtVrfObjectDeletionHandle	objectDeletionHandle ()
virtual void	addPreprocessor (DtPreprocessor *simObject)
	Maintain set of preprocessor instances.
virtual void	removePreprocessor (DtPreprocessor *simObject)
virtual void	addVerticesChangedCallback (DtVrfObjectCallbackFunction function, void *userData)
	Adds/removes a callback to be invoked whenever an object's local vertices change.
virtual void	removeVerticesChangedCallback (DtVrfObjectCallbackFunction function, void *userData)
	Adds/removes a callback to be invoked whenever an object's local vertices change.
virtual void	addRelativeVerticesChangedCallback (DtVrfObjectCallbackFunction function, void *userData)
	Adds/removes a callback to be invoked whenever an object's relative vertices change.
virtual void	removeRelativeVerticesChangedCallback (DtVrfObjectCallbackFunction function, void *userData)
	Adds/removes a callback to be invoked whenever an object's relative vertices change.
virtual void	setPublishObject (bool publishObject)
	Set/get flag indicating whether or not object should be published.
virtual bool	publishObject () const
	Set/get flag indicating whether or not object should be published.
virtual DtOutputStream &	objectConsoleDebug () const
virtual DtOutputStream &	objectConsoleVerbose () const
virtual DtOutputStream &	objectConsoleInfo () const
virtual DtOutputStream &	objectConsoleWarn () const
virtual DtOutputStream &	objectConsoleError () const
virtual DtObjectConsole *	objectConsole ()
	Returns a pointer to the object console member of this object.
virtual const DtObjectConsole *	objectConsole () const
	Returns a pointer to the object console member of this object.
virtual void	addPostInitFromParamsCallback (DtVrfObjectCallbackFunction fcn, void *usr)
	Add/remove callback function to be invoked immediately following the point at which the newly created object gets initialized from its parameter entry.
virtual void	removePostInitFromParamsCallback (DtVrfObjectCallbackFunction fcn, void *usr)
	Add/remove callback function to be invoked immediately following the point at which the newly created object gets initialized from its parameter entry.
virtual void	addObjectAboutToBeRemovedCallback (DtVrfObjectCallbackList::DtCallbackFunctionType fcn, void *usr)
	Callback that is invoked when the entity is about to be removed from the simulation.
virtual void	removeObjectAboutToBeRemovedCallback (DtVrfObjectCallbackList::DtCallbackFunctionType fcn, void *usr)
	Callback that is invoked when the entity is about to be removed from the simulation.
virtual void	invokeVrfObjectAboutToBeRemovedCallbacks ()
	Callback that is invoked when the entity is about to be removed from the simulation.
virtual void	addNewSensorContactCallback (DtVrfObjectCallbackList::DtCallbackFunctionType fcn, void *usr)
	Callback that is invoked when the entity detects a new sensor contact or when a sensor contact's CID level is increased.
virtual void	removeNewSensorContactCallback (DtVrfObjectCallbackList::DtCallbackFunctionType fcn, void *usr)
	Callback that is invoked when the entity detects a new sensor contact or when a sensor contact's CID level is increased.
virtual void	invokeNewSensorContactCallbacks ()
	Callback that is invoked when the entity detects a new sensor contact or when a sensor contact's CID level is increased.
virtual void	addSetLocationCompleteCallback (DtVrfObjectCallbackList::DtCallbackFunctionType fcn, void *usr)
	Callback that is invoked when a set location request is completed.
virtual void	removeSetLocationCompleteCallback (DtVrfObjectCallbackList::DtCallbackFunctionType fcn, void *usr)
	Callback that is invoked when a set location request is completed.
virtual void	invokeSetLocationCompleteCallbacks ()
	Callback that is invoked when a set location request is completed.
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	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	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
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 (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal 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 void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual 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)
	The variable name, if this object is a variable reference.
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 ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
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 ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
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 &)
	Restires 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 void	addSimObjectCreatorFcn (const DtString &type, DtSimObjectCreatorFcn fcn)
static void	objectAboutToBeRemoved (DtVrfObject *msg, void *usr)
static DtSimObjectFactory *	factory ()
	a DtSimObjectFactory is allocated by the DtSimCreator, and this pointer is set.
static void	setFactory (DtSimObjectFactory *factory)
static void	setDefaultNotifyLevel (DtNotifyLevelType level)
	Sets the notify level for all object consoles.
static DtNotifyLevelType	defaultNotifyLevel ()
static DtVrfObject *	creator (const DtObjectType &objectType, DtVrfObjectManager *simObjectManager, bool createLocalObject=true, bool publishLocalObject=true, const DtEntityIdentifier &objectIdentifier=DtEntityIdentifier::nullId(), const DtGlobalObjectDesignator *globalId=0, DtReflectedObject *reflectedObject=0, const DtString &objectName=DtString::nullString(), const DtString &objectLabel=DtString::nullString(), DtForceType forceType=DtForceOther, const DtList *vertices=0, const DtTaitBryan *orientation=0, bool projection=false, bool closedFigure=false, const DtAppearance &appearance=DtAppearance::nullAppearance(), const DtString &readerWriterName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Returns a newly created DtVrfObject.
static DtVrfObject *	createObject (const DtObjectType &objectType, DtVrfObjectManager *vrfObjectManager, const DtString &classType, bool createLocalObject=true, bool publishLocalObject=true, const DtEntityIdentifier &objectIdentifier=DtEntityIdentifier::nullId(), const DtGlobalObjectDesignator *globalId=0, DtReflectedObject *reflectedObject=0, const DtString &objectName=DtString::nullString(), const DtString &objectLabel=DtString::nullString(), DtForceType forceType=DtForceOther, const DtList *vertices=0, const DtTaitBryan *orientation=0, bool projection=false, bool closedFigure=false, const DtAppearance &appearance=DtAppearance::nullAppearance(), const DtString &readerWriterName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Create and initialize a new sim object, using the factory.
static DtVrfObject *	createObject (const DtObjectType &objectType, DtVrfObjectManager *vrfObjectManager, const DtString &classType, bool createLocalObject=true, bool publishLocalObject=true, const DtEntityIdentifier &objectIdentifier=DtEntityIdentifier::nullId(), const DtGlobalObjectDesignator *globalId=0, DtReflectedObject *reflectedObject=0, const DtString &objectName=DtString::nullString(), const DtString &objectLabel=DtString::nullString(), DtForceType forceType=DtForceOther, const DtVector &location=DtVector::zero(), const DtTaitBryan *orientation=0, bool projection=false, bool closedFigure=false, const DtAppearance &appearance=DtAppearance::nullAppearance(), const DtString &readerWriterName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Create and initialize a new sim object, using the factory.
static DtVrfObject *	createAndInit (DtVrfObjectManager *vrfObjectManager, DtlObjPtr mtlStream)
	Create and initialize a new sim object from a mtl stream.
static void	verticesChangedCallback (DtVrfObject *obj, DtVrfObjectPredicateEvaluator *predicateEval, void *userData)
	Invokes all vertices-changed callbacks that have registered with the object.
static void	relativeVerticesChangedCallback (DtVrfObject *obj, DtVrfObjectPredicateEvaluator *predicateEval, void *userData)
	Invokes all relative-vertices-changed callbacks.
static void	postInitFromParamsCallback (DtVrfObjectStateRepository &stateRepository, void *usr)
	Callback function registered with object's state repository.
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const 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 DtReaderWriter *	createFromXmlFile (const DtFilename &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	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.
Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()
Static Public Member Functions inherited from DtObjectDebugger< DtVrfObject >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

Protected Member Functions
	DtVrfObject ()
	Abstract base classes should not be constructed.
	DtVrfObject (const DtVrfObject &orig)
	copy constructor
DtVrfObject &	operator= (const DtVrfObject &orig)
	assignment operator
virtual void	setupStateRepository ()
	Called by init() after state repository's init() has been called.
virtual void	setupNetInterface ()
	Called by init() after net interface's init() has been called.
void	emptyVertexList ()
	Non virtual utility function - called in destructor.
void	copyVertexList (const DtList &orig)
	Non-virtual utility function called in constructor.
virtual void	validateObjectType ()
	Validates the object type to make sure there are no -1s in the object type.
virtual void	processPostInitFromParamsCallback (DtVrfObjectCallbackFunction fcn, void *usr)
	Invokes callback added through a call to addPostInitFromParamsCallback.
virtual void	initializeCommunicationInterfaceCallbacks ()
	Adds admin content callback registration.
virtual void	processSetOverlayLayerTask (const DtVrfObjectMessage *msg)
virtual void	updateBoundingVolumeBasedOnPosture ()
	Based on the entities current posture, update bounding geometry based on whether or not the entity is standing, prone or kneeling.
virtual DtExtent	computeExtent () const
	Compute the extent, not lazy.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()
Protected Member Functions inherited from DtObjectDebugger< DtVrfObject >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Static Protected Member Functions
static void	setOverlayLayerTaskCallback (const DtVrfObjectMessage *msg, void *usr)

Protected Attributes
DtSequentialPreprocessorContainer	myPreprocessedObjects
	Container of DtSimComponents in this entity which implement DtPreprocessor::preprocess.
DtExtent	myExtent
bool	myExtentInvalid
	lazy per-tick cache of extent
DtRwString	myObjectClassType
DtEntityIdentifier	myObjectIdentifier
DtRwObjectType	myObjectType
	passed in to constructor, held for SR construction
DtRwString	myObjectName
DtRwString	myObjectLabel
DtRwString	myOverlayParent
DtGlobalObjectDesignator	myGlobalId
DtVrfObjectManager *	mySimObjectManager
DtVrfObjectStateRepository *	mySimState
DtSimObjectNetInterface *	myNetInterface
DtRwBoolean	myPublishObject
bool	myCreateLocalObject
	isLocal() used to check simulation address against object identifier to see if this was a local object, but myCreateLocalObject should already contain this information
bool	myIsVrfSimulatedObject
	Returns true if this is a vrf simulated object.
DtReflectedObject *	myReflectedObject
	Passed into constructor - held only to pass into create() function for virtual construction.
DtForceType	myForceType
DtList	myVertices
DtTaitBryan	myOrientation
bool	myProjection
bool	myClosedFigure
DtAppearance	myAppearance
DtVrfObjectSubComponentTypes *	mySubComponentTypes
	Used in create().
DtSimManager *	mySimManager
DtSimTaskManager *	myTaskManager
DtScriptInterfaceHandler *	myScriptInterfaceHandler
DtSimRadio *	myRadio
DtSimComponentManager *	myComponentManager
DtVrfObjectPlanManager *	myVrfObjectPlanManager
DtLocalVertexList	myOvlVertices
	The following member data are backward compatible reading of ovl files No accessors/mutators provided.
DtRwVector	myOvlTargetLocation
DtRwVector	myOvlStartPoint
DtRwVector	myOvlEndPoint
DtObstacleAreaCompatilibility	myOvlObstacleArea
DtRwBoolean	myOvlObstacleIsBreached
DtList	myPredicateCallbackList
	List of predicate function callbacks.
DtVrfObjectCallbackList	myVerticesChangedCallbackList
	List of DtSimObjectCallbackFunction's, to be invoked when the object's position changes.
DtList	myRelativeVerticesChangedCallbackList
	List of DtSimObjectCallbackFunction's, to be invoked when the object's relative position changes.
DtVrfObjectCallbackList	myAboutToBeRemovedCallbackList
DtVrfObjectCallbackList	mySetLocationCompleteCallbackList
DtVrfObjectCallbackList	myNewSensorContactCallbackList
DtList	myNameAliasList
DtVrfUnderwaterAcoustics *	myVrfUnderwaterAcoustics
bool	myAboutToBeRemoved
	Set to true if this object is about to be removed from the object manager list.
DtObjectConsole *	myObjectConsole
DtSetDataManager *	mySetDataManager
DtVrfObjectCommunicationInterface *	myCommunicationInterface
DtU8	myNextEmitterSystemId
DtVrfObjectTerrainPreloadManager *	myTerrainPreloadManager
ScriptInterfaceExtensions	myScriptInterfaceExtensions
DtRangeRingsParametersPublisher *	myRangeRingsParametersPublisher
	This object will manage range rings from state and parameter data.
DtVrfObjectParameters *	myParameterEntry
DtMovingObjectParameters *	myMovingObject
double	myIlluminationValue
double	myLastTimeIlluminationCalculated
double	myLastTimeWeatherAreaCalculated
DtGeodeticCoord	myLastIlluminationPosition
DtVrfObject *	myWeatherObject
	The weather object retrieved the last time illumination was calculated.
DtVrfObjectDeletionHandle	myObjectDeletionHandle
bool	myUseDayNightIlluminationModel
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Static Protected Attributes
static DtSimObjectFactory *	theFactory
static int	theDefaultNotifyLevel
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
virtual void	processReadDRThresholdSettings (const DtSettingsObject *settings)
	Callback function registered with the DtVrfSimSettings class.
static void	readDRThresholdSettingsCallback (const DtSettingsObject *settings, void *usr)
	Callback function registered with the DtVrfSimSettings class.

Detailed Description

DtVrfObject is used to represent any type of simulated object (entities, aggregate, control objects) in a VR-Forces application.

It has the following elements:

• state repository
• network interface
• radio (used to send/receive tasks, set data requests, reports)
• component manager (set of sensors, controllers, actuators for simulating behaviors)
• task manager (handles skip task requests, manages assumption of tasks by from one entity to another)
• organization manager (echelon organization)

Most Back End Examples can be explored for reference.

Member Typedef Documentation

typedef std::pair<DtVrfObjectCallbackFunction, void*> DtVrfObject::DtVrfObjectCallbackDataPair

Definitions of container types used in the postInitFromParameters callback mechansim.

typedef std::pair<DtVrfObject*, DtVrfObjectCallbackDataPair> DtVrfObject::DtVrfObjectCallbackDataPair2

Definitions of container types used in the postInitFromParameters callback mechansim.

typedef std::list<DtLuaScriptInterfaceExtension::CreatorUserPair> DtVrfObject::ScriptInterfaceExtensions

Constructor & Destructor Documentation

DtVrfObject::DtVrfObject ( )

protected

Abstract base classes should not be constructed.

DtVrfObject::DtVrfObject	(	const DtObjectType &	objectType,
		DtVrfObjectManager *	vrfObjectManager,
		bool	createLocalObject = true,
		bool	publishLocalObject = true,
		const DtEntityIdentifier &	objectIdentifier = DtEntityIdentifier::nullId(),
		const DtGlobalObjectDesignator *	globalId = 0,
		DtReflectedObject *	reflectedObject = 0,
		const DtString &	objectName = DtString::nullString(),
		const DtString &	objectLabel = DtString::nullString(),
		DtForceType	forceType = DtForceOther,
		const DtList *	vertices = 0,
		const DtTaitBryan *	orientation = 0,
		bool	projection = false,
		bool	closedFigure = false,
		const DtAppearance &	appearance = DtAppearance::nullAppearance(),
		const DtString &	readerWriterName = "vrf-object",
		DtReaderWriterRegistry *	parentRegistry = 0
	)

virtual DtVrfObject::~DtVrfObject ( )

virtual

destructor

DtVrfObject::DtVrfObject ( const DtVrfObject &  orig )

protected

copy constructor

Member Function Documentation

virtual bool DtVrfObject::create ( )

virtual

Virtual construction - must be called before any other member functions are called.

virtual void DtVrfObject::createCommunicationsInterface ( )

virtual

Allows an external process to invoke creation of a communications interface, if myCommunicationInterface is NULL.

virtual void DtVrfObject::createCommunicationsInterface ( const DtRadioDescriptorList &  descList )

virtual

Allows an external process to invoke creation of a communications interface, if myCommunicationInterface is NULL, and pass a radio descriptor list.

virtual void DtVrfObject::createSetDataManager ( )

virtual

Allows an external process to invoke creation of a DtSetDataManager, if mySetDataManager is NULL.

virtual int DtVrfObject::vrfSessionId ( ) const

virtual

Return the session id of this object.

This will need to be sure the netState is of a VRF type and it can return the session id

virtual bool DtVrfObject::init ( )

virtual

Initialization - must be called after create() and before any other member functions are called.

virtual void DtVrfObject::preprocess ( )

virtual

Called by create().

Pre-compute costly values in advance of tick using parallel threads.

Implements DtPreprocessor.

virtual void DtVrfObject::tick ( )

virtual

Ticks object's organization manager, task manager, and component manager, and then calls down to base class tick.

Calls invokeVrfObjectPredicateCallbacks.

virtual bool DtVrfObject::createRepository ( DtVrfObjectParameters *  parameterEntry )

virtual

Override createRepository() to check if repository created in base class version is a DtSimVrfObjectBaseStateRepository (or a derived type).

If it is, returns true, if not Returns false.

virtual bool DtVrfObject::createTaskManager ( )

virtual

virtual bool DtVrfObject::createScriptInterfaceHandler ( )

virtual

virtual bool DtVrfObject::createComponentManager ( )

virtual

virtual bool DtVrfObject::createVrfObjectPlanManager ( )

virtual

Creates myVrfObjectPlanManager based on the type specified in mySubComponentTypes.

virtual bool DtVrfObject::createRadio ( )

virtual

virtual double DtVrfObject::illumination ( ) const

virtual

How illuminated this object is.

Calculated from position and date/time to given sun/moon position. Calculated so often as defined in the moving object parameter

virtual DtVrfObject* DtVrfObject::weather ( ) const

virtual

Returns the weather object last calculated when the illumination was updated.

virtual MAKVRinTerra::DtFeatureGeometry DtVrfObject::featureGeometry ( ) const

virtual

Compute DtFeatureGeometry representation of object geometry.

virtual void DtVrfObject::updateIllumination ( )

virtual

Updates illumination value by providing local position to environmnt manager to calculate illumination value.

virtual void DtVrfObject::updateWeather ( )

virtual

Updates weather object at the entities location.

virtual void DtVrfObject::setRangeRingsParametersPublisherTickRange ( double  d )

virtual

Sets the tick rate for updating range rings. Default is 5 seconds plus a random value (set in the range ring publisher)

virtual void DtVrfObject::createAndInitializeRangeRingsParameterPublisher ( )

virtual

Creates range ring publisher and sets tick rate to 5 seconds plus a random value (set in the range ring publisher)

virtual bool DtVrfObject::needsIlluminationUpdate ( )

virtual

Returns true if the entity has moved more than half a degree since (either in lat or lon) the last time the illumination was checked or the calculation time has changed.

virtual bool DtVrfObject::needsWeatherAreaUpdate ( )

virtual

Returns true if the entity has moved more than half a degree since (either in lat or lon) the last time the illumination was checked or the calculation time has changed for weather.

If illumination update is needed this will update weather as wel

virtual const DtSimManager* DtVrfObject::simManager ( ) const

virtual

Get a pointer to our sim manager.

virtual DtSimManager* DtVrfObject::simManager ( )

virtual

virtual DtSimTaskManager* DtVrfObject::taskManager ( ) const

virtual

Get pointers to our various types of subcomponents.

virtual DtScriptInterfaceHandler* DtVrfObject::scriptInterfaceHandler ( ) const

virtual

virtual DtSimComponentManager* DtVrfObject::componentManager ( ) const

virtual

virtual DtVrfObjectPlanManager* DtVrfObject::vrfObjectPlanManager ( ) const

virtual

virtual DtSimRadio* DtVrfObject::radio ( ) const

virtual

virtual DtVrfObjectStateRepository* DtVrfObject::vrfState ( ) const

virtual

virtual DtExtent DtVrfObject::extent ( ) const

virtual

Returns the extent of the vrfObject, if the vrfObject has one.

If the vrfObject does not have an extent, and uninitialized extent is returned.

Implementation Detail: The extent is determined by transforming the vrfObjects local bounding volume to it's current location/orientation and then fitting an axis-aligned extent around the resulting world bounding volume.

virtual void DtVrfObject::expandExtent ( DtExtent &  extent ) const

virtual

If the vrfObject has geometry, and thus an extent, then this function expands the specified extent to include the vrfObjects extent.

See the DtSsExtentIntersector for more information on why this function is necessary.

virtual void DtVrfObject::sendVrfObjectCreated ( unsigned long  requestId = 0, bool  requestCreated = true  )

virtual

Create and send a DtVrfObjectCreated message about ourself.

requestId is the requestId to be used in the message (request Ids are used to link a DtIfVrfCreated message to a DtCreateVrfObject message).

virtual void DtVrfObject::setupFromMessageContent ( DtIfModifyVrfObject *  ifModVrfObject )

virtual

Setup self from interface messages.

virtual bool DtVrfObject::isVrfSimulatedObject ( )

virtual

Returns true if object is being simulated by a VR-Forces-simulated object, false if not.

virtual void DtVrfObject::setIsVrfSimulatedObject ( bool  b )

virtual

virtual bool DtVrfObject::isSimulatingComponents ( ) const

virtual

returns true if object is simulating components VR-Forces components can be attached to non- VR-Forces entities.

In that case a call to isLocal() will be false, and a call to isVrfSimulatedObject() might be true. Neither will indicate if the components are being simulated on this back end. Method isSimulatingComponents() will interrogate the component manager. The presence of components in the component manager indicates that this back end is responsible for handling ride-along attachment.

virtual void DtVrfObject::putSelf ( FILE *  fp, int  indentLevel = 0, bool  writeUnspecified = true, const DtFilename &  path = DtReaderWriter::appPath()  )

virtual

Override to write out <use-default> string for unspecified parameters.

Reimplemented from DtReaderWriter.

virtual void DtVrfObject::getSelf ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

virtual

Override to do additional setup required when reading older oob, ovl files.

virtual bool DtVrfObject::setObjectName ( const DtString &  name, bool  rename = true  )

virtual

Override to inform the vrfObjectManager when the name changes.

Returns true if successful. Names which are too long may cause a failure, see baseSetObjectName(). If the baseSetObjectName() fails and rename is true, this function generates the next standard name for the object, calls baseSetObjectName with that name and then returns false. If rename is false when the set name fails, the name is left unchanged and the function returns false.

virtual void DtVrfObject::addNameAlias ( const DtString &  name )

virtual

Adds a new string which can be used to reference this object by name.

The object will register the alias with the ObjectManager.

virtual void DtVrfObject::unregisterAliases ( )

virtual

Unregisters all aliases with object manager and removes the aliases from the local alias list.

virtual void DtVrfObject::addVrfObjectChangedCallback ( DtVrfObjectCallbackFunction  function, void *  userData  )

virtual

WARNING: These methods are obsolete but have been retained for backward compatibility.

These methods may be removed in a future release. If you are testing for changes in an object's vertices, then the methods addVerticesChangedCallback and removeVerticesChangedCallback should be used instead. These methods are now equivalent to the {add/remove}VerticesChangedCallback functions. If you need to check for changes to the object other than/in addition to changes to vertices, then define your own DtVrfObjectPredicate function, and register a callback associated with that predicate object using the addVrfObjectPredicateCallback function.

Register/remove a callback function to be invoked when the object changes.

virtual void DtVrfObject::removeVrfObjectChangedCallback ( DtVrfObjectCallbackFunction  function, void *  userData  )

virtual

virtual void DtVrfObject::addVerticesChangedCallback ( DtVrfObjectCallbackFunction  function, void *  userData  )

virtual

Adds/removes a callback to be invoked whenever an object's local vertices change.

If an object is attached to another object, this callback will be called for every movement of the parent object. If you desire callbacks invoked only on modification of the geometry, use addRelativeVerticesChangedCallback().

virtual void DtVrfObject::removeVerticesChangedCallback ( DtVrfObjectCallbackFunction  function, void *  userData  )

virtual

Adds/removes a callback to be invoked whenever an object's local vertices change.

If an object is attached to another object, this callback will be called for every movement of the parent object. If you desire callbacks invoked only on modification of the geometry, use addRelativeVerticesChangedCallback().

virtual void DtVrfObject::addRelativeVerticesChangedCallback ( DtVrfObjectCallbackFunction  function, void *  userData  )

virtual

Adds/removes a callback to be invoked whenever an object's relative vertices change.

I.e: A route attached to a moving object will have its local vertices changing, but not it's relative vertices.

virtual void DtVrfObject::removeRelativeVerticesChangedCallback ( DtVrfObjectCallbackFunction  function, void *  userData  )

virtual

Adds/removes a callback to be invoked whenever an object's relative vertices change.

I.e: A route attached to a moving object will have its local vertices changing, but not it's relative vertices.

virtual void DtVrfObject::addVrfObjectPredicateCallback ( DtVrfObjectPredicateCallbackFunction  function, const DtVrfObjectPredicate &  predicate, DtTime  evaluationPeriod = 0, void *  userData = 0  )

virtual

Add/remove a callback function to be invoked when the DtVrfObject predicate object associated with it returns true().

virtual void DtVrfObject::removeVrfObjectPredicateCallback ( DtVrfObjectPredicateCallbackFunction  function, const DtVrfObjectPredicate &  predicate, DtTime  evaluationPeriod = 0, void *  userData = 0  )

virtual

virtual int DtVrfObject::predicateCallbackCount ( ) const

virtual

For testing.

Returns the number of predicate callbacks registered with this object.

virtual void DtVrfObject::invokeVrfObjectPredicateCallbacks ( )

virtual

Called each tick.

Iterates through myPredicateCallbackList, calling the predicate object's isTrue() function. If it time to test the predicate (isTimeToTest()) and the predicate's isTrue() function returns true, it invokes the associated callback function.

virtual void DtVrfObject::setCoordinateSystem ( const Coordinate_System *  coordinateSystem )

virtual

Sets the coordinate system in mySimState (a DtVrfObjectStateRepository) and in myOvlVertices.

virtual const DtVrfObjectManager* DtVrfObject::simObjectManager ( ) const

virtual

virtual DtVrfObjectManager* DtVrfObject::simObjectManager ( )

virtual

virtual void DtVrfObject::setSimObjectManager ( DtVrfObjectManager *  simObjectManager )

virtual

virtual bool DtVrfObject::createNetInterface ( )

virtual

virtual void DtVrfObject::setGlobalId ( const DtGlobalObjectDesignator &  id )

virtual

Set/get the entity's global Id.

The global Id can be used to uniquely identify an entity across all other applications/federates. Under HLA/RPR, DtGlobalObjectDesignator is typdef'd to a DtString, and under DIS, it is typedef'd to a DtObjectId.

virtual const DtGlobalObjectDesignator& DtVrfObject::globalId ( ) const

virtual

virtual bool DtVrfObject::baseSetObjectName ( const DtString &  name )

virtual

Set/get the name of the object.

Returns true if the name set was successful. Since there are length restrictions on the name (depending on the type of net interface and protocol being used) name setting may fail.

virtual const DtString& DtVrfObject::objectName ( ) const

virtual

virtual const DtString& DtVrfObject::objectLabel ( ) const

virtual

Set/get the label of the object.

virtual void DtVrfObject::setObjectLabel ( const DtString &  objectLabel )

virtual

virtual const DtString& DtVrfObject::overlayParent ( ) const

virtual

Set/get the overlay parent of the object.

virtual void DtVrfObject::setOverlayParent ( const DtString &  overlayParent )

virtual

virtual DtStateRepository* DtVrfObject::netState ( )

virtual

VR-Link network state repository.

virtual const DtStateRepository* DtVrfObject::netState ( ) const

virtual

virtual DtSimObjectNetInterface* DtVrfObject::netInterface ( )

virtual

VR-Forces network interface.

virtual const DtSimObjectNetInterface* DtVrfObject::netInterface ( ) const

virtual

virtual void DtVrfObject::setNetInterface ( DtSimObjectNetInterface *  netInterface )

virtual

virtual void DtVrfObject::setObjectIdentifier ( const DtEntityIdentifier &  objectId )

virtual

Set/get the object identifier (DIS/RPR site:host:entity).

virtual const DtEntityIdentifier& DtVrfObject::objectIdentifier ( ) const

virtual

virtual bool DtVrfObject::isLocal ( ) const

virtual

Returns true if object is local (has the same simulation address as the manager), false if not.

virtual void DtVrfObject::setPublishObject ( bool  publishObject )

virtual

Set/get flag indicating whether or not object should be published.

Note

This will not cause the object to become or stop publishing after the object has been created.

virtual bool DtVrfObject::publishObject ( ) const

virtual

Set/get flag indicating whether or not object should be published.

Note

This will not cause the object to become or stop publishing after the object has been created.

virtual DtString DtVrfObject::type ( ) const

virtual

set by factory on creation

virtual DtString DtVrfObject::objectClassType ( ) const

virtual

virtual void DtVrfObject::setObjectClassType ( const DtString &  objectClassType )

virtual

same as type()

virtual void DtVrfObject::clearVerticesChangedCallbacks ( )

virtual

Clear out vertices changed callback list.

Should only be called by the DtVrfObjectManager, upon queuing object for removal and deletion.

virtual void DtVrfObject::clearRelativeVerticesChangedCallbacks ( )

virtual

Clear out relative vertices changed callback list.

Should only be called by the DtVrfObjectManager, upon queuing object for removal and deletion.

virtual void DtVrfObject::clearPredicateCallbacks ( )

virtual

Clear out object predicate callback list.

Should only be called by the DtVrfObjectManager, upon queuing object for removal and deletion.

static void DtVrfObject::addSimObjectCreatorFcn ( const DtString &  type, DtSimObjectCreatorFcn  fcn  )

static

static void DtVrfObject::objectAboutToBeRemoved ( DtVrfObject *  msg, void *  usr  )

static

virtual void DtVrfObject::processObjectAboutToBeRemoved ( DtVrfObject *  )

virtual

static DtSimObjectFactory* DtVrfObject::factory ( )

static

a DtSimObjectFactory is allocated by the DtSimCreator, and this pointer is set.

The DtSimCreator deletes this pointer when it is deleted. This is done this way because we don't allow static initialization

Reimplemented from DtReaderWriter.

static void DtVrfObject::setFactory ( DtSimObjectFactory *  factory )

static

virtual DtSimObjectStateRepository* DtVrfObject::simState ( )

virtual

virtual const DtSimObjectStateRepository* DtVrfObject::simState ( ) const

virtual

virtual void DtVrfObject::setSimState ( DtVrfObjectStateRepository *  simState )

virtual

void DtVrfObject::setEntityType

(

const DtEntityType &

entityType

)

const DtEntityType& DtVrfObject::entityType

(

)

const

void DtVrfObject::setDestroyed

(

bool

destroyed

)

bool DtVrfObject::isDestroyed

(

)

const

virtual void DtVrfObject::place ( const DtVector &  location, bool *  dataAvailable = 0, bool  requireAllData = false  )

virtual

place entity at 'location', on the ground, keeping its current heading

Parameters

Input
location	new location for the entity
requireAllData	if true and dataAvailable is also specified this call will not make any changes to the entity unless all intersections have terrain data available.
Output
dataAvailable	prevents the call from blocking due to terrain paging and will get a true value if the terrain intersections are successful. See DtVrfMovingObjectStateRepository::clampToGround for more information.

virtual void DtVrfObject::place ( const DtReal  heading, bool *  dataAvailable = 0, bool  requireAllData = false  )

virtual

give entity the specified 'heading', but stay at its current location

Parameters

Input
heading	new heading for the entity
requireAllData	if true and dataAvailable is also specified this call will not make any changes to the entity unless all intersections have terrain data available.
Output
dataAvailable	prevents the call from blocking due to terrain paging and will get a true value if the terrain intersections are successful. See DtVrfMovingObjectStateRepository::clampToGround for more information.

virtual void DtVrfObject::place ( const DtVector &  location, const DtReal  heading, bool *  dataAvailable = 0, bool  requireAllData = false  )

virtual

place entity at specified 'location' and 'heading' on the ground

Parameters

Input
location	new location for the entity
heading	new heading for the entity
requireAllData	if true and dataAvailable is also specified this call will not make any changes to the entity unless all intersections have terrain data available.
Output
dataAvailable	prevents the call from blocking due to terrain paging and will get a true value if the terrain intersections are successful. See DtVrfMovingObjectStateRepository::clampToGround for more information.

const DtString& DtVrfObject::echelonIdString

(

)

const

virtual DtVrfObject* DtVrfObject::leadEntity ( ) const

virtual

virtual const DtString& DtVrfObject::firstSubordinate ( ) const

virtual

virtual const DtString& DtVrfObject::lastSubordinate ( ) const

virtual

virtual const DtString& DtVrfObject::firstHealthySubordinate ( ) const

virtual

Returns first healthy subordinate if it exists, 0 if not.

virtual void DtVrfObject::echelonIdChanged ( )

inlinevirtual

virtual const DtObjectId& DtVrfObject::objectId ( ) const

virtual

virtual const DtObjectType& DtVrfObject::objectType ( ) const

virtual

virtual bool DtVrfObject::isEmbarked ( ) const

virtual

Returns

True if the state repository has a parent attachment

virtual bool DtVrfObject::isEmbarkedOn ( const DtString &  parent ) const

virtual

Returns

True if this entity is embarked on the parent, or is embarked on something that is embarked on the parent

DtAttachedTerrain* DtVrfObject::terrainAttachedTo

(

)

const DtAttachedTerrain* DtVrfObject::terrainAttachedTo

(

)

const

virtual const DtPhysicalWorld* DtVrfObject::physicalWorld ( ) const

virtual

virtual DtPhysicalWorld* DtVrfObject::physicalWorld ( )

virtual

void DtVrfObject::setAboutToBeRemoved ( bool  b )

inline

Set to true when object is about to be removed.

References myAboutToBeRemoved.

bool DtVrfObject::aboutToBeRemoved ( ) const

inline

References myAboutToBeRemoved.

virtual DtOutputStream& DtVrfObject::objectConsoleDebug ( ) const

virtual

Returns

The stream that is routed to the object's console.

virtual DtOutputStream& DtVrfObject::objectConsoleVerbose ( ) const

virtual

Returns

The stream that is routed to the object's console.

virtual DtOutputStream& DtVrfObject::objectConsoleInfo ( ) const

virtual

Returns

The stream that is routed to the object's console.

virtual DtOutputStream& DtVrfObject::objectConsoleWarn ( ) const

virtual

Returns

The stream that is routed to the object's console.

virtual DtOutputStream& DtVrfObject::objectConsoleError ( ) const

virtual

Returns

The stream that is routed to the object's console.

virtual DtObjectConsole* DtVrfObject::objectConsole ( )

virtual

Returns a pointer to the object console member of this object.

virtual const DtObjectConsole* DtVrfObject::objectConsole ( ) const

virtual

Returns a pointer to the object console member of this object.

virtual DtSetDataManager* DtVrfObject::setDataManager ( )

virtual

Returns

The DtSetDataManager for this object. Any part of the object wishing notification of a set data request should register with this manager instead of registering directly with the radio. Any set data request can be invoked on the entity by passing it into this manager.

virtual const DtSetDataManager* DtVrfObject::setDataManager ( ) const

virtual

virtual DtVrfObjectCommunicationInterface* DtVrfObject::communicationInterface ( )

virtual

Returns

The DtVrfObjectCommunicationInterface for this object. This is the central point for all processing of messages to/from this object, whether they are though a radio or though the internal communication mechanism of VR-Forces.

virtual DtVrfObjectTerrainPreloadManager* DtVrfObject::terrainPreloadManager ( )

virtual

Returns

The terrain preload manager for this object. Use this to register providers which have data to help determine what parts of the terrain will be needed by this object in the near future.

DtVrfObjectSubComponentTypes* DtVrfObject::vrfSubComponentTypes

(

)

const

For use in virtual construction.

Casts mySubComponentTypes to derived type.

virtual bool DtVrfObject::hasPlan ( ) const

virtual

Returns

True if this object has a plan associated with it. Does not mean the entity is executing the plan. Use executingPlan() for this.

virtual bool DtVrfObject::executingPlan ( ) const

virtual

Returns

True if the object is currently executing it's plan.

virtual bool DtVrfObject::isCurrentlyTasked ( ) const

virtual

Returns

True if this object is currently tasked

virtual void DtVrfObject::addPostInitFromParamsCallback ( DtVrfObjectCallbackFunction  fcn, void *  usr  )

virtual

Add/remove callback function to be invoked immediately following the point at which the newly created object gets initialized from its parameter entry.

The call to add a callback must be called before DtVrfObject::init gets called.

virtual void DtVrfObject::removePostInitFromParamsCallback ( DtVrfObjectCallbackFunction  fcn, void *  usr  )

virtual

Add/remove callback function to be invoked immediately following the point at which the newly created object gets initialized from its parameter entry.

The call to add a callback must be called before DtVrfObject::init gets called.

virtual DtU8 DtVrfObject::getNextEmitterSystemId ( )

virtual

Returns

A new integer emitter system ID that has not been returned previously from this function, on an object-by-object basis. : This ID is not saved, so it will start from 0 after the scenario is loaded.

static void DtVrfObject::setDefaultNotifyLevel ( DtNotifyLevelType  level )

static

Sets the notify level for all object consoles.

static DtNotifyLevelType DtVrfObject::defaultNotifyLevel ( )

static

Returns

The current default notification level.

virtual void DtVrfObject::addScriptExtension ( DtLuaScriptInterfaceExtension::CreatorFcn  extension, void *  usr  )

virtual

Add a lua script extension for this entity only.

The creator function passed in will be called every time a lua environment is created for this entity.

virtual void DtVrfObject::removeScriptExtension ( DtLuaScriptInterfaceExtension::CreatorFcn  extension, void *  usr  )

virtual

Remove a lua script extension that was previously added.

virtual const ScriptInterfaceExtensions& DtVrfObject::scriptExtensions ( ) const

virtual

Returns

The current set of script extensions.

static DtVrfObject* DtVrfObject::creator ( const DtObjectType &  objectType, DtVrfObjectManager *  simObjectManager, bool  createLocalObject = true, bool  publishLocalObject = true, const DtEntityIdentifier &  objectIdentifier = DtEntityIdentifier::nullId(), const DtGlobalObjectDesignator *  globalId = 0, DtReflectedObject *  reflectedObject = 0, const DtString &  objectName = DtString::nullString(), const DtString &  objectLabel = DtString::nullString(), DtForceType  forceType = DtForceOther, const DtList *  vertices = 0, const DtTaitBryan *  orientation = 0, bool  projection = false, bool  closedFigure = false, const DtAppearance &  appearance = DtAppearance::nullAppearance(), const DtString &  readerWriterName = DtString::nullString(), DtReaderWriterRegistry *  parentRegistry = 0  )

static

Returns a newly created DtVrfObject.

This is the function that gets registered with the factory.

static DtVrfObject* DtVrfObject::createObject ( const DtObjectType &  objectType, DtVrfObjectManager *  vrfObjectManager, const DtString &  classType, bool  createLocalObject = true, bool  publishLocalObject = true, const DtEntityIdentifier &  objectIdentifier = DtEntityIdentifier::nullId(), const DtGlobalObjectDesignator *  globalId = 0, DtReflectedObject *  reflectedObject = 0, const DtString &  objectName = DtString::nullString(), const DtString &  objectLabel = DtString::nullString(), DtForceType  forceType = DtForceOther, const DtList *  vertices = 0, const DtTaitBryan *  orientation = 0, bool  projection = false, bool  closedFigure = false, const DtAppearance &  appearance = DtAppearance::nullAppearance(), const DtString &  readerWriterName = DtString::nullString(), DtReaderWriterRegistry *  parentRegistry = 0  )

static

Create and initialize a new sim object, using the factory.

static DtVrfObject* DtVrfObject::createObject ( const DtObjectType &  objectType, DtVrfObjectManager *  vrfObjectManager, const DtString &  classType, bool  createLocalObject = true, bool  publishLocalObject = true, const DtEntityIdentifier &  objectIdentifier = DtEntityIdentifier::nullId(), const DtGlobalObjectDesignator *  globalId = 0, DtReflectedObject *  reflectedObject = 0, const DtString &  objectName = DtString::nullString(), const DtString &  objectLabel = DtString::nullString(), DtForceType  forceType = DtForceOther, const DtVector &  location = DtVector::zero(), const DtTaitBryan *  orientation = 0, bool  projection = false, bool  closedFigure = false, const DtAppearance &  appearance = DtAppearance::nullAppearance(), const DtString &  readerWriterName = DtString::nullString(), DtReaderWriterRegistry *  parentRegistry = 0  )

static

Create and initialize a new sim object, using the factory.

static DtVrfObject* DtVrfObject::createAndInit ( DtVrfObjectManager *  vrfObjectManager, DtlObjPtr  mtlStream  )

static

Create and initialize a new sim object from a mtl stream.

static void DtVrfObject::verticesChangedCallback ( DtVrfObject *  obj, DtVrfObjectPredicateEvaluator *  predicateEval, void *  userData  )

static

Invokes all vertices-changed callbacks that have registered with the object.

Updates the predicate's (DtLclVerticesNotEqualPredicate) vertices.

static void DtVrfObject::relativeVerticesChangedCallback ( DtVrfObject *  obj, DtVrfObjectPredicateEvaluator *  predicateEval, void *  userData  )

static

Invokes all relative-vertices-changed callbacks.

static void DtVrfObject::postInitFromParamsCallback ( DtVrfObjectStateRepository &  stateRepository, void *  usr  )

static

Callback function registered with object's state repository.

Gets called immediately after DtVrfObjectStateRepository::initializeFromParameters gets called. Calls processPostInitFromParamsCallback.

static void DtVrfObject::readDRThresholdSettingsCallback ( const DtSettingsObject *  settings, void *  usr  )

static

Callback function registered with the DtVrfSimSettings class.

Called by DtVrfObject::init().

virtual void DtVrfObject::processReadDRThresholdSettings ( const DtSettingsObject *  settings )

virtual

Callback function registered with the DtVrfSimSettings class.

Called by DtVrfObject::init().

virtual void DtVrfObject::addObjectAboutToBeRemovedCallback ( DtVrfObjectCallbackList::DtCallbackFunctionType  fcn, void *  usr  )

virtual

Callback that is invoked when the entity is about to be removed from the simulation.

virtual void DtVrfObject::removeObjectAboutToBeRemovedCallback ( DtVrfObjectCallbackList::DtCallbackFunctionType  fcn, void *  usr  )

virtual

Callback that is invoked when the entity is about to be removed from the simulation.

virtual void DtVrfObject::invokeVrfObjectAboutToBeRemovedCallbacks ( )

virtual

Callback that is invoked when the entity is about to be removed from the simulation.

virtual void DtVrfObject::addNewSensorContactCallback ( DtVrfObjectCallbackList::DtCallbackFunctionType  fcn, void *  usr  )

virtual

Callback that is invoked when the entity detects a new sensor contact or when a sensor contact's CID level is increased.

virtual void DtVrfObject::removeNewSensorContactCallback ( DtVrfObjectCallbackList::DtCallbackFunctionType  fcn, void *  usr  )

virtual

Callback that is invoked when the entity detects a new sensor contact or when a sensor contact's CID level is increased.

virtual void DtVrfObject::invokeNewSensorContactCallbacks ( )

virtual

Callback that is invoked when the entity detects a new sensor contact or when a sensor contact's CID level is increased.

virtual void DtVrfObject::addSetLocationCompleteCallback ( DtVrfObjectCallbackList::DtCallbackFunctionType  fcn, void *  usr  )

virtual

Callback that is invoked when a set location request is completed.

virtual void DtVrfObject::removeSetLocationCompleteCallback ( DtVrfObjectCallbackList::DtCallbackFunctionType  fcn, void *  usr  )

virtual

Callback that is invoked when a set location request is completed.

virtual void DtVrfObject::invokeSetLocationCompleteCallbacks ( )

virtual

Callback that is invoked when a set location request is completed.

virtual DtVrfUnderwaterAcoustics* DtVrfObject::underwaterAcoustics ( )

virtual

Accesses acoustics publisher. Use to set sonar or propulstion noise.

virtual DtVrfObjectDeletionHandle DtVrfObject::objectDeletionHandle ( )

virtual

virtual void DtVrfObject::addPreprocessor ( DtPreprocessor *  simObject )

virtual

Maintain set of preprocessor instances.

virtual void DtVrfObject::removePreprocessor ( DtPreprocessor *  simObject )

virtual

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

protected

assignment operator

virtual void DtVrfObject::setupStateRepository ( )

protectedvirtual

Called by init() after state repository's init() has been called.

virtual void DtVrfObject::setupNetInterface ( )

protectedvirtual

Called by init() after net interface's init() has been called.

void DtVrfObject::emptyVertexList ( )

protected

Non virtual utility function - called in destructor.

void DtVrfObject::copyVertexList ( const DtList &  orig )

protected

Non-virtual utility function called in constructor.

virtual void DtVrfObject::validateObjectType ( )

protectedvirtual

Validates the object type to make sure there are no -1s in the object type.

If there are, it will change them to 0's

virtual void DtVrfObject::processPostInitFromParamsCallback ( DtVrfObjectCallbackFunction  fcn, void *  usr  )

protectedvirtual

Invokes callback added through a call to addPostInitFromParamsCallback.

virtual void DtVrfObject::initializeCommunicationInterfaceCallbacks ( )

protectedvirtual

Adds admin content callback registration.

Currently registers for DtSetOverlayLayerAdmin message

static void DtVrfObject::setOverlayLayerTaskCallback ( const DtVrfObjectMessage *  msg, void *  usr  )

staticprotected

virtual void DtVrfObject::processSetOverlayLayerTask ( const DtVrfObjectMessage *  msg )

protectedvirtual

virtual void DtVrfObject::updateBoundingVolumeBasedOnPosture ( )

protectedvirtual

Based on the entities current posture, update bounding geometry based on whether or not the entity is standing, prone or kneeling.

Calls down to human state repository to do the change

virtual DtExtent DtVrfObject::computeExtent ( ) const

protectedvirtual

Compute the extent, not lazy.

Member Data Documentation

DtSequentialPreprocessorContainer DtVrfObject::myPreprocessedObjects

protected

Container of DtSimComponents in this entity which implement DtPreprocessor::preprocess.

Their preprocess method will be executed sequentially in a single thread, in the order their init method is called (which should also be their load order). This permits controlling their order-of-execution so that intra-component dependencies within a single entity can be controlled.

DtExtent DtVrfObject::myExtent

mutableprotected

bool DtVrfObject::myExtentInvalid

mutableprotected

lazy per-tick cache of extent

DtRwString DtVrfObject::myObjectClassType

protected

DtSimObjectFactory* DtVrfObject::theFactory

staticprotected

DtEntityIdentifier DtVrfObject::myObjectIdentifier

protected

DtRwObjectType DtVrfObject::myObjectType

protected

passed in to constructor, held for SR construction

DtRwString DtVrfObject::myObjectName

protected

DtRwString DtVrfObject::myObjectLabel

protected

DtRwString DtVrfObject::myOverlayParent

protected

DtGlobalObjectDesignator DtVrfObject::myGlobalId

protected

DtVrfObjectManager* DtVrfObject::mySimObjectManager

protected

DtVrfObjectStateRepository* DtVrfObject::mySimState

protected

DtSimObjectNetInterface* DtVrfObject::myNetInterface

protected

DtRwBoolean DtVrfObject::myPublishObject

protected

bool DtVrfObject::myCreateLocalObject

protected

isLocal() used to check simulation address against object identifier to see if this was a local object, but myCreateLocalObject should already contain this information

bool DtVrfObject::myIsVrfSimulatedObject

protected

Returns true if this is a vrf simulated object.

Locally set to the same value as passed into constructor for createLocal

DtReflectedObject* DtVrfObject::myReflectedObject

protected

Passed into constructor - held only to pass into create() function for virtual construction.

DtForceType DtVrfObject::myForceType

protected

DtList DtVrfObject::myVertices

protected

DtTaitBryan DtVrfObject::myOrientation

protected

bool DtVrfObject::myProjection

protected

bool DtVrfObject::myClosedFigure

protected

DtAppearance DtVrfObject::myAppearance

protected

DtVrfObjectSubComponentTypes* DtVrfObject::mySubComponentTypes

protected

Used in create().

DtSimManager* DtVrfObject::mySimManager

protected

DtSimTaskManager* DtVrfObject::myTaskManager

protected

DtScriptInterfaceHandler* DtVrfObject::myScriptInterfaceHandler

protected

DtSimRadio* DtVrfObject::myRadio

protected

DtSimComponentManager* DtVrfObject::myComponentManager

protected

DtVrfObjectPlanManager* DtVrfObject::myVrfObjectPlanManager

protected

DtLocalVertexList DtVrfObject::myOvlVertices

protected

The following member data are backward compatible reading of ovl files No accessors/mutators provided.

They are just used in reading old ovl files.

DtRwVector DtVrfObject::myOvlTargetLocation

protected

DtRwVector DtVrfObject::myOvlStartPoint

protected

DtRwVector DtVrfObject::myOvlEndPoint

protected

DtObstacleAreaCompatilibility DtVrfObject::myOvlObstacleArea

protected

DtRwBoolean DtVrfObject::myOvlObstacleIsBreached

protected

DtList DtVrfObject::myPredicateCallbackList

protected

List of predicate function callbacks.

Users can register callbacks associated with a DtVrfObjectPredicate object. This class evaluates the isTrue() function associated with each predicate object. When isTrue() returns true, it invokes the callback function that it was registered with.

DtVrfObjectCallbackList DtVrfObject::myVerticesChangedCallbackList

protected

List of DtSimObjectCallbackFunction's, to be invoked when the object's position changes.

DtList DtVrfObject::myRelativeVerticesChangedCallbackList

protected

List of DtSimObjectCallbackFunction's, to be invoked when the object's relative position changes.

DtVrfObjectCallbackList DtVrfObject::myAboutToBeRemovedCallbackList

protected

DtVrfObjectCallbackList DtVrfObject::mySetLocationCompleteCallbackList

protected

DtVrfObjectCallbackList DtVrfObject::myNewSensorContactCallbackList

protected

DtList DtVrfObject::myNameAliasList

protected

DtVrfUnderwaterAcoustics* DtVrfObject::myVrfUnderwaterAcoustics

protected

bool DtVrfObject::myAboutToBeRemoved

protected

Set to true if this object is about to be removed from the object manager list.

Referenced by aboutToBeRemoved(), and setAboutToBeRemoved().

DtObjectConsole* DtVrfObject::myObjectConsole

protected

DtSetDataManager* DtVrfObject::mySetDataManager

protected

DtVrfObjectCommunicationInterface* DtVrfObject::myCommunicationInterface

protected

DtU8 DtVrfObject::myNextEmitterSystemId

protected

DtVrfObjectTerrainPreloadManager* DtVrfObject::myTerrainPreloadManager

protected

ScriptInterfaceExtensions DtVrfObject::myScriptInterfaceExtensions

protected

DtRangeRingsParametersPublisher* DtVrfObject::myRangeRingsParametersPublisher

protected

This object will manage range rings from state and parameter data.

DtVrfObjectParameters* DtVrfObject::myParameterEntry

protected

DtMovingObjectParameters* DtVrfObject::myMovingObject

protected

int DtVrfObject::theDefaultNotifyLevel

staticprotected

double DtVrfObject::myIlluminationValue

protected

double DtVrfObject::myLastTimeIlluminationCalculated

protected

double DtVrfObject::myLastTimeWeatherAreaCalculated

protected

DtGeodeticCoord DtVrfObject::myLastIlluminationPosition

protected

DtVrfObject* DtVrfObject::myWeatherObject

protected

The weather object retrieved the last time illumination was calculated.

DtVrfObjectDeletionHandle DtVrfObject::myObjectDeletionHandle

protected

bool DtVrfObject::myUseDayNightIlluminationModel

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfobjcore/vrfObject.h