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

A readable, writable type whose name is the name of a component and that has a list of component names and port interfaces to connect to.

Developer Description: DtComponentDescriptor provides all the infrastructure needed to work with the component factory. It has setComponentType() and componentType() members for setting and inspecting the type of component being attached to the entity. The type() member function describes the type of the component descriptor to the component descriptor factory, as found in compDescTypes.h.

Related Examples using DtComponentDescriptor include

The DtComponentDescriptor class implements the functionality of the DtScriptEnableControllerDescriptor.

Inherits DtReaderWriter.

Inherited by DtActuatorComponentDescriptor, DtAggregateCombatAdjustmentDescriptor, DtAggregatedMoveToDescriptor, DtAggregateFollowDescriptor, DtAggregateLoadoutControllerDescriptor, DtAggregateMountedMovementRelayControllerDescriptor, DtAggregateMountedMovementSwitcherDescriptor, DtAggregateMoveIntoFormationDescriptor, DtAimWeaponControllerDescriptor, DtAirportLightingControllerDescriptor, DtAirVehicleWeaponHoldControllerDescriptor, DtBallisticGunControllerDescriptor, DtBaseWeaponControllerDescriptor, DtCombatRangeControllerDescriptor, DtContactFusionDescriptor, DtCruiseMissileLaunchControllerDescriptor, DtDetonationControllerDescriptor, DtDiGuyControllerDescriptor, DtDynamicTerrainControllerDescriptor, DtEmbarkationDescriptor, DtEmbeddedEntitiesDescriptor, DtEmergencyBeaconDescriptor, DtEmitterComponentDescriptor, DtEngagementReportGeneratorControllerDescriptor, DtEventTriggerControllerDescriptor, DtFixedWingGunneryControllerDescriptor, DtFixedWingLandingDescriptor, DtFixedWingPilotControllerDescriptor, DtFixedWingTakeoffDescriptor, DtFormationControllerDescriptor, DtGroundCollisionAvoidanceDescriptor, DtGroundMoveDirectionControllerDescriptor, DtGroundMoveToDescriptor, DtGroundVehicleTrailingEffectControllerDescriptor, DtHumanCrosswalkControllerDescriptor, DtHumanFleeControllerDescriptor, DtHumanFollowControllerDescriptor, DtHumanMoveAlongControllerDescriptor, DtHumanMoveToControllerDescriptor, DtHumanUseDoorControllerDescriptor, DtIffControllerDescriptor, DtIndirectFireSupportControllerDescriptor, DtIndividualLifeformAcquireDescriptor, DtJoyDeviceControllerDescriptorTemplate< DtComponentDescriptor >, DtLaserDetectorDescriptor, DtLaserGuidedLauncherControllerDescriptor, DtLasingControllerDescriptor, DtLasingMissileTrackControllerDescriptor, DtLaunchExpendableResourceControllerDescriptor, DtLaunchSmokeControllerDescriptor, DtLimitExistenceControllerDescriptor, DtMinefieldControllerDescriptor, DtMissileDistractionControllerDescriptor, DtNavigationPreferenceDescriptor, DtNavTagTraversalControllerDescriptor, DtObjectSensorDescriptor, DtObstructionSensorDescriptor, DtOccupancyDirectorDescriptor, DtPropulsionNoiseGeneratorDescriptor, DtRadarWarningReceiverDescriptor, DtRailPathControllerDescriptor, DtResupplyControllerDescriptor, DtResupplyReceiverControllerDescriptor, DtResupplySupplierControllerDescriptor, DtRoadMovementDescriptor, DtRotaryWingLandingGearDescriptor, DtRotaryWingTaskDescriptor, DtRotorWashControllerDescriptor, DtScriptEnableControllerDescriptor, DtSetControllerDescriptor, DtSimpleProximitySensorDescriptor, DtSpawnControllerDescriptor, DtSpotReportGeneratorControllerDescriptor, DtSpotReportReceiverDescriptor, DtStatePropertyInitializationControllerDescriptor, DtSurfaceEntityPilotControllerDescriptor, DtTacanComponentDescriptor, DtTDLMessageGeneratorControllerDescriptor, DtTerrainPreloadControllerDescriptor, DtTerrainProximityIndicatorDescriptor, DtTimeKeeperDescriptor, DtTurretAcquireControllerDescriptor, DtTurretReturnToHeadingControllerDescriptor, DtTurretScanComponentDescriptor, DtUnderFireDeterminationComponentDescriptor, and DtVrfObjectDataMessengerDescriptor.

Public Member Functions

 DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
DtComponentDescriptor & operator= (const DtComponentDescriptor &orig)
 
virtual ~DtComponentDescriptor ()
 
virtual DtString type () const
 
virtual DtComponentDescriptor * clone (DtReaderWriterRegistry *parentRegistry=NULL) const
 
virtual void putData (std::string &fp, int indentLevel=0)
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual bool init ()
 
bool operator== (const DtComponentDescriptor &) const
 
constructor
Parameters
componentNameDtReaderWriter name of the component. This is the name of the descriptor entry as it appears in a parameter database file.
parentRegistryThe registry of the DtReaderWriter object to which this object belongs.
 DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual void setComponentType (const DtString &componentType)
 
