DtEmitterComponentDescriptor Class Reference

Instances of DtEmitterComponentDescriptor are used to specify the parameters for a DtEmitterComponent object. More...

Inheritance diagram for DtEmitterComponentDescriptor:

Public Member Functions
	DtEmitterComponentDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtEmitterComponentDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtEmitterComponentDescriptor (const DtEmitterComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtEmitterComponentDescriptor &	operator= (const DtEmitterComponentDescriptor &orig)
	assignment
virtual	~DtEmitterComponentDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtVector	mountLocation () const
	Accessor/mutator for myMountLocation.
virtual void	setMountLocation (const DtVector &location)
	Accessor/mutator for myMountLocation.
virtual bool	targetingCapable () const
	Accessor/mutator for myTargetingCapable.
virtual void	setTargetingCapable (bool onOff)
	Accessor/mutator for myTargetingCapable.
virtual bool	on () const
	Accessor/mutator for myOn.
virtual void	setOn (bool onOff)
	Accessor/mutator for myOn.
virtual DtEmitterSystemEntry &	emitterSystem ()
	Accessor for myEmitterSystemEntry.
virtual const DtEmitterSystemEntry &	emitterSystem () const
	Accessor for myEmitterSystemEntry.
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 Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwVector	myMountLocation
	Parameter Name: mount-location Parameter Description: Emitter system offset from entity in meters.
DtRwBoolean	myTargetingCapable
	Parameter Name: targeting-capable Parameter Description: Emitter system will set target to entities specified in “Set Target” messages.
DtRwBoolean	myOn
	Parameter Name: on Parameter Description: Emitter system on at startup.
DtEmitterSystemEntry	myEmitterSystemEntry
	Parameter Name: emitter-system Parameter Description: Emitter sub-system.
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
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

Detailed Description

Instances of DtEmitterComponentDescriptor are used to specify the parameters for a DtEmitterComponent object.

The emitter component is a sensor component that mounts on an entity and models basic electromagnetic emissions. An entity can have multiple emitter components. Each emitter component can have multiple beams.

Constructor & Destructor Documentation

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

constructor

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

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

copy constructor

virtual DtEmitterComponentDescriptor::~DtEmitterComponentDescriptor ( )

virtual

destructor

Member Function Documentation

DtEmitterComponentDescriptor& DtEmitterComponentDescriptor::operator=

(

const DtEmitterComponentDescriptor &

orig

)

assignment

virtual DtString DtEmitterComponentDescriptor::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.

Returns

DtEmitterComponentDescriptorType

Reimplemented from DtComponentDescriptor.

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

virtual

Reimplemented from DtComponentDescriptor.

static DtComponentDescriptor* DtEmitterComponentDescriptor::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 DtVector DtEmitterComponentDescriptor::mountLocation ( ) const

virtual

Accessor/mutator for myMountLocation.

virtual void DtEmitterComponentDescriptor::setMountLocation ( const DtVector &  location )

virtual

Accessor/mutator for myMountLocation.

virtual bool DtEmitterComponentDescriptor::targetingCapable ( ) const

virtual

Accessor/mutator for myTargetingCapable.

virtual void DtEmitterComponentDescriptor::setTargetingCapable ( bool  onOff )

virtual

Accessor/mutator for myTargetingCapable.

virtual bool DtEmitterComponentDescriptor::on ( ) const

virtual

Accessor/mutator for myOn.

virtual void DtEmitterComponentDescriptor::setOn ( bool  onOff )

virtual

Accessor/mutator for myOn.

virtual DtEmitterSystemEntry& DtEmitterComponentDescriptor::emitterSystem ( )

virtual

Accessor for myEmitterSystemEntry.

virtual const DtEmitterSystemEntry& DtEmitterComponentDescriptor::emitterSystem ( ) const

virtual

Accessor for myEmitterSystemEntry.

Member Data Documentation

DtRwVector DtEmitterComponentDescriptor::myMountLocation

protected

Parameter Name: mount-location
Parameter Description: Emitter system offset from entity in meters.

Parameter Default Value: (0. 0. 0.) (x, y, z)
Parameter Units: meters

DtRwBoolean DtEmitterComponentDescriptor::myTargetingCapable

protected

Parameter Name: targeting-capable
Parameter Description: Emitter system will set target to entities specified in “Set Target” messages.

Parameter Default Value: False

DtRwBoolean DtEmitterComponentDescriptor::myOn

protected

Parameter Name: on
Parameter Description: Emitter system on at startup.

Parameter Default Value: False

DtEmitterSystemEntry DtEmitterComponentDescriptor::myEmitterSystemEntry

protected

Parameter Name: emitter-system
Parameter Description: Emitter sub-system.

---

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

• include/vrfobjparam/emtrCmpDesc.h