makVrf::DtGuiThreadVrfRemoteController Class Reference

This class is a thread-safe API to the DtVrfRemoteController. More...

Inheritance diagram for makVrf::DtGuiThreadVrfRemoteController:

List of all members.

Public Member Functions
	DtGuiThreadVrfRemoteController (makVrv::DtDe &)
virtual	~DtGuiThreadVrfRemoteController ()
DtVrfBackendSettingsManager &	backendSettingsManager ()
	Use this manager to set or retrieve information about backend specific settings set by the DtSettingsObject.
DtVrfSimBackendManager &	backendManager ()
	Use this manager to retrieve information about the back-ends that are present in the system, including connecting to signals when back-ends are added or removed.
DtVrfSpotReportManager &	spotReportManager ()
	Use this manager to modify all information related to the spot report system.
DtVrfResourceManager &	resourceManager ()
	Use this manager to handle resource requests.
DtNetworkMessageCallbackManager &	messageHandler ()
	Use this manager to register callback messages.
virtual void	deleteObject (std::string name, DtSimulationAddress addr=DtSimSendToAll)
	Delete VR-Force's object by name This will work for any object published by the simulation engine, including entities, aggregates, control objects, and overlay objects.
virtual void	setTimeoutInterval (int)
	Sets how long the GUI should wait (milliseconds) for a back-end to time out without receiving a status message.
virtual void	requestDIGuyAppearancesAndAnimations (std::vector< DtString > name)
	Requests the DI-Guy Appearances and animations available for the DI-Guy character associated with this entity.
virtual void	requestResourcesFor (std::vector< std::string > names, DtSimulationAddress addr=DtSimSendToAll)
	Request the resource information from the simulation engine for a set of entities.
virtual void	sendMessageToObject (const DtVrfObjectMessage &, DtSimulationAddress addr=DtSimSendToAll)
	Send the object message to the specified object in the message.
virtual void	sendObjectMessageAndDeleteContent (DtVrfObjectMessage *message, DtSimulationAddress addr=DtSimSendToAll)
	Sends the message then deletes the message after it is sent.
virtual int	generateRequestId ()
	Generate a unique request id.
virtual void	addSetCreatorFcn (std::string, int, DtSetDataRequestCreatorFcn)
	Signal to register set creator.
virtual void	addTaskCreatorFcn (std::string, int, DtSimTaskCreatorFcn)
	Signal to register task creator.
virtual void	addInterfaceContentCreatorFcn (int t, DtInterfaceContentCreatorFcn)
	Signal sent to register an interface content message.
virtual void	addAdminContentCreatorFcn (std::string, int, DtAdminContentCreatorFcn)
	Signal to register admin content command creator.
virtual void	addConditionCreatorFcn (std::string, int, DtCondExprCreatorFcn)
	Signal to register condition creator.
virtual void	addReportCreatorFcn (std::string, int, DtSimReportCreatorFcn)
	Signal to register report creator.
virtual void	addObjectMessageCreatorFcn (int, DtVrfObjectMessageCreatorFcn)
	Signal to register object message creator.
virtual void	addSimulationCommandCreatorFcn (std::string, int, DtSimCommandCreatorFcn)
	Signal to register simulation command creator.
virtual void	sendMessage (const DtSimInterfaceContent &message, DtSimulationAddress addr=DtSimSendToAll)
	Signal send to send interface content message to specified back-end.
virtual void	sendMessageAndDeleteContent (DtSimInterfaceContent *message, DtSimulationAddress addr=DtSimSendToAll)
virtual void	embarkOn (const std::vector< std::string > &children, const std::string &parentName, bool useSlot=true, const DtVector &overridePosition=DtVector::zero(), DtSimulationAddress addr=DtSimSendToAll)
	These routines will send interface messages to tell the back-end to embark or disembark the specified objects.
virtual void	disembark (const std::vector< std::string > &children, DtSimulationAddress addr=DtSimSendToAll)
	Signal to disembark the specified object.
virtual void	disembarkAll (const std::vector< std::string > &parents, DtSimulationAddress addr=DtSimSendToAll)
	Signal to disembark all objects on the parent.
virtual void	attachTo (const std::vector< std::string > &ids, const std::string &parentName)
	Attaches all specified objects to specified parent name.
virtual void	detachAll (const std::vector< std::string > &ids)
	Sends overlay modify message to detach all the specified objects from their parents.
virtual void	logObjectConsoleToFile (const std::string &name, const std::string &filename)
	Tell the back-end to start (or stop if filename is blank) logging the console output for the specified entity.
virtual void	stopLoggingObjectConsoleToFile (const std::string &objectName)
	Stops any sim engine which is currently writing a log file for this object.
virtual void	setObjectNotifyLevel (const std::string &name, int)
	Sets the notify level on console messages for object.
virtual void	setTimeOfDay (int seconds)
	Sets the current scenario time of day past midnight. Time is in seconds.
virtual void	setAggregateOnCreate (bool)
	Sets whether or not that aggregates are aggregated or disaggregated on create. By default, false.
bool	aggregateOnCreate () const
virtual void	requestScenarioDescription (DtSimulationAddress)
	Requests scenario description.
virtual void	setScenarioDescription (const DtString &, DtSimulationAddress addr=DtSimSendToAll)
	Sets scenario description. Use DtSimSendToAll to make sure all back-ends get the description.
virtual void	sendLoggerSetFilename (std::string filename)
	Logger controls.
virtual void	sendLoggerRecordMessage ()
virtual void	sendLoggerStopMessage ()
Scenario Management
virtual void	newScenario (const DtScenario *, int startTimeOfDay=12 *3600)
	Create a new scenario using the specific scenario data provided, or at using the default scenario parameters on the specified terrain.
virtual void	newScenario (const DtFilename &terrainDatabase, int startTimeOfDay=12 *3600)
virtual void	loadScenario (const DtScenarioLoadInformation &)
	Loads scenario specified by DtScenario.
virtual bool	loadScenario (const DtFilename &)
virtual void	saveScenario (const DtScenario *, DtPreserveMappingsFcn fcn=0, void *userData=0)
	Save a scenario.
virtual void	closeScenario ()
	Close the current scenario.
Scenario Control
virtual void	runScenario (DtSimulationAddress addr=DtSimSendToAll)
	Put the scenario in run mode (start playing) if it is not already.
virtual void	pauseScenario (DtSimulationAddress addr=DtSimSendToAll)
	Pause the scenario execution.
virtual void	rewindScenario (DtSimulationAddress addr=DtSimSendToAll)
	Rewind the scenario to the last save state.
virtual void	exitServer (DtSimulationAddress addr=DtSimSendToAll)
	Cause simulation engine to quit.
virtual void	stepScenario (DtSimulationAddress addr=DtSimSendToAll)
	Advance simulation by a single time step.
Control and Overlay Object Creation
virtual void	createWaypoint (const DtVector &geocentricPosition, const std::string &uniqueName="", const std::string &label="", const DtSimulationAddress &addr=DtSimSendToAll, unsigned int requestId=0)
	Create a new waypoint.
virtual void	createWaypoint (DtVrfObjectCreatedCallbackFunction fcn, const DtVector &geocentricPosition, const std::string &uniqueName="", const std::string &label="", const DtSimulationAddress &addr=DtSimSendToAll)
	Create a new waypoint.
virtual void	modifyWaypoint (const std::string &uniqueId, std::string *uniqueName=0, std::string *label=0, DtVector *geocentricPosition=0, const DtSimulationAddress &addr=DtSimSendToAll)
	Modify the given waypoint.
virtual void	createRoute (const std::vector< DtVector > &vertices, const std::string &uniqueName="", const std::string &label="", const DtSimulationAddress &addr=DtSimSendToAll, unsigned int rId=0)
	Create a new route.
virtual void	createRoute (DtVrfObjectCreatedCallbackFunction fcn, const std::vector< DtVector > &vertices, const std::string &uniqueName="", const std::string &label="", const DtSimulationAddress &addr=DtSimSendToAll)
	Create a new route.
virtual void	modifyRoute (const std::string &uniqueId, std::string *uniqueName=0, std::string *label=0, std::vector< DtVector > *vertices=0, const DtSimulationAddress &addr=DtSimSendToAll)
	Modify the given route.
virtual void	createPhaseLine (const DtVector &dbPoint1, const DtVector &dbPoint2, const std::string &uniqueName="", const std::string &label="", const DtSimulationAddress &addr=DtSimSendToAll, unsigned int rId=0)
	Create a new phase line.
virtual void	createPhaseLine (DtVrfObjectCreatedCallbackFunction fcn, const DtVector &dbPoint1, const DtVector &dbPoint2, const std::string &uniqueName="", const std::string &label="", const DtSimulationAddress &addr=DtSimSendToAll)
	Create a new phase line.
virtual void	modifyPhaseLine (const std::string &uniqueId, std::string *uniqueName=0, std::string *label=0, DtVector *newDbPoint1=0, DtVector *newDbPoint2=0, const DtSimulationAddress &addr=DtSimSendToAll)
	Modify the given phase line.
virtual void	createControlArea (const std::vector< DtVector > &vertices, const std::string &uniqueName="", const std::string &label="", const DtSimulationAddress &addr=DtSimSendToAll, unsigned int rId=0)
	Create a new control area.
virtual void	createControlArea (DtVrfObjectCreatedCallbackFunction fcn, const std::vector< DtVector > &vertices, const std::string &uniqueName="", const std::string &label="", const DtSimulationAddress &addr=DtSimSendToAll)
	Create a new control area.
virtual void	modifyControlArea (const std::string &uniqueId, std::string *uniqueName=0, std::string *label=0, std::vector< DtVector > *newVertices=0, const DtSimulationAddress &addr=DtSimSendToAll)
	modify the given control area