virtual const DtString & componentType () const
 
virtual void setMinTickPeriod (DtReal minTickPeriod)
 
virtual DtReal minTickPeriod () const
 
virtual void setMinTickPeriodVariance (DtReal minTickPeriodVariance)
 
virtual DtReal minTickPeriodVariance () const
 
virtual void setTickPeriodUsesRealTime (bool value)
 
virtual bool tickPeriodUsesRealTime () const
 
virtual const DtString & processStateRepositoryName () const
 
virtual void setProcessStateRepositoryName (const DtString &name)
 
virtual const DtString & processStateRepositoryType () const
 
virtual void setProcessStateRepositoryType (const DtString &type)
 
virtual void setIsEnabled (bool yesNo)
 
virtual bool isEnabled () const
 
virtual void setDebugActive (bool active)
 
virtual bool debugActive () const
 
virtual void setMinTaskVisualizationTickPeriod (DtReal minTickPeriod)
 
virtual DtReal minTaskVisualizationTickPeriod () const
 
virtual void setTaskVisualizationsEnabled (bool enabled)
 
virtual bool taskVisualizationsEnabled () const
 
virtual void setCreateComponent (bool yesNo)
 
virtual bool createComponent () const
 
virtual void setCreateOnRemoteObject (bool yesNo)
 
virtual bool createOnRemoteObject () const
 
virtual const
DtRwNLengthStringVector & 		scriptIds () const
 
virtual DtRwNLengthStringVector & scriptIds ()
 
virtual const
DtRwScriptVariablesList & 		scriptVariables () const
 
virtual DtRwScriptVariablesList & scriptVariables ()
 
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 
const DtReaderWriter & operator= (const DtReaderWriter &orig)
 
bool operator== (const DtReaderWriter &) const
 
bool operator!= (const DtReaderWriter &rhs)
 
virtual ~DtReaderWriter ()
 
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
virtual void postPutSelf ()
 
virtual void prePutSelf ()
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
virtual void postGetSelf ()
 
virtual void preGetSelf ()
 
virtual void writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
virtual DtSymbolString name () const
 
virtual void addAlias (const DtSymbolString &alias)
 
virtual void addAlias (const DtString &alias)
 
virtual bool hasAlias (const DtSymbolString &alias)
 
virtual const aliasContainer & aliases () const
 
virtual void setReadonly (bool flag)
 
bool isReadonly () const
 
virtual void reset ()
 
virtual int alignment () const
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 
virtual void setName (const DtString &)
 
virtual const char * readerWriterType () const
 
virtual const char * xmlType () const
 
virtual DtString prettyPrint () const
 
std::string debugText () const
 
virtual void bindVariables (DtVariableBindingsList variableBindings)
 
virtual std::list
< DtVariableNameType > 		unboundVariables () const
 
bool invalid () const
 
virtual bool hasChild (const DtReaderWriter *p) const
 
virtual bool hasVariableReference () const
 
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 
virtual void recordUpdateTime () const
 
virtual bool wasUpdatedSince (DtTime t) const
 
virtual bool changedSinceLastChecked ()
 
virtual bool peekChangedSinceLastChecked () const
 
virtual void setValueSpecified (bool specified, bool recurse=false)
 
virtual bool valueSpecified () const
 
virtual bool isVariableReference () const
 
virtual void setIsVariableReference (bool value)
 
virtual void clearAllVariableReferenceFlags ()
 
virtual DtSymbolString variableName () const
 
virtual void setVariableName (const DtSymbolString variableName)
 
virtual const DtReaderWriter * defaultRWValue () const
 
virtual DtReaderWriter * defaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
const DtReaderWriterRegistry & registry () const
 
DtReaderWriterRegistry & registry ()
 
virtual DtPropertyInterface * property ()
 
virtual const DtPropertyInterface * property () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindings * generateVariableBindings () const
 
virtual bool toXml (const DtFilename &) const
 
virtual bool fromXml (const DtString &)
 
virtual bool fromXmlFile (const DtFilename &)
 
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 

Static Public Member Functions

static void addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
 
static DtComponentDescriptor * createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
static DtComponentDescriptor * createComponentDescriptor (const char *pName)
 
static DtComponentDescriptor * creator ()
 
static
DtComponentDescriptorFactory * 		factory ()
 
static void setFactory (DtComponentDescriptorFactory *factory)
 
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (std::string &fp, int indentLevel)
 
static const
DtVariableBindingsList & 		nullVariableReference ()
 
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
 
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
 
static void setPutIndent (bool)
 
static bool putIndent ()
 
static const char * theXmlType ()
 
static const DtFilename & appPath ()
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactory * factory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWriter * createFromXmlFile (const DtFilename &, bool createAsProperty=false)
 
static DtReaderWriter * createFromXml (const DtString &, bool createAsProperty=false)
 
static DtReaderWriter * createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 

Protected Member Functions

 DtComponentDescriptor ()
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 

Protected Attributes

parameters

These parameters are used to implement the functionality of the DtScriptEnableControllerDescriptor.

DtRwString myComponentType
 
DtRwReal myMinTickPeriod
 
DtRwReal myMinTickPeriodVariance
 
DtRwBoolean myTickPeriodUsesRealTime
 
