ifStatus.h File Reference

Go to the source code of this file.

Classes
class	DtIfStatus

Macros
#define	DtKeyFromKindDomain(kind, domain)   ((kind << 8) | (0x00FF & domain))
	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.

Enumerations
enum	DtScenarioCapabilities { DtScenarioCapabilities_Time = 0, DtScenarioCapabilities_CreateObjects = 1, DtScenarioCapabilities_SimulateTerrainEnvironmentServer = 2, DtScenarioCapabilities_PublishSMS = 3 }
	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. More...

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

Detailed Description

Macro Definition Documentation

#define DtKeyFromKindDomain	(		kind,
			domain
	)		((kind << 8) | (0x00FF & domain))

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

Enumeration Type Documentation

enum DtScenarioCapabilities

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.

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