VR-Link API Documentation for DIS
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes
DtFedTarget Class Reference

class DtFedTarget: More...

+ Collaboration diagram for DtFedTarget:

Public Member Functions

 DtFedTarget ()
 Constructor.
virtual ~DtFedTarget ()
 Destructor.
 DtFedTarget (const DtFedTarget &orig)
 copy constructor
DtFedTargetoperator= (const DtFedTarget &orig)
 assignment operator
virtual void setFomType (DtFomType type)
 Set/Get the FOM type.
virtual DtFomType fomType ()
virtual void addSpace (const char *name)=0
 Define a routing space. Used when initializing from FED file.
virtual void addDimension (const char *SpaceName, const char *dimName)=0
 Define a dimension within a routing space.
virtual void addDimension (const char *dimName, unsigned long upperBound, unsigned long defaultLowerBound, unsigned long defaultUpperBound, bool excluded)=0
 Define a dimension. Used when initializing from FED file.
virtual void addInterClass (const char *name, const char *baseName, DtTransportType transport, DtOrderType order, const char *space=0)=0
 Define a class. Used when initializing from FED file.
virtual void addParameter (const char *className, const char *paramName)=0
 Define a parameter of a class.
virtual bool addInteractionDimension (const char *interactionName, const char *dimension)=0
 Add regions to the class Return true if add was successful (i.e., dimension is valid)
virtual void addObjClass (const char *name, const char *baseName)=0
 Define a class. Used when initializing from FED file.
virtual void addAttribute (const char *className, const char *attributeName, DtTransportType transport, DtOrderType order, const char *space=0)=0
 Define an attribute of a class.
virtual bool addAttributeDimension (const char *className, const char *attrName, const char *dimName)=0
 Define the dimensions of an attribute Return true if add was successful (i.e., dimension is valid)
virtual bool autoProvide () const
 switches
virtual void setAutoProvide (bool value)
virtual bool conveyRegionDesignatorSets () const
 Set/Get convey region designator sets switch.
virtual void setConveyRegionDesignatorSets (bool value)
virtual bool conveyProducingFederate () const
 Set/Get convey producing federate switch.
virtual void setConveyProducingFederate (bool value)
virtual bool attributeScopeAdvisory () const
 Set/Get attribute scople advisory switch.
virtual void setAttributeScopeAdvisory (bool value)
virtual bool attributeRelevanceAdvisory () const
 Set/Get attribute relevance advisory switch.
virtual void setAttributeRelevanceAdvisory (bool value)
virtual bool objectClassRelevanceAdvisory () const
 Set/Get object class relevance advisory switch.
virtual void setObjectClassRelevanceAdvisory (bool value)
virtual bool interactionRelevanceAdvisory () const
 Set/Get ineraction relevance advisory switch.
virtual void setInteractionRelevanceAdvisory (bool value)
virtual bool serviceReporting () const
 Set/Get service reporting switch.
virtual void setServiceReporting (bool value)
virtual bool exceptionReporting () const
 Set/Get exception reporting switch.
virtual void setExceptionReporting (bool value)
virtual bool delaySubscriptionEvaluation () const
 Set/Get delay subscription evaluation switch.
virtual void setDelaySubscriptionEvaluation (bool value)
virtual DtResignAction automaticResignAction () const
 Set/Get Automatic Resign Action switch.
virtual void setAutomaticResignAction (DtResignAction value)
virtual bool knownUpdateRate (const DtString updateRateName) const
 Is the specified updateRate specified.
virtual void addUpdateRate (const DtString updateRateName, float rate)
 Add an updateRate from the FOM.
DtString updateRateNameByHandle (unsigned long handle)
 Get the update Rate Name associated with this handle.

Static Public Member Functions

static void setDefaultAutoProvide (bool onOff)
 Set/Get the default auto provide.
static bool defaultAutoProvide ()
static void setDefaultConveyRegionDesignatorSets (bool onOff)
 Set/Get the default convey region.