DtRwString myProcessStateRepositoryName
 
DtRwString myProcessStateRepositoryType
 
DtRwBoolean myIsEnabled
 
DtRwBoolean myDebug
 
DtRwReal myMinTaskVisualizationTickPeriod
 
DtRwBoolean myTaskVisualizationsEnabled
 
DtRwBoolean myCreateComponent
 
DtRwBoolean myCreateOnRemoteObject
 
DtRwNLengthStringVector myScriptIds
 
DtRwScriptVariablesList myScriptVariables
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistry * myParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWriter * myDefaultValue
 
aliasContainer myAliases
 
bool myInvalid
 
bool myChangedFlag
 

Static Protected Attributes

static
DtComponentDescriptorFactory * 		myFactory
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactory * theFactory
 
static
DtReaderWriterFactoryCreatorFcn 		theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Additional Inherited Members

- Public Types inherited from DtReaderWriter
typedef std::vector
< DtSymbolString > 		aliasContainer
 
typedef std::vector
< DtSymbolString >::iterator 		aliasIter
 
typedef std::vector
< DtSymbolString >
::const_iterator 		aliasConstIter
 
typedef std::vector< DtFilename > SearchPaths
 
typedef std::pair
< DtSymbolString, DtString > 		DtVariableNameType
 
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
 

Constructor & Destructor Documentation

DtComponentDescriptor::DtComponentDescriptor ( const DtString &  componentName,
DtReaderWriterRegistry *  parentRegistry = NULL 
)
DtComponentDescriptor::DtComponentDescriptor ( const DtSymbolString &  componentName,
DtReaderWriterRegistry *  parentRegistry = NULL 
)
DtComponentDescriptor::DtComponentDescriptor ( const DtComponentDescriptor &  orig,
DtReaderWriterRegistry *  parentRegistry = NULL 
)

copy constructor

Parameters
origComponent descriptor to copy.
parentRegistryThe registry of the DtReaderWriter object to which this object belongs.
virtual DtComponentDescriptor::~DtComponentDescriptor ( )
virtual
DtComponentDescriptor::DtComponentDescriptor ( )
protected

default constructor; not implemented

Member Function Documentation

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

assignment

virtual DtString DtComponentDescriptor::type ( ) const
virtual

