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. More...

Inherits DtReaderWriter.

Inherited by BHAVE::DtSpawnControllerDescriptor, BHAVE::KynapseDescriptor, DtActuatorComponentDescriptor, DtAggregatedMoveToDescriptor, DtAggregateModelResolutionDescriptor, DtAggregateMoveAlongDescriptor, DtAggregateMoveIntoFormationDescriptor, DtAirVehicleWeaponHoldControllerDescriptor, DtBallisticGunControllerDescriptor, DtBaseWeaponControllerDescriptor, DtCombatRangeControllerDescriptor, DtCruiseMissileLaunchControllerDescriptor, DtDetonationControllerDescriptor, DtEmbarkationDescriptor, DtEmitterComponentDescriptor, DtFixedWingJoyDeviceControllerDescriptor, DtFixedWingLandingDescriptor, DtFixedWingPilotControllerDescriptor, DtFixedWingTakeoffDescriptor, DtFormationControllerDescriptor, DtGroundCollisionAvoidanceDescriptor, DtGroundJoyDeviceControllerDescriptor, DtGroundMoveDirectionControllerDescriptor, DtGroundMoveToDescriptor, DtHumanJoystickMovementControllerDescriptor, DtHumanMoveAlongControllerDescriptor, DtHumanMoveToControllerDescriptor, DtIffControllerDescriptor, DtLaserDetectorDescriptor, DtLaserGuidedLauncherControllerDescriptor, DtLasingControllerDescriptor, DtLaunchExpendableResourceControllerDescriptor, DtLaunchSmokeControllerDescriptor, DtLimitExistenceControllerDescriptor, DtMissileDistractionControllerDescriptor, DtObjectSensorDescriptor, DtObstructionSensorDescriptor, DtOccupancyDirectorDescriptor, DtRadarWarningReceiverDescriptor, DtRailMovementDescriptor, DtRailPathControllerDescriptor, DtRotaryWingJoyDeviceControllerDescriptor, DtRotaryWingPilotDescriptor, DtRotaryWingTaskDescriptor, DtSpotReportGeneratorControllerDescriptor, DtSpotReportReceiverDescriptor, DtSurfaceEntityPilotControllerDescriptor, DtTerrainPreloadControllerDescriptor, DtTurretAcquireControllerDescriptor, DtTurretJoyDeviceControllerDescriptor, DtTurretScanComponentDescriptor, DtUnderFireDeterminationComponentDescriptor, and DtVrfObjectDataMessengerDescriptor.

Public Member Functions
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment
virtual	~DtComponentDescriptor ()
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	putData (FILE *fp, int indentLevel=0)
	Overrides base class putData to output our type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual bool	init ()
	Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary.
constructor
Parameters componentName DtReaderWriter name of the component. This is the name of the descriptor entry as it appears in a parameter database file. parentRegistry The 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)
	Type of DtSimComponent this descriptor is associated with.
