VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions
DtVrfSimulatedSimObjectFacadeInterface Class Referenceabstract

This DtVrfSimulatedSimObjectFacadeInterface class will provide accessors for data that is available to VRF simulated objects only. Remote object that are not simulated by VR-Forces will not be able to use this proxy. Use the isUsable method to check validity.

This class is not thread safe. It should only be used in the context of a single thread/object.

If this class is not usable, methods will return a default value

Related Examples
Inheritance diagram for DtVrfSimulatedSimObjectFacadeInterface:
Inheritance graph
[legend]

Public Member Functions

 DtVrfSimulatedSimObjectFacadeInterface ()
 
virtual ~DtVrfSimulatedSimObjectFacadeInterface ()
 
bool isUsable () const
 
int sessionId () const
 
bool activated () const
 
bool assumeUnknownIsHostile () const
 
bool independentlyTasked () const
 
bool underFire () const
 
bool isTasked () const
 
const DtStringextendedData (const DtString &) const
 
std::map< DtString, DtStringextendedDataMap () const
 
DtString extendedLabel (int index) const
 
std::map< int, DtStringextendedLabels () const
 
DtString label () const
 
bool invulnerable () const
 
bool invisible () const
 
DtEchelonId echelonId () const
 
bool sensorsKilled () const
 
bool occupantsHidden () const
 
bool hasPlan () const
 
bool executingPlan () const
 
const DtRwPropertiesstateProperties () const
 
const DtRwPropertiesparameterProperties () const
 
bool undetectable () const
 
DtString activity () const
 
DtString engagementRules () const
 
bool invisibleSetByUser () const
 
bool isVrfSimulated () const
 
DtString overlay () const
 
bool fuelLevelsFrozen () const
 
bool munitionLevelsFrozen () const
 
bool isSubordinateOfForceLevel () const
 
bool hasTarget () const
 
bool blockParachute () const
 
bool onTerrainSurface () const
 

Protected Member Functions

virtual DtSimObjectReference simObject () const =0
 
virtual void setupDecorator ()
 

Constructor & Destructor Documentation

DtVrfSimulatedSimObjectFacadeInterface::DtVrfSimulatedSimObjectFacadeInterface ( )

CTOR.

virtual DtVrfSimulatedSimObjectFacadeInterface::~DtVrfSimulatedSimObjectFacadeInterface ( )
virtual

Member Function Documentation

bool DtVrfSimulatedSimObjectFacadeInterface::isUsable ( ) const

Make this call after construction to see if the supplied sim object can use this class.

int DtVrfSimulatedSimObjectFacadeInterface::sessionId ( ) const

If present, the vrf session this is in. Default -1.

bool DtVrfSimulatedSimObjectFacadeInterface::activated ( ) const

Whether or not this object is activated. Default true.

bool DtVrfSimulatedSimObjectFacadeInterface::assumeUnknownIsHostile ( ) const

Whether or not this object assumes unknown objects are hostile. Default false.

bool DtVrfSimulatedSimObjectFacadeInterface::independentlyTasked ( ) const

Whether or not this sim object is independently tasked. Default true.

bool DtVrfSimulatedSimObjectFacadeInterface::underFire ( ) const

Whether or not this sim object is under fire. Default false.

bool DtVrfSimulatedSimObjectFacadeInterface::isTasked ( ) const

Whether or not this sim object is tasked. Default false.

const DtString& DtVrfSimulatedSimObjectFacadeInterface::extendedData ( const DtString ) const

The extended data associated with the given key. Default null string.

std::map<DtString, DtString> DtVrfSimulatedSimObjectFacadeInterface::extendedDataMap ( ) const

The extended data map. Default null map.

DtString DtVrfSimulatedSimObjectFacadeInterface::extendedLabel ( int  index) const

The extended label at the given index. Default null string.

std::map<int, DtString> DtVrfSimulatedSimObjectFacadeInterface::extendedLabels ( ) const

The extended labels map. Default null map.

DtString DtVrfSimulatedSimObjectFacadeInterface::label ( ) const

Label of the object. Default null string.

bool DtVrfSimulatedSimObjectFacadeInterface::invulnerable ( ) const

Whether or not this item is invulnerable. Default false.

bool DtVrfSimulatedSimObjectFacadeInterface::invisible ( ) const

Whether or not this item is invisible. Default false.

DtEchelonId DtVrfSimulatedSimObjectFacadeInterface::echelonId ( ) const

Echelon id. Default null echelon id.

bool DtVrfSimulatedSimObjectFacadeInterface::sensorsKilled ( ) const

Whether or not the sensors are active. Default true.

bool DtVrfSimulatedSimObjectFacadeInterface::occupantsHidden ( ) const

If there are default occupants in a visual, whether or not they are hidden. Default false.

bool DtVrfSimulatedSimObjectFacadeInterface::hasPlan ( ) const

Whether or not this sim object has a plan. Default is false.

bool DtVrfSimulatedSimObjectFacadeInterface::executingPlan ( ) const

Whether or not this sime object is executing a plan. Default is false.

const DtRwProperties& DtVrfSimulatedSimObjectFacadeInterface::stateProperties ( ) const

State properties of this sim object. Default is empty properties list.

const DtRwProperties& DtVrfSimulatedSimObjectFacadeInterface::parameterProperties ( ) const

Since this is a function of the object parameters, this will always return a value whether or not this is vrf simulated.

bool DtVrfSimulatedSimObjectFacadeInterface::undetectable ( ) const

Whether or not this sim object is undetectable. Default is false.

DtString DtVrfSimulatedSimObjectFacadeInterface::activity ( ) const

If assigned, the activity this sim object is performing. Default is null string.

DtString DtVrfSimulatedSimObjectFacadeInterface::engagementRules ( ) const

The current engagement rules of this sim object. Default is fre-at-will.

bool DtVrfSimulatedSimObjectFacadeInterface::invisibleSetByUser ( ) const

Whether or not if this sim object is invisible it was set by the user. Default is false.

bool DtVrfSimulatedSimObjectFacadeInterface::isVrfSimulated ( ) const

Whether or not this sim object is simulated by VF-Forces. Default is false.

DtString DtVrfSimulatedSimObjectFacadeInterface::overlay ( ) const

If this sim object is on an overlay, what overlay is it on. Default is null string.

bool DtVrfSimulatedSimObjectFacadeInterface::fuelLevelsFrozen ( ) const

Whether or not fuel levels are frozen. Default is false.

bool DtVrfSimulatedSimObjectFacadeInterface::munitionLevelsFrozen ( ) const

Whether or not munition levels are frozen. Default is false.

bool DtVrfSimulatedSimObjectFacadeInterface::isSubordinateOfForceLevel ( ) const

Whether or not this sim object is a subordinate of force level. Default is true.

bool DtVrfSimulatedSimObjectFacadeInterface::hasTarget ( ) const

Will return true if this vrforces object has a target to fire on.

bool DtVrfSimulatedSimObjectFacadeInterface::blockParachute ( ) const

Returns true if the parachute is blocked from opening.

bool DtVrfSimulatedSimObjectFacadeInterface::onTerrainSurface ( ) const

Returns true if the DtOnTerrainSurface flag is not there or is there and is set to 1. All non vr-forces objects will return false.

virtual DtSimObjectReference DtVrfSimulatedSimObjectFacadeInterface::simObject ( ) const
protectedpure virtual

Implemented by subclasses to return the sim object this class represents.

Implemented in DtSimObjectFacade< DtVrfSimulatedSimObjectFacadeInterface >.

virtual void DtVrfSimulatedSimObjectFacadeInterface::setupDecorator ( )
protectedvirtual

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

Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)