ifStatus.h File Reference

Go to the source code of this file.

Classes
class	DtIfStatus

Enumerations
enum	DtScenarioCapabilities {   DtScenarioCapabilities_Time = 0, DtScenarioCapabilities_CreateObjects = 1, DtScenarioCapabilities_SimulateTerrainEnvironmentServer = 2, DtScenarioCapabilities_PublishSMS = 3,   DtScenarioCapabilities_AcceptOwnershipTransfer = 4, DtScenarioCapabilities_CanTransferObjects = 5, DtScenarioCapabilities_AllowInfiniteObjects = 6 }

Functions
DT_DLL_vrfmsgs bool	hasCapability (const DtU32 &capabilitiesBitfield, DtScenarioCapabilities bitNumber)
DT_DLL_vrfmsgs void	setCapability (DtU32 &capabilitiesBitfield, DtScenarioCapabilities bitNumber, bool value)

Variables
const int	DtIfStatusVersion = 10
const DtU32	DtScenarioCapabilities_All = 0xffff

Enumeration Type Documentation

enum DtScenarioCapabilities

Instances of DtIfStatus are sent out in response to a DtIfStatusRequest message and have boolean values to indicate if the application is capable of simulating entities and if it is in a loaded state. Also contains general status information about the simulation engine.

Content-Type: DtStatusMessageType ScenarioCapabilities are a way of expressing the functionality of a VRF Sim based application with regard to what the VRF GUI or remote control API application should expect it to do. A standard VRF Sim Engine is expected to have full capabilities, with all bits set to 1. Other applications, such as the VR-Engage sim engine may be limited in some way, and express that through the status messages.

Enumerator
DtScenarioCapabilities_Time	Indicates whether or not the simulation time provided by this is in line with the scenario's simulation time.
DtScenarioCapabilities_CreateObjects	True if this application can be commanded to create new objects to simulate.
DtScenarioCapabilities_SimulateTerrainEnvironmentServer	True if this application supports being the simulator of the terrain and environment server objects for the scenario.
DtScenarioCapabilities_PublishSMS	Set this flag to have the simulation model sets used by this back-end to publish the SMS in the back-end.
DtScenarioCapabilities_AcceptOwnershipTransfer	Set this flag to allow the back-end to accept ownership transfer.
DtScenarioCapabilities_CanTransferObjects	Set this flag to false disallow the back-end to transfer ownership. Default is on.
DtScenarioCapabilities_AllowInfiniteObjects	Identifies whether multiple object instances are allowed. When true, indicates the simulation allows multiple instances of an object When false, indicates the simulation allows only one instance of an object

Function Documentation

DT_DLL_vrfmsgs bool hasCapability	(	const DtU32 &	capabilitiesBitfield,
		DtScenarioCapabilities	bitNumber
	)

DT_DLL_vrfmsgs void setCapability	(	DtU32 &	capabilitiesBitfield,
		DtScenarioCapabilities	bitNumber,
		bool	value
	)

Variable Documentation

const int DtIfStatusVersion = 10

const DtU32 DtScenarioCapabilities_All = 0xffff