DtLaunchSmokeControllerDescriptor Class Reference

DtLaunchSmokeControllerDescriptor; descriptor for the DtLaunchSmokeComponent component. More...

Inheritance diagram for DtLaunchSmokeControllerDescriptor:

Public Member Functions
	DtLaunchSmokeControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtLaunchSmokeControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtLaunchSmokeControllerDescriptor (const DtLaunchSmokeControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtLaunchSmokeControllerDescriptor &	operator= (const DtLaunchSmokeControllerDescriptor &orig)
	assignment
virtual	~DtLaunchSmokeControllerDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of descriptor.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual const DtEntityType &	detonationType () const
virtual void	setDetonationType (const DtEntityType &type)
virtual int	numberOfSmokeClouds () const
virtual void	setNumberOfSmokeClouds (int numClouds)
virtual double	distanceFromEntity () const
virtual void	setDistanceFromEntity (double d)
virtual double	interCloudAngle () const
virtual void	setInterCloudAngle (double angle)
virtual double	cloudElevationAngle () const
virtual void	setCloudElevationAngle (double angle)
virtual const DtString &	resourceName () const
virtual void	setResourceName (const DtString &rName)
virtual bool	simulateSmoke () const
virtual void	setSimulateSmoke (bool b)
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment
virtual	~DtComponentDescriptor ()
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.
	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 DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtComponentDescriptor
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 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
	DtLaunchSmokeControllerDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtComponentDescriptor
	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
parameters
These parameters are available for setting in the OPD files.
DtRwEntityType	myDetonationType
	Parameter Name: detonation-type Parameter Description: Specify smoke bomb/grenade munition entity type Parameter Default Value: 2:9:225:2:5:4:0 (US M302A2 smoke bomb) .
DtRwInt	myNumSmokeClouds
	Parameter Name: num-smoke-clouds Parameter Description: The number of smoke clouds associated with the detonation Parameter Default Value: 1 .
DtRwReal	myDistanceFromEntity
	Parameter Name: distance-from-entity Parameter Description: Distance from entity to the first smoke cloud Parameter Default Value: 5 meters .
DtRwReal	myInterCloudAngle
	Parameter Name: inter-cloud-angle Parameter Description: Angle of separation between smoke clouds Parameter Default Value: 10 degrees .
DtRwReal	myCloudElevationAngle
	Parameter Name: cloud-elevation-angle Parameter Description: angle from entity to launch smoke Parameter Default Value: 30 degrees .
DtRwString	myResourceName
	Parameter Name: resource-name Parameter Description: Supply type needed to launch smoke Parameter Default Value: "smoke-bomb" .
DtRwBoolean	mySimulateSmokeClouds
	Parameter Name: simulate-smoke-cloud-objects Parameter Description: Option controls whether or not to simulate resulting smoke clouds in VRF Parameter Default Value: "true" .
Protected Attributes inherited from DtComponentDescriptor
DtRwBoolean	myIsEnabled
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.

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
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

Detailed Description

DtLaunchSmokeControllerDescriptor; descriptor for the DtLaunchSmokeComponent component.

Class DtLaunchSmokeControllerDescriptor: A DtComponentDescriptor that has parameters that indicate the initial settings for the launch smoke controller

Constructor & Destructor Documentation

DtLaunchSmokeControllerDescriptor::DtLaunchSmokeControllerDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

constructor

DtLaunchSmokeControllerDescriptor::DtLaunchSmokeControllerDescriptor	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtLaunchSmokeControllerDescriptor::DtLaunchSmokeControllerDescriptor	(	const DtLaunchSmokeControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtLaunchSmokeControllerDescriptor::~DtLaunchSmokeControllerDescriptor ( )

virtual

destructor

DtLaunchSmokeControllerDescriptor::DtLaunchSmokeControllerDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtLaunchSmokeControllerDescriptor& DtLaunchSmokeControllerDescriptor::operator=

(

const DtLaunchSmokeControllerDescriptor &

orig

)

assignment

virtual DtString DtLaunchSmokeControllerDescriptor::type ( ) const

virtual

Returns the type of descriptor.

This will be used to create the descriptor on read from an mtl file.

Reimplemented from DtComponentDescriptor.

virtual DtComponentDescriptor* DtLaunchSmokeControllerDescriptor::clone ( DtReaderWriterRegistry *  parentRegistry = 0 ) const

virtual

Reimplemented from DtComponentDescriptor.

static DtComponentDescriptor* DtLaunchSmokeControllerDescriptor::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 from DtComponentDescriptor.

virtual const DtEntityType& DtLaunchSmokeControllerDescriptor::detonationType ( ) const

virtual

virtual void DtLaunchSmokeControllerDescriptor::setDetonationType ( const DtEntityType &  type )

virtual

virtual int DtLaunchSmokeControllerDescriptor::numberOfSmokeClouds ( ) const

virtual

virtual void DtLaunchSmokeControllerDescriptor::setNumberOfSmokeClouds ( int  numClouds )

virtual

virtual double DtLaunchSmokeControllerDescriptor::distanceFromEntity ( ) const

virtual

virtual void DtLaunchSmokeControllerDescriptor::setDistanceFromEntity ( double  d )

virtual

virtual double DtLaunchSmokeControllerDescriptor::interCloudAngle ( ) const

virtual

virtual void DtLaunchSmokeControllerDescriptor::setInterCloudAngle ( double  angle )

virtual

virtual double DtLaunchSmokeControllerDescriptor::cloudElevationAngle ( ) const

virtual

virtual void DtLaunchSmokeControllerDescriptor::setCloudElevationAngle ( double  angle )

virtual

virtual const DtString& DtLaunchSmokeControllerDescriptor::resourceName ( ) const

virtual

virtual void DtLaunchSmokeControllerDescriptor::setResourceName ( const DtString &  rName )

virtual

virtual bool DtLaunchSmokeControllerDescriptor::simulateSmoke ( ) const

virtual

virtual void DtLaunchSmokeControllerDescriptor::setSimulateSmoke ( bool  b )

virtual

Member Data Documentation

DtRwEntityType DtLaunchSmokeControllerDescriptor::myDetonationType

protected

Parameter Name: detonation-type
Parameter Description: Specify smoke bomb/grenade munition entity type
Parameter Default Value: 2:9:225:2:5:4:0 (US M302A2 smoke bomb)
.

DtRwInt DtLaunchSmokeControllerDescriptor::myNumSmokeClouds

protected

Parameter Name: num-smoke-clouds
Parameter Description: The number of smoke clouds associated with the detonation
Parameter Default Value: 1
.

DtRwReal DtLaunchSmokeControllerDescriptor::myDistanceFromEntity

protected

Parameter Name: distance-from-entity
Parameter Description: Distance from entity to the first smoke cloud
Parameter Default Value: 5 meters
.

DtRwReal DtLaunchSmokeControllerDescriptor::myInterCloudAngle

protected

Parameter Name: inter-cloud-angle
Parameter Description: Angle of separation between smoke clouds
Parameter Default Value: 10 degrees
.

DtRwReal DtLaunchSmokeControllerDescriptor::myCloudElevationAngle

protected

Parameter Name: cloud-elevation-angle
Parameter Description: angle from entity to launch smoke
Parameter Default Value: 30 degrees
.

DtRwString DtLaunchSmokeControllerDescriptor::myResourceName

protected

Parameter Name: resource-name
Parameter Description: Supply type needed to launch smoke
Parameter Default Value: "smoke-bomb"
.

DtRwBoolean DtLaunchSmokeControllerDescriptor::mySimulateSmokeClouds

protected

Parameter Name: simulate-smoke-cloud-objects
Parameter Description: Option controls whether or not to simulate resulting smoke clouds in VRF
Parameter Default Value: "true"
.

---

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

• include/vrfobjparam/launchSmokeCtlrDesc.h