virtual void	createObstacle (const std::vector< DtVector > &vertices, const std::string &uniqueName="", const std::string &label="", const DtSimulationAddress &addr=DtSimSendToAll, unsigned int rId=0)
	Create a new obstacle.
virtual void	createObstacle (DtVrfObjectCreatedCallbackFunction fcn, const std::vector< DtVector > &vertices, const std::string &uniqueName="", const std::string &label="", const DtSimulationAddress &addr=DtSimSendToAll)
	Create a new obstacle.
virtual void	modifyObstacle (const std::string &uniqueId, std::string *uniqueName=0, std::string *label=0, std::vector< DtVector > *newVertices=0, const DtSimulationAddress &addr=DtSimSendToAll)
	modify the given obstacle
virtual void	createDisaggregationArea (const std::vector< DtVector > &vertices, const std::string &uniqueName="", const std::string &label="", const DtSimulationAddress &addr=DtSimSendToAll, unsigned int rId=0)
	Create a new disaggregation area (triggers automatic disaggregation whenever an aggregate enters the area).
virtual void	createDisaggregationArea (DtVrfObjectCreatedCallbackFunction fcn, const std::vector< DtVector > &vertices, const std::string &uniqueName="", const std::string &label="", const DtSimulationAddress &addr=DtSimSendToAll)
	Create a new disaggregation area (triggers automatic disaggregation whenever an aggregate enters the area).
virtual void	modifyDisaggregationArea (const std::string &uniqueId, std::string *uniqueName=0, std::string *label=0, std::vector< DtVector > *newVertices=0, const DtSimulationAddress &addr=DtSimSendToAll)
	Modify given disaggregation area.
virtual void	createOverlayObject (const DtEntityType &type, const std::vector< DtVector > &vertices, const DtForceType &force, const std::string &name, const std::string &label, int color, const std::string &parentName, bool projection, bool closedFigure, const DtAppearance &appearance=DtAppearance::nullAppearance(), const std::string &attachTo="", char *userData=0, int dataSize=0, DtVrfObjectCreatedCallbackFunction fcn=0, const DtSimulationAddress &addr=DtSimSendToAll)
	Overlay objects are considered objects that both be used in a simulated environment (control objects as listed above) and objects that can be used to annotate a scenario as one might do with an overlay on an overhead projector.
virtual void	createIndirectFire (const DtIfIndirectArtilleryData &params, const DtSimulationAddress &addr)
	Create an indirect artillery area on the specified backend with the given parameters.
Entity and Aggregate Creation and Management
virtual void	createEntity (DtVrfObjectCreatedCallbackFunction fcn, DtSimulationAddress addr, DtEntityCreationData, const std::list< DtAdminContent * > &content=std::list< DtAdminContent * >(), const std::list< DtSimInterfaceContent * > &ifaceContent=std::list< DtSimInterfaceContent * >())
	Create entity based on creation data.
virtual void	createEntity (DtSimulationAddress addr, DtEntityCreationData, const std::list< DtAdminContent * > &content=std::list< DtAdminContent * >(), const std::list< DtSimInterfaceContent * > &ifaceContent=std::list< DtSimInterfaceContent * >())
	Create entity based on creation data.
virtual void	createEntity (const DtEntityType &type, const DtVector &geocentricPosition, DtForceType force, DtReal heading, const std::string &uniqueName="", const std::string &label="", const DtSimulationAddress &addr=DtSimSendToAll, bool groundClamp=true, const std::list< DtAdminContent * > &content=std::list< DtAdminContent * >(), const std::list< DtSimInterfaceContent * > &ifaceContent=std::list< DtSimInterfaceContent * >())
	Create a new entity.
virtual void	createEntity (DtVrfObjectCreatedCallbackFunction fcn, const DtEntityType &type, const DtVector &geocentricPosition, DtForceType force, DtReal heading, const std::string &uniqueName="", const std::string &label="", const DtSimulationAddress &addr=DtSimSendToAll, bool groundClamp=true, const std::list< DtAdminContent * > &content=std::list< DtAdminContent * >(), const std::list< DtSimInterfaceContent * > &ifaceContent=std::list< DtSimInterfaceContent * >())
	Create a new entity.
virtual void	createAggregate (DtVrfObjectCreatedCallbackFunction fcn, const DtEntityType &type, const DtVector &geocentricPosition, DtForceType force, DtReal heading, const std::string &uniqueName, const std::string &label="", const DtSimulationAddress &addr=DtSimSendToAll, DtAggregateState initialAggregateState=DtDisaggregated, const std::list< DtAdminContent * > &content=std::list< DtAdminContent * >(), const std::list< DtSimInterfaceContent * > &ifaceContent=std::list< DtSimInterfaceContent * >())
	Create a new aggregate.
virtual void	aggregateAs (const std::vector< makVrv::DtVrlinkSimulatedEntityState > &names, const DtEntityType &type, int force, DtAggregateState initialAggregateState, DtSimulationAddress addr, unsigned int requestId=0)
	Create an aggregate.
virtual void	aggregateAs (DtVrfObjectCreatedCallbackFunction fcn, const std::vector< makVrv::DtVrlinkSimulatedEntityState > &names, const DtEntityType &type, int force, DtAggregateState initialAggregateState, DtSimulationAddress addr)
	Create an aggregate.
virtual void	addToOrganization (const std::string &childId, const std::string &superiorId, DtSimulationAddress addr=DtSimSendToAll)
	Adds the specified object to as a subordinate to the specified superior.
virtual void	addToForceLevelOrganization (const std::string &entityId, DtSimulationAddress addr=DtSimSendToAll)
	Adds the specified object as a subordinate to the Force Level aggregate corresponding to the objects force type.
virtual void	removeFromOrganization (const std::string &objectId, const DtSimulationAddress &addr=DtSimSendToAll)
	Removes the specified object from whatever aggregate it is a part of and leaves it with no superior.
Advanced
These methods allow for some additional controls in creating and managing simulation objects. Most of the other creation methods result in a call to one of these advanced methods.
virtual void	createEnvironmentalObject (DtSimulationAddress addr, DtEntityType, int force, const std::vector< DtVector > &, const DtEnvironmentalCreationData &data=DtEnvironmentalCreationData())
	Generally create an environmental object.
virtual void	sendVrfObjectModifyMsg (const DtSimulationAddress &addr, const std::string &entityId, const std::string *name=0, const std::vector< DtVector > &=std::vector< DtVector >(), int *force=0, double *heading=0, const std::string *label=0, DtAppearance *appearance=0, const std::string *overlayParent=0, const std::string *userData=0)
	This function can be used to modify vrf objects that cannot be created using the more specific methods above.
virtual void	sendVrfObjectCreateMsg (const DtSimulationAddress &addr, unsigned int requestId, const std::string &name, const DtObjectType &type, const std::vector< DtVector > &vertices, const std::string &label, const DtAppearance &appearance, DtForceType force, bool projection, bool closedFigure, DtReal heading, bool createSubObjects, bool clampToGroundFlag=true, const std::string &initialFormation="", DtAggregateState initialAggregateState=DtDisaggregated, const std::string &userData="", const std::list< DtAdminContent * > &content=std::list< DtAdminContent * >(), const std::list< DtSimInterfaceContent * > &ifaceContent=std::list< DtSimInterfaceContent * >())
	This function can be used to create vrf objects that cannot be created using the more specific methods above.
virtual unsigned int	addCreateCallbackFunction (DtVrfObjectCreatedCallbackFunction)
	Adds a new create function callback and returns the request id that can be used to associate that callback to be invoked when the item is created.
virtual void	sendVrfOverlayObjectModifyMsg (const DtSimulationAddress &addr, const std::string &id, int *color=0, const std::string *parentName=0, const std::string *attachTo=0, const std::string *userData=0)
	This function is only used to modify information that is specific to an overlay object (waypoint, route, overlay objects, etc.)
virtual void	sendVrfIndirectFireObjectModifyMsg (const DtSimulationAddress &addr, const DtEntityIdentifier &id, const DtIfIndirectArtilleryData &mod)
	Modification message for given indirect artillery fire area.
Modify Existing Objects
These methods send DtSetDataRequest messages to the named object. Not all objects can will respond to all set requests. They must have a controller that responds to the message.
virtual void	setLabel (const std::string &id, const std::string &label, const DtSimulationAddress &addr=DtSimSendToAll)
	Change the label field of an object.
virtual void	setOverlayParent (const std::string &id, const std::string &label, const DtSimulationAddress &addr=DtSimSendToAll)
	Change which overlay an overlay graphic or entity is on.
virtual void	setAltitude (const std::string &name, double altitude, const DtSimulationAddress &addr=DtSimSendToAll)
	Set altitude (in meters)
virtual void	setLocation (const std::string &name, DtVector coord, const DtSimulationAddress &addr=DtSimSendToAll)
	Set location (geocentric coordinates)
virtual void	setAppearance (const std::string &name, int appearance, const DtSimulationAddress &addr=DtSimSendToAll)
	Set appearance of entity.
virtual void	setCapabilities (const std::string &name, int capabilities, const DtSimulationAddress &addr=DtSimSendToAll)
	Set capabilities of entity.
virtual void	setHeading (const std::string &name, double degrees, const DtSimulationAddress &addr=DtSimSendToAll)
	Set heading (in degrees)
virtual void	setForce (const std::string &name, DtForceType force, const DtSimulationAddress &addr=DtSimSendToAll)
	Change force type of an object.
virtual void	setResource (const std::string &name, const char *resourceType, double value, const DtSimulationAddress &addr=DtSimSendToAll)
	Set resource See resourceTypes.h for a list of pre-defined resource types that can be passed as the resourceType.
virtual void	setRulesOfEngagement (const std::string &name, const char *rulesType, const DtSimulationAddress &addr=DtSimSendToAll)
	Set rules of engagement.