static bool defaultConveyRegionDesignatorSets ()
static void setDefaultConveyProducingFederate (bool onOff)
 Set/Get the default convey producing federate.
static bool defaultConveyProducingFederate ()
static void setDefaultObjectClassRelevanceAdvisory (bool onOff)
 Set/Get the default class relevance advisory.
static bool defaultObjectClassRelevanceAdvisory ()
static void setDefaultAttributeRelevanceAdvisory (bool onOff)
 Set/Get the default attribute relevance advisory.
static bool defaultAttributeRelevanceAdvisory ()
static void setDefaultAttributeScopeAdvisory (bool onOff)
 Set/Get the default attribute scope advisory.
static bool defaultAttributeScopeAdvisory ()
static void setDefaultInteractionRelevanceAdvisory (bool onOff)
 Set/Get the default interaction relevance advisory.
static bool defaultInteractionRelevanceAdvisory ()
static void setDefaultServiceReporting (bool onOff)
 Set/Get the default service reporting.
static bool defaultServiceReporting ()
static void setDefaultExceptionReporting (bool onOff)
 set/get the default exception reporting
static bool defaultExceptionReporting ()
static void setDefaultAutomaticResignAction (DtResignAction val)
 set/get the automatic resign action
static DtResignAction defaultAutomaticResignAction ()

Protected Attributes

bool myAutoProvide
bool myConveyRegionDesignatorSets
bool myConveyProducingFederate
bool myAttributeScopeAdvisory
bool myAttributeRelevanceAdvisory
bool myObjectClassRelevanceAdvisory
bool myInteractionRelevanceAdvisory
bool myServiceReporting
bool myExceptionReporting
bool myDelaySubscriptionEvaluation
DtResignAction myAutomaticResignAction
DtFomType myFomType
std::vector< float > myUpdateRates
 Index of update rates.
DtUpdateRateHandleByNameMap myUpdateRateHandleByName
 Map from update rate name to handle.
DtUpdateRateNameByHandleMap myUpdateRateNameByHandle
 Map from update rate handle to name.

Static Protected Attributes

static bool theDefaultAutoProvide
static bool theDefaultConveyRegionDesignatorSets
static bool theDefaultConveyProducingFederate
static bool theDefaultObjectClassRelevanceAdvisory
static bool theDefaultAttributeRelevanceAdvisory
static bool theDefaultAttributeScopeAdvisory
static bool theDefaultInteractionRelevanceAdvisory
static bool theDefaultServiceReporting
static bool theDefaultExceptionReporting
static DtResignAction theDefaultAutomaticResignAction

Detailed Description

class DtFedTarget:

DtFedTarget is an abstract class representing some representation of FED file data that can be filled in by a DtFedReader.

Constructor & Destructor Documentation

DtFedTarget::DtFedTarget ( )

Constructor.

virtual DtFedTarget::~DtFedTarget ( )
virtual

Destructor.

DtFedTarget::DtFedTarget ( const DtFedTarget orig)

copy constructor

Member Function Documentation

virtual void DtFedTarget::addAttribute ( const char *  className,
const char *  attributeName,
DtTransportType  transport,
DtOrderType  order,
const char *  space = 0 
)
pure virtual

Define an attribute of a class.

Used when initializing from FED file.

virtual bool DtFedTarget::addAttributeDimension ( const char *  className,
const char *  attrName,
const char *  dimName 
)
pure virtual

Define the dimensions of an attribute Return true if add was successful (i.e., dimension is valid)

virtual void DtFedTarget::addDimension ( const char *  SpaceName,
const char *  dimName 
)
pure virtual

Define a dimension within a routing space.

Used when initializing from FED file.

virtual void DtFedTarget::addDimension ( const char *  dimName,
unsigned long  upperBound,
unsigned long  defaultLowerBound,
unsigned long  defaultUpperBound,
bool  excluded 
)
pure virtual

Define a dimension. Used when initializing from FED file.

virtual bool DtFedTarget::addInteractionDimension ( const char *  interactionName,
const char *  dimension 
)
pure virtual