Returns the type of component this descriptor describes. Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Reimplemented in DtJoyDeviceControllerDescriptor, DtSwingingPartActuatorDescriptor, DtActuatorComponentDescriptor, DtSurfaceEntityPilotControllerDescriptor, DtAggregatedMovementDescriptor, DtLaunchExpendableResourceControllerDescriptor, DtTurretAcquireControllerDescriptor, DtAggregateMountedMovementRelayControllerDescriptor, DtDamageAdjudicationComponentDescriptor, DtObstructionSensorDescriptor, DtBallisticGunDescriptor, DtGroundCollisionAvoidanceDescriptor, DtLasingControllerDescriptor, DtLaserDetectorDescriptor, DtFixedWingFollowEntityControllerDescriptor, DtBaseWeaponControllerDescriptor, DtFixedWingPilotControllerDescriptor, DtIndirectFireControllerDescriptor, DtSignatureObjectSensorDescriptor, DtAggregateMountedMovementSwitcherDescriptor, DtAggregateMoveIntoFormationDescriptor, DtBallisticGunJoyControllerDescriptor, DtEmitterComponentDescriptor, DtIndLifeformLauncherAcquireDescriptor, DtOccupancyDirectorDescriptor, DtCombatRangeControllerDescriptor, DtVrfObjectDataMessengerDescriptor, DtAggregateMoveAlongDescriptor, DtElevatingBallisticGunControllerDescriptor, DtFixedWingFlyIntoControllerDescriptor, DtLimitExistenceControllerDescriptor, DtObjectSensorDescriptor, DtRadarObjectSensorDescriptor, DtSurfaceEntityActuatorDescriptor, DtAggregateEmbarkationDescriptor, DtBallisticGunControllerDescriptor, DtDynamicTerrainVehicleTrackControllerDescriptor, DtFixedWingActuatorDescriptor, DtGroundFollowEntityDescriptor, DtGroundMoveToDescriptor, DtSearchRescueSensorDescriptor, DtTurretScanComponentDescriptor, DtDetonationControllerDescriptor, DtLauncherActuatorDescriptor, DtMissileDistractionControllerDescriptor, DtSimpleProximitySensorDescriptor, DtSpotReportGeneratorControllerDescriptor, DtSurfaceEntityRoutePilotDescriptor, DtTacanComponentDescriptor, DtTurretComponentDescriptor, DtAzimuthMountComponentDescriptor, DtElevationMountComponentDescriptor, DtEmergencyBeaconDescriptor, DtEngagementReportGeneratorControllerDescriptor, DtEventTriggerControllerDescriptor, DtFixedWingDefaultControllerDescriptor, DtFormationControllerDescriptor, DtIffControllerDescriptor, DtRotaryWingActuatorDescriptor, DtFixedWingLandingDescriptor, DtFixedWingTakeoffDescriptor, DtHumanJoystickMovementControllerDescriptor, DtLaunchSmokeControllerDescriptor, DtParabolicTrajectoryActuatorDescriptor, DtTacticalSmokeActuatorDescriptor, DtTDLPPLIMessageGeneratorControllerDescriptor, DtTranslatablePartActuatorDescriptor, DtUnderFireDeterminationComponentDescriptor, DtActiveSonarSensorDescriptor, DtAirVehicleWeaponHoldControllerDescriptor, DtCruiseMissileLaunchControllerDescriptor, DtIndividualLifeformAcquireDescriptor, DtMultipleHitDamageActuatorDescriptor, DtRotaryWingJoyDeviceControllerDescriptor, DtRotaryWingRouteTaskDescriptor, DtSensorGimbalActuatorDescriptor, DtSpotReportReceiverDescriptor, DtWarheadDetonationActuatorDescriptor, DtConvoyDescriptor, DtDieWhenHitDescriptor, DtHumanMovementActuatorDescriptor, DtRotaryWingPilotDescriptor, DtTDLContactMessageGeneratorControllerDescriptor, DtWeaponControllerDescriptor, DtContactFusionDescriptor, DtEmbarkationDescriptor, DtEngineeringObjectSensorDescriptor, DtFixedWingGunneryControllerDescriptor, DtLaserGuidedLauncherControllerDescriptor, DtMinefieldControllerDescriptor, DtNbcSensorDescriptor, DtRoadMovementDescriptor, DtRotaryWingTaskDescriptor, DtSpawnControllerDescriptor, DtTDLMessageGeneratorControllerDescriptor, DtTrailerActuatorDescriptor, DtAggregateFollowDescriptor, DtAggregateMountedSetRelayDescriptor, DtAutomotiveActuatorDescriptor, DtEmbeddedEntitiesDescriptor, DtIntegratedLaserGuidedLauncherDescriptor, DtPassiveSonarSensorDescriptor, DtRailPathControllerDescriptor, DtTurretReturnToHeadingControllerDescriptor, DtWeaponActuatorDescriptor, DtRadarWarningReceiverDescriptor, DtAggregateReleaseBombControllerDescriptor, DtAirRefuelSupplierControllerDescriptor, DtDiGuyControllerDescriptor, DtGlobalEnvironmentActuatorDescriptor, DtHumanDamageActuatorDescriptor, DtHumanFollowControllerDescriptor, DtHumanMoveToControllerDescriptor, DtLasingMissileTrackControllerDescriptor, DtNavigationPreferenceDescriptor, DtSuppressionActuatorDescriptor, DtAggregateLoadoutControllerDescriptor, DtDynamicTerrainControllerDescriptor, DtEncumbranceActuatorDescriptor, DtHumanGunActuatorDescriptor, DtHumanWeaponStateActuatorDescriptor, DtLookAtActuatorDescriptor, DtMovementBasedTerrainPreloadControllerDescriptor, DtNavMovementActuatorDescriptor, DtRadarJammerDescriptor, DtRotaryWingEncumberedFlightActuatorDescriptor, DtRotorWashControllerDescriptor, DtAggregatedMoveToDescriptor, DtAirportLightingControllerDescriptor, DtGroundMoveDirectionControllerDescriptor, DtHumanCrosswalkControllerDescriptor, DtHumanUseDoorControllerDescriptor, DtIndirectFireActuatorDescriptor, DtMissileLauncherActuatorDescriptor, DtNavTagTraversalControllerDescriptor, DtSensorGimbalControllerDescriptor, DtAggregateAntiAirControllerDescriptor, DtAggregatedMoveAlongDescriptor, DtAimWeaponControllerDescriptor, DtDynamicTerrainMunitionDamageControllerDescriptor, DtHumanFleeControllerDescriptor, DtIndirectFireSupportControllerDescriptor, DtResupplyControllerDescriptor, DtResupplyReceiverControllerDescriptor, DtResupplySupplierControllerDescriptor, DtRotaryWingLandingGearDescriptor, DtScriptEnableControllerDescriptor, DtSetControllerDescriptor, DtAggregateIndirectFireControllerDescriptor, DtDestroyEngineeringObjectControllerDescriptor, DtExtendablePartActuatorDescriptor, DtNbcWeaponControllerDescriptor, DtPropulsionNoiseGeneratorDescriptor, DtSpawnObjectWarheadActuatorDescriptor, DtTerrainProximityIndicatorDescriptor, DtBreachObstacleControllerDescriptor, DtCreateEngineeringObjectControllerDescriptor, DtHumanMoveAlongControllerDescriptor, DtJammerEmitterDescriptor, DtNonLethalDamageActuatorDescriptor, DtRotaryWingFollowTaskDescriptor, DtStatePropertyInitializationControllerDescriptor, DtTerrainPreloadControllerDescriptor, DtAggregateCombatAdjustmentDescriptor, DtTimeKeeperDescriptor, DtFallingFromSkyActuatorDescriptor, DtGroundVehicleTrailingEffectControllerDescriptor, DtIndirectArtilleryDescriptor, DtParachuteActuatorDescriptor, DtParachuteControllerDescriptor, and DtAirborneAggregatedMovementDescriptor.

virtual DtComponentDescriptor* DtComponentDescriptor::clone ( DtReaderWriterRegistry *  parentRegistry = NULL) const
virtual