virtual void	setSectorOfResponsibility (const std::string &name, double center, double size, const DtSimulationAddress &addr=DtSimSendToAll)
	Set sector of responsibility (center and size are in degrees)
virtual void	setSpeed (const std::string &name, double speed, const DtSimulationAddress &addr=DtSimSendToAll)
	Set ordered speed (in meters per second)
virtual void	setTarget (const std::string &name, const std::string &target, const DtSimulationAddress &addr=DtSimSendToAll)
	Set preferred weapons target.
virtual void	setTaskedBySuperior (const std::string &name, const DtSimulationAddress &addr=DtSimSendToAll)
	Set tasked by superior Causes entity to abandon its own tasking, and resume taking tasks from its superior, if it is part of an aggregate.
virtual void	setConcealed (const std::string &name, bool yes, const DtSimulationAddress &addr=DtSimSendToAll)
	Changes the concealed appearance bit for the entity.
virtual void	setEmitter (const std::string &name, int emitterId, bool on, const DtSimulationAddress &addr=DtSimSendToAll)
	Set a given emitter system on or off.
virtual void	setIff (const std::string &name, bool mode1on, int mode1code, bool mode2on, int mode2code, bool mode3on, int mode3code, bool mode4on, int mode4code, DtIffAtcNavaidsAltParm4 altParm4, bool mode5on, bool useAltMode5, bool modeSon, bool emergency, bool flash, bool sti, bool modeSTcasI, const DtSimulationAddress &addr=DtSimSendToAll)
	Set the IFF parameters for an entity with and IFF transponder.
virtual void	restore (const std::string &name, const DtSimulationAddress &addr=DtSimSendToAll)
	Restore to start state Entity will become healthy again (if damaged) and all resources are restored to initial state.
virtual void	setDestroyed (const std::string &name, const DtSimulationAddress &addr=DtSimSendToAll)
	Sets the damage state of the specified entity/aggregate to destroyed.
virtual void	setLifeformWeaponState (const std::string &name, DtWeaponState weapon, const DtSimulationAddress &addr=DtSimSendToAll)
	Set lifeform weapon.
virtual void	setLifeformPosture (const std::string &name, DtLifeformState posture, const DtSimulationAddress &addr=DtSimSendToAll)
	Set lifeform posture.
virtual void	setAggregateFormation (const std::string &leader, const std::string &formationName, const DtSimulationAddress &addr=DtSimSendToAll)
	Set an aggregate formation.
virtual void	reorganizeAggregate (const std::string &leader, const DtSimulationAddress &addr=DtSimSendToAll)
	Reorganize the aggregate.
virtual void	disaggregate (std::string name, DtSimulationAddress addr=DtSimSendToAll)
	Disaggregate the entity, resulting in its DtAggregateState to become DtDisaggregated, and simulation of its subordinates as distinct entities.
virtual void	aggregate (std::string name, DtSimulationAddress addr=DtSimSendToAll)
	Aggregate the entity, resulting in its DtAggregateState to become DtAggregated, with subordinates not simulated as distinct entities.
virtual void	setJoystickEnabled (std::string name, DtSimulationAddress addr=DtSimSendToAll)
	Sends signal set the joystick enabled for the specified entity.
virtual void	setJoystickDisabled (std::string name, DtSimulationAddress addr=DtSimSendToAll)
	Sends signal set the joystick disabled for the specified entity.
virtual void	sendSetDataMsg (const std::string &recipient, DtSetDataRequest *msg, const DtSimulationAddress &addr=DtSimSendToAll, bool updateScenario=true)
	General set data message.
virtual void	sendSetRequest (const DtSetDataRequest &s, const std::string &name, const DtSimulationAddress &addr=DtSimSendToAll, bool updateScenario=true)
	General set data message.
virtual void	sendSetRequest (const DtSetDataRequest &s, const std::vector< std::string > &names, const DtSimulationAddress &addr=DtSimSendToAll, bool updateScenario=true)
	Send a set request to multiple objects.
virtual void	requestIndirectFireInformation (const DtString &)
	Request indirect artillery information by environmental name.
Tasks
These functions send tasks to entities in the simulation.
virtual void	moveAlongRoute (const std::string &entityName, const std::string &routeName, const DtSimulationAddress &addr=DtSimSendToAll)
	Send a 'move along route' task to the entity/aggregate specified by 'name'.
virtual void	moveToWaypoint (const std::string &entityName, const std::string &waypoint, bool planPath=false, const DtSimulationAddress &addr=DtSimSendToAll)
	Send a 'move to waypoint' task to the entity/aggregate specified by 'name'.
virtual void	moveToLocation (const std::string &entityName, const DtVector &destinationLocation, bool planPath=false, const DtSimulationAddress &addr=DtSimSendToAll)
	Send a 'move to location' task to the entity/aggregate specified by 'name'.
virtual void	patrolBetweenWaypoints (const std::string &name, const std::string &waypoint1, const std::string &waypoint2, const DtSimulationAddress &addr=DtSimSendToAll)
	Send a 'patrol waypoints' task to the entity/aggregate specified by 'name'.
virtual void	patrolAlongRoute (const std::string &name, const std::string &route, const DtSimulationAddress &addr=DtSimSendToAll)
	Send a 'patrol route' task to the entity/aggregate specified by 'name'.
virtual void	followEntity (const std::string &name, const std::string &leader, const DtVector &offset, const DtSimulationAddress &addr=DtSimSendToAll)
	Send a 'follow' task to the given entity/aggregate.
virtual void	wait (const std::string &name, const DtSimulationAddress &addr=DtSimSendToAll)
	Send a 'wait' task to the entity/aggregate specified by 'name'.
virtual void	waitDuration (const std::string &name, DtTime duration, const DtSimulationAddress &addr=DtSimSendToAll)
	Send a 'wait X seconds' task to the entity/aggregate specified by 'name'.
virtual void	waitElapsed (const std::string &name, DtTime elapsed, const DtSimulationAddress &addr=DtSimSendToAll)
	Send a 'wait until the simulation time has increased by X' task to the entity/aggregate specified by 'name'.
virtual void	requestCurrentTasks (const std::string &entityName)
	Request the set of current tasks for an entity.
virtual void	subscribeForTaskInformation (const std::string &entityName)
	Request the set of current tasks for an entity, and have new task information messages sent each time the current task set for the entity changes.
virtual void	unsubscribeForTaskInformation (const std::string &entityName)
	Stop sending current task information for an entity that was previously requested with subscribeForTaskInformation().
virtual void	sendTaskMsg (const std::string &recipient, DtSimTask *task, const DtSimulationAddress &addr=DtSimSendToAll)
	Send a general task message to the entity/aggregate specified by 'recipient' argument, which is the name of the entity/aggregate to receive the task message.
virtual void	sendTaskRequest (const DtSimTask &s, const std::vector< std::string > &names, const DtSimulationAddress &addr=DtSimSendToAll)
	Send any DtSimTask subclass to a set of entities.
virtual void	sendTaskRequest (const DtSimTask &s, const std::string &name, const DtSimulationAddress &addr=DtSimSendToAll)
	Send any DtSimTask subclass to a single entity.
virtual void	requestTasksAndSetsFor (std::vector< DtString > name)
	Requests the tasks and sets that are available for the list of named objects.
Plan Management
These function manage plans for entities in the simulation. Many of these methods will return data though messages that must be first registered for using DtNetworkMessageCallbackManager::registerSimMessageCallbackFor(). The DtNetworkMessageCallbackManager instance can be accessed using messageHandler().
virtual void	abandonPlan (std::string name, DtSimulationAddress addr=DtSimSendToAll)
	Command the entity/aggregate corresponding to the given entity to abandon its plan.
virtual void	skipTask (std::string name, DtSimulationAddress addr=DtSimSendToAll)
	Command the entity/aggregate to skip the current task.
virtual void	restartPlan (std::string name, DtSimulationAddress addr=DtSimSendToAll)
	Command the entity/aggregate corresponding to the given entity to restart its current plan from the beginning.
virtual void	assignPlanByName (std::string name, const DtPlan *, DtSimulationAddress addr=DtSimSendToAll)
	Assign a plan to the named entity/aggregate.
virtual void	assignMultiplePlanByName (std::vector< std::string > names, const DtPlan *, DtSimulationAddress addr=DtSimSendToAll)
	Assigns a single plan to a multiple entities.
virtual void	requestPlan (std::string name, DtSimulationAddress addr=DtSimSendToAll)
	Send a message to all VRF sim engines requesting plan updates messages for the specified entity name.
virtual void	subscribePlan (std::string name, DtSimulationAddress addr=DtSimSendToAll)
	Requests plan status update messages from the sim engine for a particular entity.
virtual void	requestMultiplePlans (std::vector< std::string > names, DtSimulationAddress addr=DtSimSendToAll)
	Requests plans for a set of entities from the sim engine.
virtual void	requestGlobalPlans (DtSimulationAddress addr=DtSimSendToAll)
	Requests the list of all global plans from the simulation engine.
virtual void	requestGlobalPlan (std::string name, DtSimulationAddress addr=DtSimSendToAll)
	Request the contents of a specific global plan from the simulation engine.
virtual void	assignGlobalPlanByName (std::string name, const DtPlan *, DtSimulationAddress addr=DtSimSendToAll)
	Assigns a global plan of the specified name to the sim engine specified in addr.
virtual void	deleteGlobalPlan (std::string, DtSimulationAddress addr=DtSimSendToAll)
	Deletes any global plan matching the specified name.
Static Public Member Functions
static DtGuiThreadVrfRemoteController &	instance (makVrv::DtDe &de)
Public Attributes
boost::signal< void(const DtScenario *)>	signal_loadedScenario
	Called after both signal_new and signal_load scenario.
boost::signal< void()>	signal_scenarioModified
	Signal send whenever the scenario has been modified by the user.