Add regions to the class Return true if add was successful (i.e., dimension is valid)

virtual void DtFedTarget::addInterClass ( const char *  name,
const char *  baseName,
DtTransportType  transport,
DtOrderType  order,
const char *  space = 0 
)
pure virtual

Define a class. Used when initializing from FED file.

virtual void DtFedTarget::addObjClass ( const char *  name,
const char *  baseName 
)
pure virtual

Define a class. Used when initializing from FED file.

virtual void DtFedTarget::addParameter ( const char *  className,
const char *  paramName 
)
pure virtual

Define a parameter of a class.

Used when initializing from FED file.

virtual void DtFedTarget::addSpace ( const char *  name)
pure virtual

Define a routing space. Used when initializing from FED file.

virtual void DtFedTarget::addUpdateRate ( const DtString  updateRateName,
float  rate 
)
virtual

Add an updateRate from the FOM.

virtual bool DtFedTarget::attributeRelevanceAdvisory ( ) const
virtual

Set/Get attribute relevance advisory switch.

virtual bool DtFedTarget::attributeScopeAdvisory ( ) const
virtual

Set/Get attribute scople advisory switch.

virtual DtResignAction DtFedTarget::automaticResignAction ( ) const
virtual

Set/Get Automatic Resign Action switch.

virtual bool DtFedTarget::autoProvide ( ) const
virtual

switches

Set/Get auto provide switch

virtual bool DtFedTarget::conveyProducingFederate ( ) const
virtual

Set/Get convey producing federate switch.

virtual bool DtFedTarget::conveyRegionDesignatorSets ( ) const
virtual

Set/Get convey region designator sets switch.

static bool DtFedTarget::defaultAttributeRelevanceAdvisory ( )
static
static bool DtFedTarget::defaultAttributeScopeAdvisory ( )
static
static DtResignAction DtFedTarget::defaultAutomaticResignAction ( )
static
static bool DtFedTarget::defaultAutoProvide ( )
static
static bool DtFedTarget::defaultConveyProducingFederate ( )
static
static bool DtFedTarget::defaultConveyRegionDesignatorSets ( )
static
static bool DtFedTarget::defaultExceptionReporting ( )
static
static bool DtFedTarget::defaultInteractionRelevanceAdvisory ( )
static
static bool DtFedTarget::defaultObjectClassRelevanceAdvisory ( )
static
static bool DtFedTarget::defaultServiceReporting ( )
static
virtual bool DtFedTarget::delaySubscriptionEvaluation ( ) const
virtual

Set/Get delay subscription evaluation switch.

virtual bool DtFedTarget::exceptionReporting ( ) const
virtual

Set/Get exception reporting switch.

virtual DtFomType DtFedTarget::fomType ( )
virtual
virtual bool DtFedTarget::interactionRelevanceAdvisory ( ) const
virtual

Set/Get ineraction relevance advisory switch.

virtual bool DtFedTarget::knownUpdateRate ( const DtString  updateRateName) const
virtual

Is the specified updateRate specified.

virtual bool DtFedTarget::objectClassRelevanceAdvisory ( ) const
virtual

Set/Get object class relevance advisory switch.

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

assignment operator

virtual bool DtFedTarget::serviceReporting ( ) const
virtual

Set/Get service reporting switch.

virtual void DtFedTarget::setAttributeRelevanceAdvisory ( bool  value)
virtual
virtual void DtFedTarget::setAttributeScopeAdvisory ( bool  value)
virtual
virtual void DtFedTarget::setAutomaticResignAction ( DtResignAction  value)
virtual
virtual void DtFedTarget::setAutoProvide ( bool  value)
virtual
virtual void DtFedTarget::setConveyProducingFederate ( bool  value)
virtual
virtual void DtFedTarget::setConveyRegionDesignatorSets ( bool  value)
virtual
static void DtFedTarget::setDefaultAttributeRelevanceAdvisory ( bool  onOff)
static