Reimplemented in DtObjectSensorDescriptor, DtIndirectFireControllerDescriptor, DtJoyDeviceControllerDescriptor, DtCruiseMissileLaunchControllerDescriptor, DtSwingingPartActuatorDescriptor, DtLaserGuidedLauncherControllerDescriptor, DtAggregateMoveAlongDescriptor, DtGroundFollowEntityDescriptor, DtObstructionSensorDescriptor, DtTurretAcquireControllerDescriptor, DtFixedWingFollowEntityControllerDescriptor, DtRailPathControllerDescriptor, DtGroundCollisionAvoidanceDescriptor, DtRoadMovementDescriptor, DtActuatorComponentDescriptor, DtAggregateMoveIntoFormationDescriptor, DtTurretScanComponentDescriptor, DtGroundMoveToDescriptor, DtMissileDistractionControllerDescriptor, DtSurfaceEntityPilotControllerDescriptor, DtLaunchExpendableResourceControllerDescriptor, DtAggregatedMovementDescriptor, DtAggregateMountedMovementRelayControllerDescriptor, DtDamageAdjudicationComponentDescriptor, DtEmbeddedEntitiesDescriptor, DtSpotReportReceiverDescriptor, DtBallisticGunDescriptor, DtLasingControllerDescriptor, DtMinefieldControllerDescriptor, DtLaserDetectorDescriptor, DtSignatureObjectSensorDescriptor, DtAggregateMountedMovementSwitcherDescriptor, DtBaseWeaponControllerDescriptor, DtFixedWingPilotControllerDescriptor, DtTurretReturnToHeadingControllerDescriptor, DtEmitterComponentDescriptor, DtOccupancyDirectorDescriptor, DtCombatRangeControllerDescriptor, DtSearchRescueSensorDescriptor, DtAggregateEmbarkationDescriptor, DtConvoyDescriptor, DtDieWhenHitDescriptor, DtElevatingBallisticGunControllerDescriptor, DtFixedWingFlyIntoControllerDescriptor, DtFormationControllerDescriptor, DtLimitExistenceControllerDescriptor, DtRadarObjectSensorDescriptor, DtSurfaceEntityActuatorDescriptor, DtBallisticGunControllerDescriptor, DtDynamicTerrainVehicleTrackControllerDescriptor, DtFixedWingActuatorDescriptor, DtSurfaceEntityRoutePilotDescriptor, DtAggregateFollowDescriptor, DtAzimuthMountComponentDescriptor, DtDetonationControllerDescriptor, DtLauncherActuatorDescriptor, DtSimpleProximitySensorDescriptor, DtTacanComponentDescriptor, DtTurretComponentDescriptor, DtElevationMountComponentDescriptor, DtEmergencyBeaconDescriptor, DtEventTriggerControllerDescriptor, DtFixedWingDefaultControllerDescriptor, DtIffControllerDescriptor, DtRotaryWingActuatorDescriptor, DtFixedWingLandingDescriptor, DtFixedWingTakeoffDescriptor, DtLaunchSmokeControllerDescriptor, DtParabolicTrajectoryActuatorDescriptor, DtRotaryWingRouteTaskDescriptor, DtTacticalSmokeActuatorDescriptor, DtUnderFireDeterminationComponentDescriptor, DtActiveSonarSensorDescriptor, DtIndividualLifeformAcquireDescriptor, DtIndLifeformLauncherAcquireDescriptor, DtMultipleHitDamageActuatorDescriptor, DtRotaryWingPilotDescriptor, DtSensorGimbalActuatorDescriptor, DtWarheadDetonationActuatorDescriptor, DtHumanMovementActuatorDescriptor, DtRotaryWingTaskDescriptor, DtVrfObjectDataMessengerDescriptor, DtWeaponControllerDescriptor, DtContactFusionDescriptor, DtEmbarkationDescriptor, DtEngineeringObjectSensorDescriptor, DtFixedWingGunneryControllerDescriptor, DtNbcSensorDescriptor, DtTrailerActuatorDescriptor, DtAggregateMountedSetRelayDescriptor, DtAutomotiveActuatorDescriptor, DtIntegratedLaserGuidedLauncherDescriptor, DtPassiveSonarSensorDescriptor, DtTranslatablePartActuatorDescriptor, DtWeaponActuatorDescriptor, DtAggregateReleaseBombControllerDescriptor, DtGlobalEnvironmentActuatorDescriptor, DtHumanFollowControllerDescriptor, DtHumanMoveToControllerDescriptor, DtLasingMissileTrackControllerDescriptor, DtNavigationPreferenceDescriptor, DtSpotReportGeneratorControllerDescriptor, DtSuppressionActuatorDescriptor, DtAggregateLoadoutControllerDescriptor, DtAirVehicleWeaponHoldControllerDescriptor, DtDynamicTerrainControllerDescriptor, DtEncumbranceActuatorDescriptor, DtEngagementReportGeneratorControllerDescriptor, DtHumanGunActuatorDescriptor, DtHumanWeaponStateActuatorDescriptor, DtLookAtActuatorDescriptor, DtMovementBasedTerrainPreloadControllerDescriptor, DtNavMovementActuatorDescriptor, DtRadarJammerDescriptor, DtRotaryWingEncumberedFlightActuatorDescriptor, DtRotorWashControllerDescriptor, DtAggregatedMoveToDescriptor, DtAirportLightingControllerDescriptor, DtHumanCrosswalkControllerDescriptor, DtHumanJoystickMovementControllerDescriptor, DtHumanUseDoorControllerDescriptor, DtIndirectFireActuatorDescriptor, DtMissileLauncherActuatorDescriptor, DtNavTagTraversalControllerDescriptor, DtRotaryWingLandingGearDescriptor, DtSensorGimbalControllerDescriptor, DtTDLPPLIMessageGeneratorControllerDescriptor, DtAggregateAntiAirControllerDescriptor, DtAggregatedMoveAlongDescriptor, DtAimWeaponControllerDescriptor, DtBallisticGunJoyControllerDescriptor, DtDynamicTerrainMunitionDamageControllerDescriptor, DtHumanFleeControllerDescriptor, DtIndirectFireSupportControllerDescriptor, DtResupplyControllerDescriptor, DtResupplyReceiverControllerDescriptor, DtResupplySupplierControllerDescriptor, DtRotaryWingJoyDeviceControllerDescriptor, DtScriptEnableControllerDescriptor, DtSetControllerDescriptor, DtAggregateIndirectFireControllerDescriptor, DtAirRefuelSupplierControllerDescriptor, DtDestroyEngineeringObjectControllerDescriptor, DtNbcWeaponControllerDescriptor, DtPropulsionNoiseGeneratorDescriptor, DtRotaryWingFollowTaskDescriptor, DtSpawnObjectWarheadActuatorDescriptor, DtTDLContactMessageGeneratorControllerDescriptor, DtTerrainProximityIndicatorDescriptor, DtBreachObstacleControllerDescriptor, DtCreateEngineeringObjectControllerDescriptor, DtHumanMoveAlongControllerDescriptor, DtJammerEmitterDescriptor, DtNonLethalDamageActuatorDescriptor, DtStatePropertyInitializationControllerDescriptor, DtTDLMessageGeneratorControllerDescriptor, DtTerrainPreloadControllerDescriptor, DtAggregateCombatAdjustmentDescriptor, DtFallingFromSkyActuatorDescriptor, DtGroundMoveDirectionControllerDescriptor, DtTimeKeeperDescriptor, DtParachuteActuatorDescriptor, DtParachuteControllerDescriptor, DtSpawnControllerDescriptor, DtExtendablePartActuatorDescriptor, DtGroundVehicleTrailingEffectControllerDescriptor, DtIndirectArtilleryDescriptor, DtRadarWarningReceiverDescriptor, DtDiGuyControllerDescriptor, DtHumanDamageActuatorDescriptor, and DtAirborneAggregatedMovementDescriptor.