boost::signal< void(const DtScenarioLoadInformation &)>	signal_loadScenario
	Calls down to simulation to load the scenario based on load scenario message.
boost::signal< void(const DtScenario *, DtPreserveMappingsFcn fcn, void *userData)>	signal_saveScenario
	Sends signal to save the specified scenario.
boost::signal< void(std::string, bool &shouldDelete)>	signal_shouldDeleteObject
	Sent before deleting the object, set the shouldDeleteObject flag to false to not delete the specified object.
boost::signal< void()>	signal_closeScenario
	Sent when the scenario is closing.
boost::signal< void(DtIfCreateVrfObject &)>	signal_aboutToSendCreateMessage
	Sent when create message is about to be sent.
boost::signal< void(DtIfModifyVrfObject &)>	signal_aboutToSendModifyMessage
	Sent when about to send modify message. Can change message to effect content.
Protected Types
typedef std::map< unsigned int, DtVrfObjectCreatedCallbackFunction >	CreateCallbacks
Protected Member Functions
virtual void	processObjectCreated (DtSimMessage *)
	Callback made when an object is created if a developer wishes to be notified of that callback.
virtual void	setActivated (bool)
	Override to also activate message handler.
virtual bool	addStatementsAndSendPlan (const DtPlan &plan, DtIfPlan &planMsg, const DtSimulationAddress &addr=DtSimSendToAll, int *retiStatus=0, DtString *retsStmt=0)
	Adds the statements from plan to planMsg, and sends planMsg to the specified address.
virtual void	indirectArtilleryCreated (DtString, const DtEntityIdentifier &, DtIfIndirectArtilleryData)
	Called when indirect fire is created, if there is modification data, then, send that off.
virtual void	slot_deActivated (makVrv::DtDe *de)
	Called after the de is activated, submits all create and register methods.
virtual void	slot_preTick (makVrv::DtDe *de)
Protected Attributes
bool	myAggregateOnCreate
CreateCallbacks	myCreateCallbacks

---

Detailed Description

This class is a thread-safe API to the DtVrfRemoteController.

Since DtVrfRemoteController is instantiated and used by the driver thread in VRF GUI, it cannot be accessed directly by functions executing in the main thread. Instead, similar functions can be called in this class. The calls are then put in a queue and executed on the actual DtVrfRemoteController instance by the driver thread.o

Any callbacks registered in calls to this class will be executed by the main thread.

See the "Threading in GUI API" section of the VR-Forces Developer's Guide for more information on the threading structure of VR-Forces GUI.

Examples

• GUI Thread VRF Remote Controller is an example of using this class in a VRF GUI plugin.

---

Member Typedef Documentation

typedef std::map<unsigned int, DtVrfObjectCreatedCallbackFunction> makVrf::DtGuiThreadVrfRemoteController::CreateCallbacks [protected]

---

Constructor & Destructor Documentation

makVrf::DtGuiThreadVrfRemoteController::DtGuiThreadVrfRemoteController

(

makVrv::DtDe &

)

virtual makVrf::DtGuiThreadVrfRemoteController::~DtGuiThreadVrfRemoteController

(

)

[virtual]

---

Member Function Documentation

static DtGuiThreadVrfRemoteController& makVrf::DtGuiThreadVrfRemoteController::instance

(

makVrv::DtDe &

de

)

[static]

Returns:

The singleton instance of the DtGuiThreadVrfRemoteController.

DtVrfBackendSettingsManager& makVrf::DtGuiThreadVrfRemoteController::backendSettingsManager

(

)

Use this manager to set or retrieve information about backend specific settings set by the DtSettingsObject.

DtVrfSimBackendManager& makVrf::DtGuiThreadVrfRemoteController::backendManager

(

)

Use this manager to retrieve information about the back-ends that are present in the system, including connecting to signals when back-ends are added or removed.

DtVrfSpotReportManager& makVrf::DtGuiThreadVrfRemoteController::spotReportManager

(

)

Use this manager to modify all information related to the spot report system.

DtVrfResourceManager& makVrf::DtGuiThreadVrfRemoteController::resourceManager

(

)

Use this manager to handle resource requests.

DtNetworkMessageCallbackManager& makVrf::DtGuiThreadVrfRemoteController::messageHandler

(

)

Use this manager to register callback messages.

virtual void makVrf::DtGuiThreadVrfRemoteController::newScenario	(	const DtScenario *	,
		int	startTimeOfDay = 12 *3600
	)		[virtual]

Create a new scenario using the specific scenario data provided, or at using the default scenario parameters on the specified terrain.

Note:

Calling this function replaces any previous call to loadScenario. Also, this function does not send a message if no backends are running in our session. Start time of day is when scenario is to start. Default is noon

virtual void makVrf::DtGuiThreadVrfRemoteController::newScenario	(	const DtFilename &	terrainDatabase,
		int	startTimeOfDay = 12 *3600
	)		[virtual]

virtual void makVrf::DtGuiThreadVrfRemoteController::loadScenario

(

const DtScenarioLoadInformation &

)

[virtual]

Loads scenario specified by DtScenario.

Parses and transfers configuration files to the appropriate backends based on the info in scenario; Then tells backends to load the relevant files.

Note:

Calling this function replaces any previous call to loadScenario. Also, this function does not send a message if no backends are running in our session.

Before loading a scenario you must call closeScenario and wait for all backends to close before loading or creating a new scenario. This is so any scenario data that might exist in the backend is cleaned up. NOT calling closeScenario before a load or a new can leave the backend in an undefined state. This is especially important to do for distributed scenarios.

virtual bool makVrf::DtGuiThreadVrfRemoteController::loadScenario

(

const DtFilename &

)

[virtual]

virtual void makVrf::DtGuiThreadVrfRemoteController::saveScenario	(	const DtScenario *	,
		DtPreserveMappingsFcn	fcn = 0,
		void *	userData = 0
	)		[virtual]

Save a scenario.

Note:

Calling this function replaces any previous call to loadScenario. Also, this function does not send a message if no backends are running in our session. If the scenario was remapped during load by a DtBackendRemappingFcn, an optional DtPreserveMappingsFcn is called to determine if the original mappings should be preserved (default), or if the current mappings should be saved. To get notification when the save is complete, call addScenarioSavedCallback.

Returns:

bool indicates if the save message was sent

Return values:

true	the save message was successfully sent to the back-end
false	either a file or directory was not writable or the DtPreserveMappingsFcn returned false.

virtual void makVrf::DtGuiThreadVrfRemoteController::closeScenario

(

)

[virtual]

Close the current scenario.

virtual void makVrf::DtGuiThreadVrfRemoteController::runScenario

(

DtSimulationAddress

addr = DtSimSendToAll

)

[virtual]

Put the scenario in run mode (start playing) if it is not already.

virtual void makVrf::DtGuiThreadVrfRemoteController::pauseScenario

(

DtSimulationAddress

addr = DtSimSendToAll

)

[virtual]

Pause the scenario execution.

virtual void makVrf::DtGuiThreadVrfRemoteController::rewindScenario

(

DtSimulationAddress

addr = DtSimSendToAll

)

[virtual]

Rewind the scenario to the last save state.

virtual void makVrf::DtGuiThreadVrfRemoteController::exitServer

(

DtSimulationAddress

addr = DtSimSendToAll

)

[virtual]

Cause simulation engine to quit.

virtual void makVrf::DtGuiThreadVrfRemoteController::stepScenario

(

DtSimulationAddress

addr = DtSimSendToAll

)

[virtual]

Advance simulation by a single time step.