virtual const DtString &	componentType () const
	Type of DtSimComponent this descriptor is associated with.
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setTickPeriodUsesRealTime (bool value)
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual bool	tickPeriodUsesRealTime () const
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
	Name which this component will assign to its PSR.
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
	Type of PSR this component will create.
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
	Is the component enabled or not.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
	Adds a given component descriptor creation function and corresponding type (defined in compDescTypes.h) to the DtComponentDescriptorFactory.
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Creates and initializes a component descriptor when reading in from an MTL (MAK Technologies Lisp) file (i.e.
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
	Creates and initializes a new instance of this class.
static DtComponentDescriptor *	creator ()
static DtComponentDescriptorFactory *	factory ()
	The factory for creating objects of type DtComponentDescriptor.
static void	setFactory (DtComponentDescriptorFactory *factory)
	The factory for creating objects of type DtComponentDescriptor.
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.

Protected Member Functions
	DtComponentDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.

Protected Attributes
DtRwBoolean	myIsEnabled
parameters
These parameters are available for setting in the OPD files.
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Minimum tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: Minimum tick period for this component.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the min-tick-period and min-tick-period-variance parameters are based on real time or simulation time.
DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component.
DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository assoicated with this component.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

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 DtReaderWriterFactory	theFactory

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::pair < DtSymbolString, DtString >	DtVariableNameType

Detailed Description

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.

Examples

• Stop To Shoot Example

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

orig	Component descriptor to copy.
parentRegistry	The 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 DtActuatorComponentDescriptor, DtLaunchExpendableResourceControllerDescriptor, DtSurfaceEntityPilotControllerDescriptor, DtTurretAcquireControllerDescriptor, DtBallisticGunDescriptor, DtObstructionSensorDescriptor, BHAVE::KynapseDescriptor, DtGroundCollisionAvoidanceDescriptor, DtAggregateMoveAlongDescriptor, DtEmitterComponentDescriptor, DtIndirectFireControllerDescriptor, DtLasingControllerDescriptor, DtFixedWingFollowEntityControllerDescriptor, DtLaserDetectorDescriptor, DtBallisticGunControllerDescriptor, DtBallisticGunJoyControllerDescriptor, DtBaseWeaponControllerDescriptor, DtDamageComponentDescriptor, DtFixedWingPilotControllerDescriptor, DtGroundJoyDeviceControllerDescriptor, DtAggregateMoveIntoFormationDescriptor, DtAzimuthMountComponentDescriptor, DtDetonationControllerDescriptor, DtDamageAdjudicationComponentDescriptor, DtHumanJoystickMovementControllerDescriptor, DtIndLifeformLauncherAcquireDescriptor, DtObjectSensorDescriptor, DtOccupancyDirectorDescriptor, DtFixedWingJoyDeviceControllerDescriptor, DtGroundFollowEntityDescriptor, DtSignatureObjectSensorDescriptor, DtSpotReportGeneratorControllerDescriptor, DtVrfObjectDataMessengerDescriptor, DtCombatRangeControllerDescriptor, DtElevatingBallisticGunControllerDescriptor, DtFixedWingFlyIntoControllerDescriptor, DtIffControllerDescriptor, DtLimitExistenceControllerDescriptor, DtRotaryWingPilotDescriptor, DtSurfaceEntityActuatorDescriptor, DtTurretJoyDeviceControllerDescriptor, DtAggregateEmbarkationDescriptor, DtConvoyDescriptor, DtGroundMoveToDescriptor, DtRadarObjectSensorDescriptor, DtRotaryWingJoyDeviceControllerDescriptor, DtTurretScanComponentDescriptor, DtCruiseMissileLaunchControllerDescriptor, DtFixedWingActuatorDescriptor, DtLauncherActuatorDescriptor, DtSurfaceEntityRoutePilotDescriptor, DtTurretComponentDescriptor, DtElevationMountComponentDescriptor, DtFixedWingDefaultControllerDescriptor, DtFormationControllerDescriptor, DtMissileDistractionControllerDescriptor, DtRotaryWingActuatorDescriptor, DtWeaponControllerDescriptor, DtEmbarkationDescriptor, DtFixedWingLandingDescriptor, DtFixedWingTakeoffDescriptor, DtLaserGuidedLauncherControllerDescriptor, DtLaunchSmokeControllerDescriptor, DtRailMovementDescriptor, DtTacticalSmokeActuatorDescriptor, DtUnderFireDeterminationComponentDescriptor, DtAirVehicleWeaponHoldControllerDescriptor, DtIndividualLifeformAcquireDescriptor, DtMultipleHitDamageActuatorDescriptor, DtRotaryWingRouteTaskDescriptor, DtSpotReportReceiverDescriptor, DtWarheadDetonationActuatorDescriptor, DtHumanMovementActuatorDescriptor, DtRotaryWingColAvoidanceControllerDescriptor, DtWeaponActuatorDescriptor, BHAVE::DtSpawnControllerDescriptor, DtRotaryWingTaskDescriptor, DtAggregatedMoveToDescriptor, DtAggregateModelResolutionDescriptor, DtAutomotiveActuatorDescriptor, DtHumanMoveAlongControllerDescriptor, DtRailPathControllerDescriptor, DtSwingingPartActuatorDescriptor, DtRadarWarningReceiverDescriptor, DtGlobalEnvironmentActuatorDescriptor, DtHumanMoveToControllerDescriptor, DtIntegratedLaserGuidedLauncherDescriptor, DtMovementBasedTerrainPreloadControllerDescriptor, DtGroundMoveDirectionControllerDescriptor, DtIndirectFireActuatorDescriptor, DtFallingFromSkyActuatorDescriptor, and DtTerrainPreloadControllerDescriptor.

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

virtual

Reimplemented in DtRailMovementDescriptor, DtAggregateMoveAlongDescriptor, DtTurretAcquireControllerDescriptor, DtObstructionSensorDescriptor, DtLaserGuidedLauncherControllerDescriptor, DtIndirectFireControllerDescriptor, DtCruiseMissileLaunchControllerDescriptor, DtFixedWingFollowEntityControllerDescriptor, DtObjectSensorDescriptor, DtRailPathControllerDescriptor, DtGroundCollisionAvoidanceDescriptor, DtGroundMoveToDescriptor, DtAggregateMoveIntoFormationDescriptor, DtTurretScanComponentDescriptor, DtGroundFollowEntityDescriptor, DtActuatorComponentDescriptor, DtMissileDistractionControllerDescriptor, DtConvoyDescriptor, DtLaunchExpendableResourceControllerDescriptor, DtSurfaceEntityPilotControllerDescriptor, DtSpotReportReceiverDescriptor, DtBallisticGunDescriptor, DtLasingControllerDescriptor, DtEmitterComponentDescriptor, DtLaserDetectorDescriptor, DtAzimuthMountComponentDescriptor, DtBallisticGunControllerDescriptor, DtBaseWeaponControllerDescriptor, DtDamageComponentDescriptor, DtFixedWingPilotControllerDescriptor, DtSignatureObjectSensorDescriptor, DtDetonationControllerDescriptor, DtDamageAdjudicationComponentDescriptor, DtOccupancyDirectorDescriptor, DtRotaryWingPilotDescriptor, DtAggregateEmbarkationDescriptor, DtCombatRangeControllerDescriptor, DtElevatingBallisticGunControllerDescriptor, DtFixedWingFlyIntoControllerDescriptor, DtFormationControllerDescriptor, DtIffControllerDescriptor, DtLimitExistenceControllerDescriptor, DtSurfaceEntityActuatorDescriptor, DtRadarObjectSensorDescriptor, DtSurfaceEntityRoutePilotDescriptor, DtFixedWingActuatorDescriptor, DtLauncherActuatorDescriptor, DtTurretComponentDescriptor, DtElevationMountComponentDescriptor, DtFixedWingDefaultControllerDescriptor, DtRotaryWingActuatorDescriptor, DtWeaponControllerDescriptor, DtBallisticGunJoyControllerDescriptor, DtEmbarkationDescriptor, DtFixedWingLandingDescriptor, DtFixedWingTakeoffDescriptor, DtGroundJoyDeviceControllerDescriptor, DtLaunchSmokeControllerDescriptor, DtRotaryWingRouteTaskDescriptor, DtTacticalSmokeActuatorDescriptor, DtUnderFireDeterminationComponentDescriptor, BHAVE::KynapseDescriptor, DtHumanJoystickMovementControllerDescriptor, DtIndividualLifeformAcquireDescriptor, DtIndLifeformLauncherAcquireDescriptor, DtMultipleHitDamageActuatorDescriptor, DtRotaryWingColAvoidanceControllerDescriptor, DtWarheadDetonationActuatorDescriptor, DtFixedWingJoyDeviceControllerDescriptor, DtHumanMovementActuatorDescriptor, DtRotaryWingTaskDescriptor, DtSpotReportGeneratorControllerDescriptor, DtVrfObjectDataMessengerDescriptor, DtWeaponActuatorDescriptor, DtTurretJoyDeviceControllerDescriptor, DtAggregatedMoveToDescriptor, DtAggregateModelResolutionDescriptor, DtAutomotiveActuatorDescriptor, DtHumanMoveAlongControllerDescriptor, DtRotaryWingJoyDeviceControllerDescriptor, DtGlobalEnvironmentActuatorDescriptor, DtHumanMoveToControllerDescriptor, DtAirVehicleWeaponHoldControllerDescriptor, DtIntegratedLaserGuidedLauncherDescriptor, DtMovementBasedTerrainPreloadControllerDescriptor, DtIndirectFireActuatorDescriptor, DtFallingFromSkyActuatorDescriptor, DtSwingingPartActuatorDescriptor, DtTerrainPreloadControllerDescriptor, BHAVE::DtSpawnControllerDescriptor, DtGroundMoveDirectionControllerDescriptor, and DtRadarWarningReceiverDescriptor.

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 ( FILE *  fp, int  indentLevel = 0  )

virtual

Overrides base class putData to output our type.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtComponentDescriptor::getData ( DtlObjPtr  args, const DtFilename &  searchPath, 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.

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, DtDamageComponentDescriptor, DtDamageAdjudicationComponentDescriptor, and DtFormationControllerDescriptor.

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.

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.

Reimplemented from DtReaderWriter.

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 DtFilename &  searchPath, 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

mtlStream	Input stream from an MTL file.
searchPath	Path at which any DtReaderWriterFile items should be searched for if encountered when parsing the mtlStream.

Returns

Newly created and intialized 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

pName

DtReaderWriter name of the component. The name appears as the first string of a component descriptor

Returns

Newly created and intialized 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.

Reimplemented in DtRotaryWingPilotDescriptor, DtBallisticGunDescriptor, DtLaunchExpendableResourceControllerDescriptor, DtRailMovementDescriptor, DtDamageComponentDescriptor, DtFixedWingPilotControllerDescriptor, DtRotaryWingJoyDeviceControllerDescriptor, DtDamageAdjudicationComponentDescriptor, DtAggregateMoveAlongDescriptor, DtFixedWingJoyDeviceControllerDescriptor, DtLasingControllerDescriptor, DtRotaryWingActuatorDescriptor, DtGroundJoyDeviceControllerDescriptor, DtTurretAcquireControllerDescriptor, DtObstructionSensorDescriptor, DtBallisticGunControllerDescriptor, DtLaserGuidedLauncherControllerDescriptor, DtRotaryWingColAvoidanceControllerDescriptor, DtIndirectFireControllerDescriptor, DtCruiseMissileLaunchControllerDescriptor, DtBaseWeaponControllerDescriptor, DtFixedWingFollowEntityControllerDescriptor, DtDetonationControllerDescriptor, DtHumanJoystickMovementControllerDescriptor, DtObjectSensorDescriptor, DtRotaryWingRouteTaskDescriptor, DtRailPathControllerDescriptor, DtIndividualLifeformAcquireDescriptor, DtWarheadDetonationActuatorDescriptor, DtBallisticGunJoyControllerDescriptor, DtGroundCollisionAvoidanceDescriptor, DtGroundMoveToDescriptor, DtActuatorComponentDescriptor, DtWeaponControllerDescriptor, DtAggregateMoveIntoFormationDescriptor, DtAzimuthMountComponentDescriptor, DtIndirectFireActuatorDescriptor, DtAggregateModelResolutionDescriptor, DtTurretScanComponentDescriptor, DtGroundFollowEntityDescriptor, DtCombatRangeControllerDescriptor, DtElevationMountComponentDescriptor, DtLauncherActuatorDescriptor, DtFixedWingActuatorDescriptor, DtMissileDistractionControllerDescriptor, DtTurretComponentDescriptor, DtUnderFireDeterminationComponentDescriptor, DtMultipleHitDamageActuatorDescriptor, DtElevatingBallisticGunControllerDescriptor, DtFixedWingFlyIntoControllerDescriptor, DtConvoyDescriptor, DtTurretJoyDeviceControllerDescriptor, DtFixedWingDefaultControllerDescriptor, DtSpotReportReceiverDescriptor, DtWeaponActuatorDescriptor, DtLimitExistenceControllerDescriptor, DtRotaryWingTaskDescriptor, DtEmitterComponentDescriptor, DtLaserDetectorDescriptor, BHAVE::KynapseDescriptor, DtSignatureObjectSensorDescriptor, DtOccupancyDirectorDescriptor, DtAggregateEmbarkationDescriptor, DtFormationControllerDescriptor, DtIffControllerDescriptor, DtIndLifeformLauncherAcquireDescriptor, DtRadarObjectSensorDescriptor, DtSpotReportGeneratorControllerDescriptor, DtVrfObjectDataMessengerDescriptor, DtEmbarkationDescriptor, DtFixedWingLandingDescriptor, DtFixedWingTakeoffDescriptor, DtIntegratedLaserGuidedLauncherDescriptor, DtLaunchSmokeControllerDescriptor, DtTacticalSmokeActuatorDescriptor, DtHumanMovementActuatorDescriptor, DtFallingFromSkyActuatorDescriptor, DtRadarWarningReceiverDescriptor, DtAggregatedMoveToDescriptor, DtAirVehicleWeaponHoldControllerDescriptor, DtAutomotiveActuatorDescriptor, DtHumanMoveAlongControllerDescriptor, DtGlobalEnvironmentActuatorDescriptor, DtHumanMoveToControllerDescriptor, BHAVE::DtSpawnControllerDescriptor, DtMovementBasedTerrainPreloadControllerDescriptor, DtSwingingPartActuatorDescriptor, DtGroundMoveDirectionControllerDescriptor, DtTerrainPreloadControllerDescriptor, DtSurfaceEntityActuatorDescriptor, DtSurfaceEntityPilotControllerDescriptor, and DtSurfaceEntityRoutePilotDescriptor.

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: Minimum tick period for this component.

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: Minimum tick period for this component.

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 min-tick-period and min-tick-period-variance parameters are based on real time or simulation time.

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 assoicated with this component.

Process state repository type are defined in procSRTypes.

DtRwBoolean DtComponentDescriptor::myIsEnabled

protected

DtComponentDescriptorFactory* DtComponentDescriptor::myFactory

staticprotected

---

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

• include/vrfobjparam/compDesc.h