virtual void DtComponentDescriptor::setComponentType ( const DtString &  componentType)
virtual

Type of DtSimComponent this descriptor is associated with. Used to indicate what type of model component to create when creating an entity from parameters. Component type strings are defined in compTypes.h.

virtual const DtString& DtComponentDescriptor::componentType ( ) const
virtual

Type of DtSimComponent this descriptor is associated with. Used to indicate what type of model component to create when creating an entity from parameters. Component type strings are defined in compTypes.h.

virtual void DtComponentDescriptor::putData ( std::string &  fp,
int  indentLevel = 0 
)
virtual

Overrides base class putData to output our type.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtComponentDescriptor::getData ( DtlObjPtr  args,
const DtReaderWriter::SearchPaths &  searchPaths,
const DtVariableBindingsList &  variableBindings 
)
virtual

getData is just used to get us past the type in the data stream, since it's not actually stored.

Reimplemented from DtReaderWriter.

Reimplemented in DtNavTagTraversalControllerDescriptor.

virtual bool DtComponentDescriptor::init ( )
virtual

Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary.

Reimplemented in DtOccupancyDirectorDescriptor, DtDamageAdjudicationComponentDescriptor, DtSuppressionActuatorDescriptor, DtFormationControllerDescriptor, and DtNonLethalDamageActuatorDescriptor.

virtual void DtComponentDescriptor::setMinTickPeriod ( DtReal  minTickPeriod)
virtual

Minimum tick period for this component in seconds. Set to -1.0 by default (unspecified - tick at rate appropriate for frame mode).

virtual DtReal DtComponentDescriptor::minTickPeriod ( ) const
virtual

Minimum tick period for this component in seconds. Set to -1.0 by default (unspecified - tick at rate appropriate for frame mode).

virtual void DtComponentDescriptor::setMinTickPeriodVariance ( DtReal  minTickPeriodVariance)
virtual

Minimum tick period variance for this component in seconds. Set to -1.0 by default (unspecified).

virtual DtReal DtComponentDescriptor::minTickPeriodVariance ( ) const
virtual

Minimum tick period variance for this component in seconds. Set to -1.0 by default (unspecified).

virtual void DtComponentDescriptor::setTickPeriodUsesRealTime ( bool  value)
virtual

Accessor/mutator for myTickPeriodUsesRealTime.

virtual bool DtComponentDescriptor::tickPeriodUsesRealTime ( ) const
virtual