virtual void makVrf::DtGuiThreadVrfRemoteController::deleteObject	(	std::string	name,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Delete VR-Force's object by name This will work for any object published by the simulation engine, including entities, aggregates, control objects, and overlay objects.

virtual void makVrf::DtGuiThreadVrfRemoteController::createWaypoint	(	const DtVector &	geocentricPosition,
		const std::string &	uniqueName = "",
		const std::string &	label = "",
		const DtSimulationAddress &	addr = DtSimSendToAll,
		unsigned int	requestId = 0
	)		[virtual]

Create a new waypoint.

Note that the name must be unique (if specified) and that the position needs to be in geocentric coordinates. This function simply sends the info to the given address -- it's up to users to do error checking before making this call!

virtual void makVrf::DtGuiThreadVrfRemoteController::createWaypoint	(	DtVrfObjectCreatedCallbackFunction	fcn,
		const DtVector &	geocentricPosition,
		const std::string &	uniqueName = "",
		const std::string &	label = "",
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Create a new waypoint.

This version of create allows users to register a callback function that will be invoked once the object has been created.

virtual void makVrf::DtGuiThreadVrfRemoteController::modifyWaypoint	(	const std::string &	uniqueId,
		std::string *	uniqueName = 0,
		std::string *	label = 0,
		DtVector *	geocentricPosition = 0,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Modify the given waypoint.

virtual void makVrf::DtGuiThreadVrfRemoteController::createRoute	(	const std::vector< DtVector > &	vertices,
		const std::string &	uniqueName = "",
		const std::string &	label = "",
		const DtSimulationAddress &	addr = DtSimSendToAll,
		unsigned int	rId = 0
	)		[virtual]

Create a new route.

Note that the name must be unique (if specified) and that the vertices needs to be in geocentric coordinates. This function simply sends the info to the given address -- it's up to users to do error checking before making this call!

virtual void makVrf::DtGuiThreadVrfRemoteController::createRoute	(	DtVrfObjectCreatedCallbackFunction	fcn,
		const std::vector< DtVector > &	vertices,
		const std::string &	uniqueName = "",
		const std::string &	label = "",
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Create a new route.

This version of create allows users to register a callback function that will be invoked once the object has been created.

virtual void makVrf::DtGuiThreadVrfRemoteController::modifyRoute	(	const std::string &	uniqueId,
		std::string *	uniqueName = 0,
		std::string *	label = 0,
		std::vector< DtVector > *	vertices = 0,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Modify the given route.

virtual void makVrf::DtGuiThreadVrfRemoteController::createPhaseLine	(	const DtVector &	dbPoint1,
		const DtVector &	dbPoint2,
		const std::string &	uniqueName = "",
		const std::string &	label = "",
		const DtSimulationAddress &	addr = DtSimSendToAll,
		unsigned int	rId = 0
	)		[virtual]

Create a new phase line.

Note that the name must be unique (if specified) and that the vertices needs to be in geocentric coordinates. This function simply sends the info to the given address -- it's up to users to do error checking before making this call!

virtual void makVrf::DtGuiThreadVrfRemoteController::createPhaseLine	(	DtVrfObjectCreatedCallbackFunction	fcn,
		const DtVector &	dbPoint1,
		const DtVector &	dbPoint2,
		const std::string &	uniqueName = "",
		const std::string &	label = "",
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Create a new phase line.

This version of create allows users to register a callback function that will be invoked once the object has been created.

virtual void makVrf::DtGuiThreadVrfRemoteController::modifyPhaseLine	(	const std::string &	uniqueId,
		std::string *	uniqueName = 0,
		std::string *	label = 0,
		DtVector *	newDbPoint1 = 0,
		DtVector *	newDbPoint2 = 0,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Modify the given phase line.

virtual void makVrf::DtGuiThreadVrfRemoteController::createControlArea	(	const std::vector< DtVector > &	vertices,
		const std::string &	uniqueName = "",
		const std::string &	label = "",
		const DtSimulationAddress &	addr = DtSimSendToAll,
		unsigned int	rId = 0
	)		[virtual]

Create a new control area.

Note that the name must be unique (if specified) and that the vertices needs to be in geocentric coordinates. Also, the vertices should form a convex polygon! This function simply sends the info to the given address -- it's up to users to do error checking before making this call!

virtual void makVrf::DtGuiThreadVrfRemoteController::createControlArea	(	DtVrfObjectCreatedCallbackFunction	fcn,
		const std::vector< DtVector > &	vertices,
		const std::string &	uniqueName = "",
		const std::string &	label = "",
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Create a new control area.

This version of create allows users to register a callback function that will be invoked once the object has been created.

virtual void makVrf::DtGuiThreadVrfRemoteController::modifyControlArea	(	const std::string &	uniqueId,
		std::string *	uniqueName = 0,
		std::string *	label = 0,
		std::vector< DtVector > *	newVertices = 0,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

modify the given control area

virtual void makVrf::DtGuiThreadVrfRemoteController::createObstacle	(	const std::vector< DtVector > &	vertices,
		const std::string &	uniqueName = "",
		const std::string &	label = "",
		const DtSimulationAddress &	addr = DtSimSendToAll,
		unsigned int	rId = 0
	)		[virtual]

Create a new obstacle.

Note that the name must be unique (if specified) and that the vertices needs to be in geocentric coordinates. Also, the vertices should form a convex polygon! This function simply sends the info to the given address -- it's up to users to do error checking before making this call!

virtual void makVrf::DtGuiThreadVrfRemoteController::createObstacle	(	DtVrfObjectCreatedCallbackFunction	fcn,
		const std::vector< DtVector > &	vertices,
		const std::string &	uniqueName = "",
		const std::string &	label = "",
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Create a new obstacle.

This version of create allows users to register a callback function that will be invoked once the object has been created.

virtual void makVrf::DtGuiThreadVrfRemoteController::modifyObstacle	(	const std::string &	uniqueId,
		std::string *	uniqueName = 0,
		std::string *	label = 0,
		std::vector< DtVector > *	newVertices = 0,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

modify the given obstacle

virtual void makVrf::DtGuiThreadVrfRemoteController::createDisaggregationArea	(	const std::vector< DtVector > &	vertices,
		const std::string &	uniqueName = "",
		const std::string &	label = "",
		const DtSimulationAddress &	addr = DtSimSendToAll,
		unsigned int	rId = 0
	)		[virtual]

Create a new disaggregation area (triggers automatic disaggregation whenever an aggregate enters the area).

Note that the name must be unique (if specified) and that the vertices needs to be in geocentric coordinates. This function simply sends the info to the given address -- it's up to users to do error checking before making this call!

virtual void makVrf::DtGuiThreadVrfRemoteController::createDisaggregationArea	(	DtVrfObjectCreatedCallbackFunction	fcn,
		const std::vector< DtVector > &	vertices,
		const std::string &	uniqueName = "",
		const std::string &	label = "",
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Create a new disaggregation area (triggers automatic disaggregation whenever an aggregate enters the area).

This version of create allows users to register a callback function that will be invoked once the object has been created.

virtual void makVrf::DtGuiThreadVrfRemoteController::modifyDisaggregationArea	(	const std::string &	uniqueId,
		std::string *	uniqueName = 0,
		std::string *	label = 0,
		std::vector< DtVector > *	newVertices = 0,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Modify given disaggregation area.

virtual void makVrf::DtGuiThreadVrfRemoteController::createOverlayObject	(	const DtEntityType &	type,
		const std::vector< DtVector > &	vertices,
		const DtForceType &	force,
		const std::string &	name,
		const std::string &	label,
		int	color,
		const std::string &	parentName,
		bool	projection,
		bool	closedFigure,
		const DtAppearance &	appearance = DtAppearance::nullAppearance(),
		const std::string &	attachTo = "",
		char *	userData = 0,
		int	dataSize = 0,
		DtVrfObjectCreatedCallbackFunction	fcn = 0,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Overlay objects are considered objects that both be used in a simulated environment (control objects as listed above) and objects that can be used to annotate a scenario as one might do with an overlay on an overhead projector.

Creating an overlay object is a two step process. The first step is to create the object, and the second is to apply modifications to that created object (color, parent). This call will do both. It will send the create message, wait for the object to be created, and then send the modify message for that object.

virtual void makVrf::DtGuiThreadVrfRemoteController::createIndirectFire	(	const DtIfIndirectArtilleryData &	params,
		const DtSimulationAddress &	addr
	)		[virtual]

Create an indirect artillery area on the specified backend with the given parameters.

virtual void makVrf::DtGuiThreadVrfRemoteController::createEntity	(	DtVrfObjectCreatedCallbackFunction	fcn,
		DtSimulationAddress	addr,
		DtEntityCreationData	,
		const std::list< DtAdminContent * > &	content = std::list< DtAdminContent * >(),
		const std::list< DtSimInterfaceContent * > &	ifaceContent = std::list< DtSimInterfaceContent * >()
	)		[virtual]

Create entity based on creation data.

All methods below call this method with entity creation data filled in

virtual void makVrf::DtGuiThreadVrfRemoteController::createEntity	(	DtSimulationAddress	addr,
		DtEntityCreationData	,
		const std::list< DtAdminContent * > &	content = std::list< DtAdminContent * >(),
		const std::list< DtSimInterfaceContent * > &	ifaceContent = std::list< DtSimInterfaceContent * >()
	)		[virtual]

Create entity based on creation data.

All methods below call this method with entity creation data filled in

virtual void makVrf::DtGuiThreadVrfRemoteController::createEntity	(	const DtEntityType &	type,
		const DtVector &	geocentricPosition,
		DtForceType	force,
		DtReal	heading,
		const std::string &	uniqueName = "",
		const std::string &	label = "",
		const DtSimulationAddress &	addr = DtSimSendToAll,
		bool	groundClamp = true,
		const std::list< DtAdminContent * > &	content = std::list< DtAdminContent * >(),
		const std::list< DtSimInterfaceContent * > &	ifaceContent = std::list< DtSimInterfaceContent * >()
	)		[virtual]

Create a new entity.

virtual void makVrf::DtGuiThreadVrfRemoteController::createEntity	(	DtVrfObjectCreatedCallbackFunction	fcn,
		const DtEntityType &	type,
		const DtVector &	geocentricPosition,
		DtForceType	force,
		DtReal	heading,
		const std::string &	uniqueName = "",
		const std::string &	label = "",
		const DtSimulationAddress &	addr = DtSimSendToAll,
		bool	groundClamp = true,
		const std::list< DtAdminContent * > &	content = std::list< DtAdminContent * >(),
		const std::list< DtSimInterfaceContent * > &	ifaceContent = std::list< DtSimInterfaceContent * >()
	)		[virtual]

Create a new entity.

This version of create allows users to register a callback function that will be invoked once the object has been created.

virtual void makVrf::DtGuiThreadVrfRemoteController::createAggregate	(	DtVrfObjectCreatedCallbackFunction	fcn,
		const DtEntityType &	type,
		const DtVector &	geocentricPosition,
		DtForceType	force,
		DtReal	heading,
		const std::string &	uniqueName,
		const std::string &	label = "",
		const DtSimulationAddress &	addr = DtSimSendToAll,
		DtAggregateState	initialAggregateState = DtDisaggregated,
		const std::list< DtAdminContent * > &	content = std::list< DtAdminContent * >(),
		const std::list< DtSimInterfaceContent * > &	ifaceContent = std::list< DtSimInterfaceContent * >()
	)		[virtual]

Create a new aggregate.

virtual void makVrf::DtGuiThreadVrfRemoteController::aggregateAs	(	const std::vector< makVrv::DtVrlinkSimulatedEntityState > &	names,
		const DtEntityType &	type,
		int	force,
		DtAggregateState	initialAggregateState,
		DtSimulationAddress	addr,
		unsigned int	requestId = 0
	)		[virtual]

Create an aggregate.

virtual void makVrf::DtGuiThreadVrfRemoteController::aggregateAs	(	DtVrfObjectCreatedCallbackFunction	fcn,
		const std::vector< makVrv::DtVrlinkSimulatedEntityState > &	names,
		const DtEntityType &	type,
		int	force,
		DtAggregateState	initialAggregateState,
		DtSimulationAddress	addr
	)		[virtual]

Create an aggregate.

This version of create allows users to register a callback function that will be invoked once the object has been created.

virtual void makVrf::DtGuiThreadVrfRemoteController::addToOrganization	(	const std::string &	childId,
		const std::string &	superiorId,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Adds the specified object to as a subordinate to the specified superior.

Object will be detached from any superior it currently belongs to first.

virtual void makVrf::DtGuiThreadVrfRemoteController::addToForceLevelOrganization	(	const std::string &	entityId,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Adds the specified object as a subordinate to the Force Level aggregate corresponding to the objects force type.

It will be detached from any superior it currently belongs to first.

virtual void makVrf::DtGuiThreadVrfRemoteController::removeFromOrganization	(	const std::string &	objectId,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Removes the specified object from whatever aggregate it is a part of and leaves it with no superior.

virtual void makVrf::DtGuiThreadVrfRemoteController::createEnvironmentalObject	(	DtSimulationAddress	addr,
		DtEntityType	,
		int	force,
		const std::vector< DtVector > &	,
		const DtEnvironmentalCreationData &	data = DtEnvironmentalCreationData()
	)		[virtual]

Generally create an environmental object.

virtual void makVrf::DtGuiThreadVrfRemoteController::sendVrfObjectModifyMsg	(	const DtSimulationAddress &	addr,
		const std::string &	entityId,
		const std::string *	name = 0,
		const std::vector< DtVector > &	= std::vector< DtVector >(),
		int *	force = 0,
		double *	heading = 0,
		const std::string *	label = 0,
		DtAppearance *	appearance = 0,
		const std::string *	overlayParent = 0,
		const std::string *	userData = 0
	)		[virtual]

This function can be used to modify vrf objects that cannot be created using the more specific methods above.

Please note that calling this function for entity values will not work in most cases. Instead, the SetData family of methods should be used. In general, users should not need to call this.

virtual void makVrf::DtGuiThreadVrfRemoteController::sendVrfObjectCreateMsg	(	const DtSimulationAddress &	addr,
		unsigned int	requestId,
		const std::string &	name,
		const DtObjectType &	type,
		const std::vector< DtVector > &	vertices,
		const std::string &	label,
		const DtAppearance &	appearance,
		DtForceType	force,
		bool	projection,
		bool	closedFigure,
		DtReal	heading,
		bool	createSubObjects,
		bool	clampToGroundFlag = true,
		const std::string &	initialFormation = "",
		DtAggregateState	initialAggregateState = DtDisaggregated,
		const std::string &	userData = "",
		const std::list< DtAdminContent * > &	content = std::list< DtAdminContent * >(),
		const std::list< DtSimInterfaceContent * > &	ifaceContent = std::list< DtSimInterfaceContent * >()
	)		[virtual]

This function can be used to create vrf objects that cannot be created using the more specific methods above.

In general, users should not need to call this.

virtual unsigned int makVrf::DtGuiThreadVrfRemoteController::addCreateCallbackFunction

(

DtVrfObjectCreatedCallbackFunction

)

[virtual]

Adds a new create function callback and returns the request id that can be used to associate that callback to be invoked when the item is created.

virtual void makVrf::DtGuiThreadVrfRemoteController::sendVrfOverlayObjectModifyMsg	(	const DtSimulationAddress &	addr,
		const std::string &	id,
		int *	color = 0,
		const std::string *	parentName = 0,
		const std::string *	attachTo = 0,
		const std::string *	userData = 0
	)		[virtual]

This function is only used to modify information that is specific to an overlay object (waypoint, route, overlay objects, etc.)

virtual void makVrf::DtGuiThreadVrfRemoteController::sendVrfIndirectFireObjectModifyMsg	(	const DtSimulationAddress &	addr,
		const DtEntityIdentifier &	id,
		const DtIfIndirectArtilleryData &	mod
	)		[virtual]

Modification message for given indirect artillery fire area.

virtual void makVrf::DtGuiThreadVrfRemoteController::setLabel	(	const std::string &	id,
		const std::string &	label,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Change the label field of an object.

virtual void makVrf::DtGuiThreadVrfRemoteController::setOverlayParent	(	const std::string &	id,
		const std::string &	label,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Change which overlay an overlay graphic or entity is on.

virtual void makVrf::DtGuiThreadVrfRemoteController::setAltitude	(	const std::string &	name,
		double	altitude,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Set altitude (in meters)

virtual void makVrf::DtGuiThreadVrfRemoteController::setLocation	(	const std::string &	name,
		DtVector	coord,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Set location (geocentric coordinates)

virtual void makVrf::DtGuiThreadVrfRemoteController::setAppearance	(	const std::string &	name,
		int	appearance,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Set appearance of entity.

Parameters:

appearance

A set of appearance bits, defined by RPR FOM and DIS.

See also:

DtAppearance class in VR-Link.

virtual void makVrf::DtGuiThreadVrfRemoteController::setCapabilities	(	const std::string &	name,
		int	capabilities,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Set capabilities of entity.

Parameters:

capabilities

A set of capabilities bits, defined by RPR FOM and DIS.

See also:

DtCapability class in VR-Link.

virtual void makVrf::DtGuiThreadVrfRemoteController::setHeading	(	const std::string &	name,
		double	degrees,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Set heading (in degrees)

virtual void makVrf::DtGuiThreadVrfRemoteController::setForce	(	const std::string &	name,
		DtForceType	force,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Change force type of an object.

virtual void makVrf::DtGuiThreadVrfRemoteController::setResource	(	const std::string &	name,
		const char *	resourceType,
		double	value,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Set resource See resourceTypes.h for a list of pre-defined resource types that can be passed as the resourceType.

virtual void makVrf::DtGuiThreadVrfRemoteController::setRulesOfEngagement	(	const std::string &	name,
		const char *	rulesType,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Set rules of engagement.

See also:

DtSetEngagementRulesRequest for a list of defined rules of engagement types that can be passed as the rulesType.

virtual void makVrf::DtGuiThreadVrfRemoteController::setSectorOfResponsibility	(	const std::string &	name,
		double	center,
		double	size,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Set sector of responsibility (center and size are in degrees)

virtual void makVrf::DtGuiThreadVrfRemoteController::setSpeed	(	const std::string &	name,
		double	speed,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Set ordered speed (in meters per second)

Note:

This will not change the instantaneous speed of the entity, but will change the target speed of the dynamics model for the entity.

virtual void makVrf::DtGuiThreadVrfRemoteController::setTarget	(	const std::string &	name,
		const std::string &	target,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Set preferred weapons target.

virtual void makVrf::DtGuiThreadVrfRemoteController::setTaskedBySuperior	(	const std::string &	name,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Set tasked by superior Causes entity to abandon its own tasking, and resume taking tasks from its superior, if it is part of an aggregate.

virtual void makVrf::DtGuiThreadVrfRemoteController::setConcealed	(	const std::string &	name,
		bool	yes,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Changes the concealed appearance bit for the entity.

virtual void makVrf::DtGuiThreadVrfRemoteController::setEmitter	(	const std::string &	name,
		int	emitterId,
		bool	on,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Set a given emitter system on or off.

virtual void makVrf::DtGuiThreadVrfRemoteController::setIff	(	const std::string &	name,
		bool	mode1on,
		int	mode1code,
		bool	mode2on,
		int	mode2code,
		bool	mode3on,
		int	mode3code,
		bool	mode4on,
		int	mode4code,
		DtIffAtcNavaidsAltParm4	altParm4,
		bool	mode5on,
		bool	useAltMode5,
		bool	modeSon,
		bool	emergency,
		bool	flash,
		bool	sti,
		bool	modeSTcasI,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Set the IFF parameters for an entity with and IFF transponder.

virtual void makVrf::DtGuiThreadVrfRemoteController::restore	(	const std::string &	name,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Restore to start state Entity will become healthy again (if damaged) and all resources are restored to initial state.

virtual void makVrf::DtGuiThreadVrfRemoteController::setDestroyed	(	const std::string &	name,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Sets the damage state of the specified entity/aggregate to destroyed.

virtual void makVrf::DtGuiThreadVrfRemoteController::setLifeformWeaponState	(	const std::string &	name,
		DtWeaponState	weapon,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Set lifeform weapon.

virtual void makVrf::DtGuiThreadVrfRemoteController::setLifeformPosture	(	const std::string &	name,
		DtLifeformState	posture,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Set lifeform posture.

virtual void makVrf::DtGuiThreadVrfRemoteController::setAggregateFormation	(	const std::string &	leader,
		const std::string &	formationName,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Set an aggregate formation.

virtual void makVrf::DtGuiThreadVrfRemoteController::reorganizeAggregate	(	const std::string &	leader,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Reorganize the aggregate.

This function is only useful when automatic reorganization is not enabled. If 'leader' is not an aggregate leader making this call will have no effect.

virtual void makVrf::DtGuiThreadVrfRemoteController::disaggregate	(	std::string	name,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Disaggregate the entity, resulting in its DtAggregateState to become DtDisaggregated, and simulation of its subordinates as distinct entities.

virtual void makVrf::DtGuiThreadVrfRemoteController::aggregate	(	std::string	name,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Aggregate the entity, resulting in its DtAggregateState to become DtAggregated, with subordinates not simulated as distinct entities.

virtual void makVrf::DtGuiThreadVrfRemoteController::setJoystickEnabled	(	std::string	name,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Sends signal set the joystick enabled for the specified entity.

virtual void makVrf::DtGuiThreadVrfRemoteController::setJoystickDisabled	(	std::string	name,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Sends signal set the joystick disabled for the specified entity.

virtual void makVrf::DtGuiThreadVrfRemoteController::sendSetDataMsg	(	const std::string &	recipient,
		DtSetDataRequest *	msg,
		const DtSimulationAddress &	addr = DtSimSendToAll,
		bool	updateScenario = true
	)		[virtual]

General set data message.

The recipient is the name of the object to receive the set message.

virtual void makVrf::DtGuiThreadVrfRemoteController::sendSetRequest	(	const DtSetDataRequest &	s,
		const std::string &	name,
		const DtSimulationAddress &	addr = DtSimSendToAll,
		bool	updateScenario = true
	)		[virtual]

General set data message.

The recipient is the name of the object to receive the set message.

virtual void makVrf::DtGuiThreadVrfRemoteController::sendSetRequest	(	const DtSetDataRequest &	s,
		const std::vector< std::string > &	names,
		const DtSimulationAddress &	addr = DtSimSendToAll,
		bool	updateScenario = true
	)		[virtual]

Send a set request to multiple objects.

virtual void makVrf::DtGuiThreadVrfRemoteController::requestIndirectFireInformation

(

const DtString &

)

[virtual]

Request indirect artillery information by environmental name.

In order to receive the results of this callback you must use the DtNetworkMessageCallback manager and register for the DtIndirectFireMessageType type: DtNetworkMessageCallbackManager::instance(myDe).registerSimMessageCallbackFor(DtIndirectFireMessageType, boost::bind(&MyClass::indirectArtilleryData, this, _1));

virtual void makVrf::DtGuiThreadVrfRemoteController::moveAlongRoute	(	const std::string &	entityName,
		const std::string &	routeName,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Send a 'move along route' task to the entity/aggregate specified by 'name'.

virtual void makVrf::DtGuiThreadVrfRemoteController::moveToWaypoint	(	const std::string &	entityName,
		const std::string &	waypoint,
		bool	planPath = false,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Send a 'move to waypoint' task to the entity/aggregate specified by 'name'.

virtual void makVrf::DtGuiThreadVrfRemoteController::moveToLocation	(	const std::string &	entityName,
		const DtVector &	destinationLocation,
		bool	planPath = false,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Send a 'move to location' task to the entity/aggregate specified by 'name'.

destinationLocation is specified in geocentric coordinates.

virtual void makVrf::DtGuiThreadVrfRemoteController::patrolBetweenWaypoints	(	const std::string &	name,
		const std::string &	waypoint1,
		const std::string &	waypoint2,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Send a 'patrol waypoints' task to the entity/aggregate specified by 'name'.

virtual void makVrf::DtGuiThreadVrfRemoteController::patrolAlongRoute	(	const std::string &	name,
		const std::string &	route,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Send a 'patrol route' task to the entity/aggregate specified by 'name'.

virtual void makVrf::DtGuiThreadVrfRemoteController::followEntity	(	const std::string &	name,
		const std::string &	leader,
		const DtVector &	offset,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Send a 'follow' task to the given entity/aggregate.

The vrf object specified by 'name' will follow 'leader' at the given offset . The offset should be specified in meters. To specify an offset in front, to the right, or below, use a negative sign for x, y, or z.

virtual void makVrf::DtGuiThreadVrfRemoteController::wait	(	const std::string &	name,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Send a 'wait' task to the entity/aggregate specified by 'name'.

virtual void makVrf::DtGuiThreadVrfRemoteController::waitDuration	(	const std::string &	name,
		DtTime	duration,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Send a 'wait X seconds' task to the entity/aggregate specified by 'name'.

virtual void makVrf::DtGuiThreadVrfRemoteController::waitElapsed	(	const std::string &	name,
		DtTime	elapsed,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Send a 'wait until the simulation time has increased by X' task to the entity/aggregate specified by 'name'.

Parameters:

elapsed

Simulation time.

virtual void makVrf::DtGuiThreadVrfRemoteController::requestCurrentTasks

(

const std::string &

entityName

)

[virtual]

Request the set of current tasks for an entity.

Note:

To receive the result, you must first register a callback using DtNetworkMessageCallbackManager::registerSimMessageCallbackFor() for type DtCapableTaskAndSetResponseType, and the message type will be DtCapableTaskAndSetResponse.

virtual void makVrf::DtGuiThreadVrfRemoteController::subscribeForTaskInformation

(

const std::string &

entityName

)

[virtual]

Request the set of current tasks for an entity, and have new task information messages sent each time the current task set for the entity changes.

virtual void makVrf::DtGuiThreadVrfRemoteController::unsubscribeForTaskInformation

(

const std::string &

entityName

)

[virtual]

Stop sending current task information for an entity that was previously requested with subscribeForTaskInformation().

virtual void makVrf::DtGuiThreadVrfRemoteController::sendTaskMsg	(	const std::string &	recipient,
		DtSimTask *	task,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Send a general task message to the entity/aggregate specified by 'recipient' argument, which is the name of the entity/aggregate to receive the task message.

virtual void makVrf::DtGuiThreadVrfRemoteController::sendTaskRequest	(	const DtSimTask &	s,
		const std::vector< std::string > &	names,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Send any DtSimTask subclass to a set of entities.

virtual void makVrf::DtGuiThreadVrfRemoteController::sendTaskRequest	(	const DtSimTask &	s,
		const std::string &	name,
		const DtSimulationAddress &	addr = DtSimSendToAll
	)		[virtual]

Send any DtSimTask subclass to a single entity.

virtual void makVrf::DtGuiThreadVrfRemoteController::requestTasksAndSetsFor

(

std::vector< DtString >

name

)

[virtual]

Requests the tasks and sets that are available for the list of named objects.

Note:

To receive the result, you must first register a callback using DtNetworkMessageCallbackManager::registerSimMessageCallbackFor() for type DtCapableTaskAndSetResponseType, and the message type will be DtCapableTaskAndSetResponse.

virtual void makVrf::DtGuiThreadVrfRemoteController::abandonPlan	(	std::string	name,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Command the entity/aggregate corresponding to the given entity to abandon its plan.

virtual void makVrf::DtGuiThreadVrfRemoteController::skipTask	(	std::string	name,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Command the entity/aggregate to skip the current task.

If it is executing a plan, it will move to the next statement in the plan.

virtual void makVrf::DtGuiThreadVrfRemoteController::restartPlan	(	std::string	name,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Command the entity/aggregate corresponding to the given entity to restart its current plan from the beginning.

virtual void makVrf::DtGuiThreadVrfRemoteController::assignPlanByName	(	std::string	name,
		const DtPlan *	,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Assign a plan to the named entity/aggregate.

virtual void makVrf::DtGuiThreadVrfRemoteController::assignMultiplePlanByName	(	std::vector< std::string >	names,
		const DtPlan *	,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Assigns a single plan to a multiple entities.

virtual void makVrf::DtGuiThreadVrfRemoteController::requestPlan	(	std::string	name,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Send a message to all VRF sim engines requesting plan updates messages for the specified entity name.

Note:

To receive the result, you must first register a callback using DtNetworkMessageCallbackManager::registerSimMessageCallbackFor() for type DtPlanMessageType, and the message type will be DtIfPlan.

virtual void makVrf::DtGuiThreadVrfRemoteController::subscribePlan	(	std::string	name,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Requests plan status update messages from the sim engine for a particular entity.

Messages will be sent every time the status changes.

Note:

To receive the result, you must first register a callback using DtNetworkMessageCallbackManager::registerSimMessageCallbackFor() for type DtPlanCurStatementMessageType.

virtual void makVrf::DtGuiThreadVrfRemoteController::requestMultiplePlans	(	std::vector< std::string >	names,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Requests plans for a set of entities from the sim engine.

The response will contain only a single plan, and a flag indicating whether all the requested entities had the same plan already.

Note:

To receive the result, you must first register a callback using DtNetworkMessageCallbackManager::registerSimMessageCallbackFor() for type DtMultiplePlanResponseMessageType, and the message type will be DtIfMultiplePlanResponse.

virtual void makVrf::DtGuiThreadVrfRemoteController::requestGlobalPlans

(

DtSimulationAddress

addr = DtSimSendToAll

)

[virtual]

Requests the list of all global plans from the simulation engine.

Note:

To receive the result, you must first register a callback using DtNetworkMessageCallbackManager::registerSimMessageCallbackFor() for type DtGlobalPlanListMessageType, and the message type will be DtIfGlobalPlanList.

virtual void makVrf::DtGuiThreadVrfRemoteController::requestGlobalPlan	(	std::string	name,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Request the contents of a specific global plan from the simulation engine.

Note:

To receive the result, you must first register a callback using DtNetworkMessageCallbackManager::registerSimMessageCallbackFor() for type DtPlanMessageType, and the message type will be DtIfPlan.

virtual void makVrf::DtGuiThreadVrfRemoteController::assignGlobalPlanByName	(	std::string	name,
		const DtPlan *	,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Assigns a global plan of the specified name to the sim engine specified in addr.

If addr is DtSimSendToAll, the first sim engine is chosen.

virtual void makVrf::DtGuiThreadVrfRemoteController::deleteGlobalPlan	(	std::string	,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Deletes any global plan matching the specified name.

virtual void makVrf::DtGuiThreadVrfRemoteController::setTimeoutInterval

(

int

)

[virtual]

Sets how long the GUI should wait (milliseconds) for a back-end to time out without receiving a status message.

virtual void makVrf::DtGuiThreadVrfRemoteController::requestDIGuyAppearancesAndAnimations

(

std::vector< DtString >

name

)

[virtual]

Requests the DI-Guy Appearances and animations available for the DI-Guy character associated with this entity.

Note:

To receive the result, you must first register a callback using DtNetworkMessageCallbackManager::registerSimMessageCallbackFor() for type DtIfDIGuyAppearAndAnimationsResponseType, and the message type will be DtIfDIGuyAppearAndAnimationsResponse.

virtual void makVrf::DtGuiThreadVrfRemoteController::requestResourcesFor	(	std::vector< std::string >	names,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Request the resource information from the simulation engine for a set of entities.

Note:

To receive the result, you must first register a callback using DtNetworkMessageCallbackManager::registerSimMessageCallbackFor() for type DtEntityResourceResponseMessageType, and the message type will be DtIfEntityResourceResponse.

A separate response message will be received for each entity.

virtual void makVrf::DtGuiThreadVrfRemoteController::sendMessageToObject	(	const DtVrfObjectMessage &	,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Send the object message to the specified object in the message.

virtual void makVrf::DtGuiThreadVrfRemoteController::sendObjectMessageAndDeleteContent	(	DtVrfObjectMessage *	message,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Sends the message then deletes the message after it is sent.

virtual int makVrf::DtGuiThreadVrfRemoteController::generateRequestId

(

)

[virtual]

Generate a unique request id.

virtual void makVrf::DtGuiThreadVrfRemoteController::addSetCreatorFcn	(	std::string	,
		int	,
		DtSetDataRequestCreatorFcn
	)		[virtual]

Signal to register set creator.

virtual void makVrf::DtGuiThreadVrfRemoteController::addTaskCreatorFcn	(	std::string	,
		int	,
		DtSimTaskCreatorFcn
	)		[virtual]

Signal to register task creator.

virtual void makVrf::DtGuiThreadVrfRemoteController::addInterfaceContentCreatorFcn	(	int	t,
		DtInterfaceContentCreatorFcn
	)		[virtual]

Signal sent to register an interface content message.

virtual void makVrf::DtGuiThreadVrfRemoteController::addAdminContentCreatorFcn	(	std::string	,
		int	,
		DtAdminContentCreatorFcn
	)		[virtual]

Signal to register admin content command creator.

virtual void makVrf::DtGuiThreadVrfRemoteController::addConditionCreatorFcn	(	std::string	,
		int	,
		DtCondExprCreatorFcn
	)		[virtual]

Signal to register condition creator.

virtual void makVrf::DtGuiThreadVrfRemoteController::addReportCreatorFcn	(	std::string	,
		int	,
		DtSimReportCreatorFcn
	)		[virtual]

Signal to register report creator.

virtual void makVrf::DtGuiThreadVrfRemoteController::addObjectMessageCreatorFcn	(	int	,
		DtVrfObjectMessageCreatorFcn
	)		[virtual]

Signal to register object message creator.

virtual void makVrf::DtGuiThreadVrfRemoteController::addSimulationCommandCreatorFcn	(	std::string	,
		int	,
		DtSimCommandCreatorFcn
	)		[virtual]

Signal to register simulation command creator.

virtual void makVrf::DtGuiThreadVrfRemoteController::sendMessage	(	const DtSimInterfaceContent &	message,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Signal send to send interface content message to specified back-end.

If clone is true message will be cloned before sent to driver

virtual void makVrf::DtGuiThreadVrfRemoteController::sendMessageAndDeleteContent	(	DtSimInterfaceContent *	message,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

virtual void makVrf::DtGuiThreadVrfRemoteController::embarkOn	(	const std::vector< std::string > &	children,
		const std::string &	parentName,
		bool	useSlot = true,
		const DtVector &	overridePosition = DtVector::zero(),
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

These routines will send interface messages to tell the back-end to embark or disembark the specified objects.

All information sent is by object name. If loadOverride is false, then the system will use to occupancy director to determine where to embark the entity, else it will use the offset (in body coordinates) supplied by the user

virtual void makVrf::DtGuiThreadVrfRemoteController::disembark	(	const std::vector< std::string > &	children,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Signal to disembark the specified object.

virtual void makVrf::DtGuiThreadVrfRemoteController::disembarkAll	(	const std::vector< std::string > &	parents,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Signal to disembark all objects on the parent.

virtual void makVrf::DtGuiThreadVrfRemoteController::attachTo	(	const std::vector< std::string > &	ids,
		const std::string &	parentName
	)		[virtual]

Attaches all specified objects to specified parent name.

virtual void makVrf::DtGuiThreadVrfRemoteController::detachAll

(

const std::vector< std::string > &

ids

)

[virtual]

Sends overlay modify message to detach all the specified objects from their parents.

virtual void makVrf::DtGuiThreadVrfRemoteController::logObjectConsoleToFile	(	const std::string &	name,
		const std::string &	filename
	)		[virtual]

Tell the back-end to start (or stop if filename is blank) logging the console output for the specified entity.

virtual void makVrf::DtGuiThreadVrfRemoteController::stopLoggingObjectConsoleToFile

(

const std::string &

objectName

)

[virtual]

Stops any sim engine which is currently writing a log file for this object.

virtual void makVrf::DtGuiThreadVrfRemoteController::setObjectNotifyLevel	(	const std::string &	name,
		int
	)		[virtual]

Sets the notify level on console messages for object.

virtual void makVrf::DtGuiThreadVrfRemoteController::setTimeOfDay

(

int

seconds

)

[virtual]

Sets the current scenario time of day past midnight. Time is in seconds.

virtual void makVrf::DtGuiThreadVrfRemoteController::setAggregateOnCreate

(

bool

)

[virtual]

Sets whether or not that aggregates are aggregated or disaggregated on create. By default, false.

bool makVrf::DtGuiThreadVrfRemoteController::aggregateOnCreate

(

)

const

virtual void makVrf::DtGuiThreadVrfRemoteController::requestScenarioDescription

(

DtSimulationAddress

)

[virtual]

Requests scenario description.

Use selected back-end rather than DtSimSendToAll to prevent multiple return messages

virtual void makVrf::DtGuiThreadVrfRemoteController::setScenarioDescription	(	const DtString &	,
		DtSimulationAddress	addr = DtSimSendToAll
	)		[virtual]

Sets scenario description. Use DtSimSendToAll to make sure all back-ends get the description.

virtual void makVrf::DtGuiThreadVrfRemoteController::sendLoggerSetFilename

(

std::string

filename

)

[virtual]

Logger controls.

virtual void makVrf::DtGuiThreadVrfRemoteController::sendLoggerRecordMessage

(

)

[virtual]

virtual void makVrf::DtGuiThreadVrfRemoteController::sendLoggerStopMessage

(

)

[virtual]

virtual void makVrf::DtGuiThreadVrfRemoteController::processObjectCreated

(

DtSimMessage *

)

[protected, virtual]

Callback made when an object is created if a developer wishes to be notified of that callback.

virtual void makVrf::DtGuiThreadVrfRemoteController::setActivated

(

bool

)

[protected, virtual]

Override to also activate message handler.

Reimplemented from makVrf::DtQueuedManager.

virtual bool makVrf::DtGuiThreadVrfRemoteController::addStatementsAndSendPlan	(	const DtPlan &	plan,
		DtIfPlan &	planMsg,
		const DtSimulationAddress &	addr = DtSimSendToAll,
		int *	retiStatus = 0,
		DtString *	retsStmt = 0
	)		[protected, virtual]

Adds the statements from plan to planMsg, and sends planMsg to the specified address.

If the plan gets too long, multiple plan messages are sent, to be appended on the sim engine side. If any of the statements are too large to be encoded into the planMsg, an error code and the text of the invalid statement are returned in retiStatus and retsStmt.

Returns:

True if successful.

virtual void makVrf::DtGuiThreadVrfRemoteController::indirectArtilleryCreated	(	DtString	,
		const DtEntityIdentifier &	,
		DtIfIndirectArtilleryData
	)		[protected, virtual]

Called when indirect fire is created, if there is modification data, then, send that off.

virtual void makVrf::DtGuiThreadVrfRemoteController::slot_deActivated

(

makVrv::DtDe *

de

)

[protected, virtual]

Called after the de is activated, submits all create and register methods.

virtual void makVrf::DtGuiThreadVrfRemoteController::slot_preTick

(

makVrv::DtDe *

de

)

[protected, virtual]

---

Member Data Documentation

boost::signal<void (const DtScenario*)> makVrf::DtGuiThreadVrfRemoteController::signal_loadedScenario

Called after both signal_new and signal_load scenario.

This section represents the collection of all signals sent by the various methods listed above. These signals are needed to communicate with the network driver thread.

boost::signal<void ()> makVrf::DtGuiThreadVrfRemoteController::signal_scenarioModified

Signal send whenever the scenario has been modified by the user.

boost::signal<void (const DtScenarioLoadInformation&)> makVrf::DtGuiThreadVrfRemoteController::signal_loadScenario

Calls down to simulation to load the scenario based on load scenario message.

boost::signal<void (const DtScenario*, DtPreserveMappingsFcn fcn, void* userData)> makVrf::DtGuiThreadVrfRemoteController::signal_saveScenario

Sends signal to save the specified scenario.

boost::signal<void (std::string, bool& shouldDelete)> makVrf::DtGuiThreadVrfRemoteController::signal_shouldDeleteObject

Sent before deleting the object, set the shouldDeleteObject flag to false to not delete the specified object.

boost::signal<void ()> makVrf::DtGuiThreadVrfRemoteController::signal_closeScenario

Sent when the scenario is closing.

boost::signal<void (DtIfCreateVrfObject&)> makVrf::DtGuiThreadVrfRemoteController::signal_aboutToSendCreateMessage

Sent when create message is about to be sent.

Can change object create message to effect content

boost::signal<void (DtIfModifyVrfObject&)> makVrf::DtGuiThreadVrfRemoteController::signal_aboutToSendModifyMessage

Sent when about to send modify message. Can change message to effect content.

bool makVrf::DtGuiThreadVrfRemoteController::myAggregateOnCreate [protected]

CreateCallbacks makVrf::DtGuiThreadVrfRemoteController::myCreateCallbacks [protected]

---

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

• include/vrfGuiCore/DtGuiThreadVrfRemoteController.h