Set/Get the default attribute relevance advisory.

static void DtFedTarget::setDefaultAttributeScopeAdvisory ( bool  onOff)
static

Set/Get the default attribute scope advisory.

static void DtFedTarget::setDefaultAutomaticResignAction ( DtResignAction  val)
static

set/get the automatic resign action

static void DtFedTarget::setDefaultAutoProvide ( bool  onOff)
static

Set/Get the default auto provide.

static void DtFedTarget::setDefaultConveyProducingFederate ( bool  onOff)
static

Set/Get the default convey producing federate.

static void DtFedTarget::setDefaultConveyRegionDesignatorSets ( bool  onOff)
static

Set/Get the default convey region.

static void DtFedTarget::setDefaultExceptionReporting ( bool  onOff)
static

set/get the default exception reporting

static void DtFedTarget::setDefaultInteractionRelevanceAdvisory ( bool  onOff)
static

Set/Get the default interaction relevance advisory.

static void DtFedTarget::setDefaultObjectClassRelevanceAdvisory ( bool  onOff)
static

Set/Get the default class relevance advisory.

static void DtFedTarget::setDefaultServiceReporting ( bool  onOff)
static

Set/Get the default service reporting.

virtual void DtFedTarget::setDelaySubscriptionEvaluation ( bool  value)
virtual
virtual void DtFedTarget::setExceptionReporting ( bool  value)
virtual
virtual void DtFedTarget::setFomType ( DtFomType  type)
virtual

Set/Get the FOM type.

virtual void DtFedTarget::setInteractionRelevanceAdvisory ( bool  value)
virtual
virtual void DtFedTarget::setObjectClassRelevanceAdvisory ( bool  value)
virtual
virtual void DtFedTarget::setServiceReporting ( bool  value)
virtual
DtString DtFedTarget::updateRateNameByHandle ( unsigned long  handle)

Get the update Rate Name associated with this handle.

Member Data Documentation

bool DtFedTarget::myAttributeRelevanceAdvisory
protected
bool DtFedTarget::myAttributeScopeAdvisory
protected
DtResignAction DtFedTarget::myAutomaticResignAction
protected
bool DtFedTarget::myAutoProvide
protected
bool DtFedTarget::myConveyProducingFederate
protected
bool DtFedTarget::myConveyRegionDesignatorSets
protected
bool DtFedTarget::myDelaySubscriptionEvaluation
protected
bool DtFedTarget::myExceptionReporting
protected
DtFomType DtFedTarget::myFomType
protected
bool DtFedTarget::myInteractionRelevanceAdvisory
protected
bool DtFedTarget::myObjectClassRelevanceAdvisory
protected
bool DtFedTarget::myServiceReporting
protected
DtUpdateRateHandleByNameMap DtFedTarget::myUpdateRateHandleByName
protected

Map from update rate name to handle.

DtUpdateRateNameByHandleMap DtFedTarget::myUpdateRateNameByHandle
protected

Map from update rate handle to name.

std::vector<float> DtFedTarget::myUpdateRates
protected

Index of update rates.

bool DtFedTarget::theDefaultAttributeRelevanceAdvisory
staticprotected
bool DtFedTarget::theDefaultAttributeScopeAdvisory
staticprotected
DtResignAction DtFedTarget::theDefaultAutomaticResignAction
staticprotected
bool DtFedTarget::theDefaultAutoProvide
staticprotected
bool DtFedTarget::theDefaultConveyProducingFederate
staticprotected
bool DtFedTarget::theDefaultConveyRegionDesignatorSets
staticprotected
bool DtFedTarget::theDefaultExceptionReporting
staticprotected
bool DtFedTarget::theDefaultInteractionRelevanceAdvisory
staticprotected
bool DtFedTarget::theDefaultObjectClassRelevanceAdvisory
staticprotected
bool DtFedTarget::theDefaultServiceReporting
staticprotected

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

Document ID: Generated on Wed Aug 14 15:35:11 EDT 2013 from SVN revision 130445
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)