Accessor/mutator for myTickPeriodUsesRealTime.

virtual const DtString& DtComponentDescriptor::processStateRepositoryName ( ) const
virtual

Name which this component will assign to its PSR. Names must be unique across all PSR names configured as part of an entity.

virtual void DtComponentDescriptor::setProcessStateRepositoryName ( const DtString &  name)
virtual

Name which this component will assign to its PSR. Names must be unique across all PSR names configured as part of an entity.

virtual const DtString& DtComponentDescriptor::processStateRepositoryType ( ) const
virtual

Type of PSR this component will create. PSR types are defined in procSRTypes.h.

virtual void DtComponentDescriptor::setProcessStateRepositoryType ( const DtString &  type)
virtual

Type of PSR this component will create. PSR types are defined in procSRTypes.h.

virtual void DtComponentDescriptor::setIsEnabled ( bool  yesNo)
virtual

Is the component enabled or not.

virtual bool DtComponentDescriptor::isEnabled ( ) const
virtual

Is the component enabled or not.

virtual void DtComponentDescriptor::setDebugActive ( bool  active)
inlinevirtual 

Should detailed debug info be printed for this component.

"Detailed" debug info can mean per-tick print info that is too verbose for the usual output, even when limited to the Debug notify level. In this case, it is best to dump data to the back-end console using DtWarn, rather than to the entity console using objectConsoleDebug. Printing to the back-end avoids trying to send volumes of data over the network to the front end.
This flag can be used in a component as follows:
if (myDescriptor->debugActive() &&
entity()->objectConsole()->notifyLevel() == DtNlDebug)
{
DtWarn("Stuff to dump this tick\n");
...

To activate this debug, put (debug-detail True) in any component descriptor (i.e., in a .sysdef file).

virtual bool DtComponentDescriptor::debugActive ( ) const
inlinevirtual 

Should detailed debug info be printed for this component.

"Detailed" debug info can mean per-tick print info that is too verbose for the usual output, even when limited to the Debug notify level. In this case, it is best to dump data to the back-end console using DtWarn, rather than to the entity console using objectConsoleDebug. Printing to the back-end avoids trying to send volumes of data over the network to the front end.
This flag can be used in a component as follows:
if (myDescriptor->debugActive() &&
entity()->objectConsole()->notifyLevel() == DtNlDebug)
{
DtWarn("Stuff to dump this tick\n");
...

To activate this debug, put (debug-detail True) in any component descriptor (i.e., in a .sysdef file).

virtual void DtComponentDescriptor::setMinTaskVisualizationTickPeriod ( DtReal  minTickPeriod)
virtual

Minimum tick period for this component's task visualizations in seconds. Set to -1.0 by default (unspecified - tick with every component tick).

virtual DtReal DtComponentDescriptor::minTaskVisualizationTickPeriod ( ) const
virtual

Minimum tick period for this component's task visualizations in seconds. Set to -1.0 by default (unspecified - tick with every component tick).

virtual void DtComponentDescriptor::setTaskVisualizationsEnabled ( bool  enabled)
virtual

Whether task visualizations are enabled for this component. Default is enabled.

virtual bool DtComponentDescriptor::taskVisualizationsEnabled ( ) const
virtual

Whether task visualizations are enabled for this component. Default is enabled.

virtual void DtComponentDescriptor::setCreateComponent ( bool  yesNo)
virtual

Should the component be created or not.

virtual bool DtComponentDescriptor::createComponent ( ) const
virtual

Should the component be created or not.

virtual void DtComponentDescriptor::setCreateOnRemoteObject ( bool  yesNo)
virtual

Whether or not this component is created on remote versions of the object.

virtual bool DtComponentDescriptor::createOnRemoteObject ( ) const
virtual

Whether or not this component is created on remote versions of the object.

virtual const DtRwNLengthStringVector& DtComponentDescriptor::scriptIds ( ) const
virtual

Accessor/mutator for myScriptIds.

virtual DtRwNLengthStringVector& DtComponentDescriptor::scriptIds ( )
virtual

Accessor/mutator for myScriptIds.

virtual const DtRwScriptVariablesList& DtComponentDescriptor::scriptVariables ( ) const
virtual

Accessor/mutator for myScriptVariables.

virtual DtRwScriptVariablesList& DtComponentDescriptor::scriptVariables ( )
virtual

Accessor/mutator for myScriptVariables.

static void DtComponentDescriptor::addComponentDescriptorCreatorFcn ( const DtString &  type,
DtComponentDescriptorCreatorFcn  fcn 
)
static

Adds a given component descriptor creation function and corresponding type (defined in compDescTypes.h) to the DtComponentDescriptorFactory.

static DtComponentDescriptorFactory* DtComponentDescriptor::factory ( )
static

The factory for creating objects of type DtComponentDescriptor. The factory is used to generate component descriptors on demand, when reading in parameter database files.

static void DtComponentDescriptor::setFactory ( DtComponentDescriptorFactory *  factory)
static

The factory for creating objects of type DtComponentDescriptor. The factory is used to generate component descriptors on demand, when reading in parameter database files.

static DtComponentDescriptor* DtComponentDescriptor::createComponentDescriptor ( DtlObjPtr  mtlStream,
const DtReaderWriter::SearchPaths &  searchPaths,
const DtVariableBindingsList &  variableBindings 
)
static

Creates and initializes a component descriptor when reading in from an MTL (MAK Technologies Lisp) file (i.e. a parameter database file).

Parameters
mtlStreamInput stream from an MTL file.
searchPathPath at which any DtReaderWriterFile items should be searched for if encountered when parsing the mtlStream.
Returns
Newly created and initialized instance of this class, with data read in from the MTL stream.
static DtComponentDescriptor* DtComponentDescriptor::createComponentDescriptor ( const char *  pName)
static

Creates and initializes a new instance of this class.

Parameters
pNameDtReaderWriter name of the component. The name appears as the first string of a component descriptor
Returns
Newly created and initialized instance of this class.
static DtComponentDescriptor* DtComponentDescriptor::creator ( )
static
Returns
Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.
bool DtComponentDescriptor::operator== ( const DtComponentDescriptor &  ) const

Member Data Documentation

DtRwString DtComponentDescriptor::myComponentType
protected

Parameter Name: component-type
Parameter Description: String identifying type of component.
.

See Also
compDescTypes.h
DtRwReal DtComponentDescriptor::myMinTickPeriod
protected

Parameter Name: min-tick-period
Parameter Description: Average tick period for this component. The tick period varies randomly each time the component is ticked. The period can range from T - V/2 to T + V/2, where T is the period and V is the variance (with a minimum of 0). The default is -1, which means as-fast-as-possible.
Parameter Default Value: -1.0
Parameter Units: seconds
Parameter Range: -1.0 (unspecified), positive real numbers.

DtRwReal DtComponentDescriptor::myMinTickPeriodVariance
protected

Parameter Name: min-tick-period-variance
Parameter Description: A time range for the tick period. The tick period varies randomly each time the component is ticked. The period can range from T - V/2 to T + V/2, where V is the variance (with a minimum of 0). The default is -1, which means zero.
Parameter Default Value: -1.0
Parameter Units: seconds
Parameter Range: -1.0 (as fast as possible), positive real numbers.

DtRwBoolean DtComponentDescriptor::myTickPeriodUsesRealTime
protected

Parameter Name: tick-period-uses-real-time
Parameter Description: Specified whether the component uses real-time (instead of simulation-time) to determine when it is time to tick. Note that a component with a non-zero tick period will not be ticked during a simulation pause if it uses simulation time (the default).
Parameter Default Value: False
Parameter Units: True/False
.

DtRwString DtComponentDescriptor::myProcessStateRepositoryName
protected

Parameter Name: process-state-repository-name
Parameter Description: Name of the process state repository associated with this component. Process state repository names must be unique across all process state repository names configured for an entity.

DtRwString DtComponentDescriptor::myProcessStateRepositoryType
protected

Parameter Name: process-state-repository-type
Parameter Description: Type of the process state repository associated with this component. Process state repository type are defined in procSRTypes.

DtRwBoolean DtComponentDescriptor::myIsEnabled
protected

Parameter Name: is-enabled
Parameter Description: Is the component enabled (allowed to tick) or not.
Parameter Default Value: True
.

DtRwBoolean DtComponentDescriptor::myDebug
protected

This parameter defaults to false. If set true in a config file, lots of debug detail may be printed out, depending on what developers have put in the source code.

DtRwReal DtComponentDescriptor::myMinTaskVisualizationTickPeriod
protected

Parameter Name: min-task-visualization-tick-period
Parameter Description: Average tick period for this component's task visualizations. The tick period varies randomly each time the component is ticked. The period can range from T - V/2 to T + V/2, where T is the period and V is the variance (with a minimum of 0). The default is -1, which means whenever the component is ticked.
Parameter Default Value: -1.0
Parameter Units: seconds
Parameter Range: -1.0 (unspecified), positive real numbers.

DtRwBoolean DtComponentDescriptor::myTaskVisualizationsEnabled
protected

Parameter Name: task-visualizations-enabled
Parameter Description: Whether this component's task visualizations are enabled. Parameter Default Value: True
.

DtRwBoolean DtComponentDescriptor::myCreateComponent
protected

Parameter Name: component-type
Parameter Description: String identifying type of component.
.

See Also
compDescTypes.h
DtRwBoolean DtComponentDescriptor::myCreateOnRemoteObject
protected

Parameter Name: create-on-remote-object
Parameter Description: If true, this component will be created on remote objects as well as local.
Parameter Default Value: False
.

DtRwNLengthStringVector DtComponentDescriptor::myScriptIds
protected

Parameter Name: script-ids
Parameter Description: List of script IDs that are enabled by this controller. Parameter Default Value: None
.

DtRwScriptVariablesList DtComponentDescriptor::myScriptVariables
protected

Parameter Name: script-variables
Parameter Description: List of script variables that can be referenced in a lua script by the given script id. The script will use the lua system:getAttribute function using the script-id.variable-name (i.e. vrf:getScriptAttribute("Rain-Modifier-By-Intensity") ) Parameter Default Value: None
.

DtComponentDescriptorFactory* DtComponentDescriptor::myFactory
staticprotected
The documentation for this class was generated from the following file:
Document ID: Generated on Thu Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)