DtEmitterComponent Class Reference

DtEmitterComponent maintains an electromagnetic emissions publisher for a single system with one or more beams. More...

Inheritance diagram for DtEmitterComponent:

Public Member Functions
	DtEmitterComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtEmitterComponent ()
	destructor
virtual void	tick ()
	Tick the publisher if the component is on.
virtual bool	tickWhileDestroyed () const
bool	init ()
	Calls createPublisher.
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	registerSetRequestMsgCallbacks ()
	Registers its interest in setEmitter and setTarget messages.
virtual void	processSetEmitterRequestMessage (DtSimMessage *msg)
virtual void	processSetRadarModeRequestMessage (DtSimMessage *msg)
virtual void	processRequestRadarModesAdmin (DtString receiver, DtString sender, bool isEchelonId, const DtVrfObjectMessage *msg)
virtual void	processSetTargetRequestMessage (DtSimMessage *msg)
virtual void	setSystemName (DtEmitterSysName nameEnum)
	Accessor and mutators for properties of the beam and emitter system.
virtual DtEmitterSysName	systemName () const
virtual void	setSystemFunction (DtEmissionFunc functionEnum)
virtual DtEmissionFunc	systemFunction () const
virtual void	setMountLocation (const DtVector &location)
virtual DtVector	mountLocation () const
virtual void	setTargetingCapable (bool onOff)
	If true, setTargetRequest messages sent to this entity will cause this emitter system to set all tracking beams to target only the entity listed in the targeting request message.
virtual bool	targetingCapable () const
virtual void	setOn (bool onOff)
	When true, EM Emissions PDUs are published as normal.
virtual bool	on () const
virtual void	addTrackTarget (const DtGlobalObjectDesignator &globalId)
	All beams in the system which are tracking beams will have this entity added to their track/jam lists.
virtual void	removeTrackTarget (const DtGlobalObjectDesignator &globalId)
	All beams in the system which are tracking beams will have this entity removed from their track/jam lists.
virtual void	clearTrackTargets ()
	All beams will have their track/jam lists emptied.
virtual DtEmitterBeamRepository *	addBeam (DtU8 id)
	Adds a new beam if the ID does not already exist and returns a pointer to the beam repository.
virtual void	removeBeam (DtU8 id)
	Removes a beam from this system.
virtual DtEmitterBeamRepository *	beam (DtU8 id=0)
	Returns a pointer to the beam repository of this beam, of NULL if there is no beam of this id in the system.
virtual int	numBeams () const
	Returns total number of beams in this system.
virtual DtList *	beamList ()
	Returns list to the beam repositories.
virtual DtVrfEmitterSystem *	emitterSystem ()
	Returns the DtVrfEmitterSystem that is implementing the publishing of emitter beams.
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent ()
	destructor
void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component.
virtual bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager.
virtual void	registerAttributeFunctions ()
	Called to register functions that provide system attribute values.
virtual void	preFirstTickInit ()
	This function can be overridden to initialize a component before it is ticked for the first time.
virtual void	postTick ()
	This function is called immediately after tick() is called.
virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived.
virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as
virtual double	minTickPeriod () const
	access the minimum tick period
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time
virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period
virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally.
virtual double	nextTickTime () const
	access the next tick time
virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at.
virtual void	setEntity (DtVrfObject *entity)
	The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponent *	nextComponent ()
	List management functions.
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
	Used by DtComponentList.
virtual DtListItem *	listItem ()
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
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 actual stored.
virtual void	addInputPort (DtInputPort *port)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
	Returns a pointer to the input port registered on this component with the specified name.
virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component.
virtual void	addOutputPort (DtOutputPort *port)
	Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
	Returns a pointer to the output port registered on this component with the specified name.
virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component.
virtual void	addInputPortGroup (DtInputPortGroup *group)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
	Returns a pointer the input port group registered on this component with the specified name.
virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component.
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
	Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
	Returns a pointer the output port group registered on this component with the specified name.
virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component.
virtual int	priority () const
	Return the current connection priority for this component.
virtual void	setPriority (int priority)
	Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void	setDT (double deltaT)
	Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
	The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const DtComponentDescriptor *	componentDescriptor () const
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual DtString	componentFullName () const
virtual DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorld *	physicalWorld () const
virtual DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrain *	terrainAttachedTo () const
virtual DtVrfObject *	entity ()
	Gets the entity.
virtual const DtVrfObject *	entity () const
virtual DtSimManager *	simManager ()
	Gets the sim manager.
virtual const DtSimManager *	simManager () const
virtual const Coordinate_System *	coordinateSystem () const
	Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_System *	coordinateSystem ()
virtual DtVrfObjectStateRepository *	localStateRepository ()
	Gets the local state repository.
virtual const DtVrfObjectStateRepository *	localStateRepository () const
virtual void	enable ()
	Is this component enabled or not.
virtual void	disable ()
	Is this component enabled or not.
virtual bool	isEnabled ()
	Is this component enabled or not.
virtual void	setIsEnabled (bool yesNo)
	Is this component enabled or not.
virtual DtOutputStream &	objectConsoleDebug () const
virtual DtOutputStream &	objectConsoleVerbose () const
virtual DtOutputStream &	objectConsoleInfo () const
virtual DtOutputStream &	objectConsoleWarn () const
virtual DtOutputStream &	objectConsoleError () const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
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
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
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 void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
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 DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
static void	setEmitterRequestCallback (DtSimMessage *msg, void *usrData)
static void	setRadarModeRequestCallback (DtSimMessage *msg, void *usrData)
static void	requestRadarModesAdminCallback (const DtVrfObjectMessage *msg, void *usr)
static void	setTargetRequestCallback (DtSimMessage *msg, void *usrData)
Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactory *	factory ()
	A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set.
static void	setFactory (DtSimComponentFactory *factory)
static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtVrfObject *owner, DtSimManager *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	Creates a DtSimComponent using the factory, then initializes it via the MTL stream.
static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
	Adds a DtSimComponent creation function to the DtSimComponentFactory, using the given type as the key.
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.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()

Protected Member Functions
virtual void	setRadio (DtSimBaseRadio *radio)
virtual DtSimBaseRadio *	radio ()
	The radio this component is listening to.
virtual bool	createAndInitEmitterSystem ()
	Creates a new DtVrfEmitterSystem and assigns it to myEmitterSystem.
virtual void	updateFromDescriptor ()
	copies data from this components descriptor into the state repository.
virtual bool	createPSR ()
	Creates myProcessState data member, and adds it to our process state repository manager.
Protected Member Functions inherited from DtSimComponent
bool	testInvariant () const
virtual bool	createPortGroups ()
	Called by init.
virtual bool	createPorts ()
	Called by init.
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.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
DtSimBaseRadio *	myRadio
bool	myTargetingCapable
DtVrfEmitterSystem *	myEmitterSystem
DtEmitterPSR *	myProcessState
	Holds the saveable state.
bool	myStateRestored
	Set to true once previously checkpointed state (if any) is restored.
DtU8	myEmitterSystemId
Protected Attributes inherited from DtSimComponent
DtVrfObject *	myEntity
DtVrfObjectStateRepository *	myLocalStateRepository
DtSimManager *	mySimManager
DtComponentSystem *	mySystem
	Pointer to the DtComponentSystem that this component belongs.
DtListItem *	myListItem
DtInputPortMap	myInputPortList
DtOutputPortMap	myOutputPortList
DtInputPortGroupMap	myInputPortGroupList
DtOutputPortGroupMap	myOutputPortGroupList
int	myPriority
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
double	myLastTickSimTime
double	myDT
bool	myIsEnabled
	Indicates whether this component should be enabled for ticking or not.
bool	myFirstTick
	Initialized to true in the constructor, set to false by the first call to postTick.
const DtComponentDescriptor *	myComponentDescriptor
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.

Private Member Functions
	DtEmitterComponent ()
	Default constructor; not implemented.
	DtEmitterComponent (const DtEmitterComponent &orig)
	copy constructor; not implemented.
const DtEmitterComponent &	operator= (const DtEmitterComponent &orig)
	assignment operator; not implemented.

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
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Types inherited from DtSimComponent
typedef std::map< DtString, DtInputPort * >	DtInputPortMap
typedef std::map< DtString, DtOutputPort * >	DtOutputPortMap
typedef std::map< DtString, DtInputPortGroup * >	DtInputPortGroupMap
typedef std::map< DtString, DtOutputPortGroup * >	DtOutputPortGroupMap
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Detailed Description

DtEmitterComponent maintains an electromagnetic emissions publisher for a single system with one or more beams.

End User Description: All elements of the beam characteristics (azimuth, elevation, etc.) are settable through the emitter-component-descriptor. All of these parameters are static. If the user desires dynamic beam characteristics (i.e. radar sweeps), they must derive from this class to provide that functionallity. API calls for that type of interaction are provided. The DtEmitterComponent does provide for turning the component on and off. When off, the component will publish the emitter system only, with 0 beams attached to it. DtEmitterComponent also provides for some simple target tracking. Since this component is independent from any sensing logic, it cannot provide realistic target tracking. It does provide an API for adding and removing targets from all beams in the system, and can be set to "Targeting Capable" mode in which the component will automatically set the beams to track any entity that is specified as the "Target" through the "set-target" radio message. This calss uses the DtVrfEmitterSystem class internally to simulate the emitter.

Uses Descriptor Type: DtEmitterComponentDescriptor

Constructor & Destructor Documentation

DtEmitterComponent::DtEmitterComponent	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtEmitterComponent::~DtEmitterComponent ( )

virtual

destructor

DtEmitterComponent::DtEmitterComponent ( )

private

Default constructor; not implemented.

DtEmitterComponent::DtEmitterComponent ( const DtEmitterComponent &  orig )

private

copy constructor; not implemented.

Member Function Documentation

virtual void DtEmitterComponent::tick ( )

virtual

Tick the publisher if the component is on.

Reimplemented from DtSimComponent.

virtual bool DtEmitterComponent::tickWhileDestroyed ( ) const

virtual

Returns

true. Necessary in order to stop publishing emitter system when entity is destroyed.

Reimplemented from DtSimComponent.

bool DtEmitterComponent::init ( )

virtual

Calls createPublisher.

Reimplemented from DtSimComponent.

virtual DtString DtEmitterComponent::type ( ) const

virtual

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key.

Returns

DtEmitterComponentType

Reimplemented from DtSimComponent.

static DtSimComponent* DtEmitterComponent::creator ( const DtString &  name, DtVrfObject *  owner, DtSimManager *  simManager, DtComponentDescriptor *  desc = 0, DtReaderWriterRegistry *  parentRegistry = 0  )

static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns

New instance of this class.

virtual void DtEmitterComponent::registerSetRequestMsgCallbacks ( )

virtual

Registers its interest in setEmitter and setTarget messages.

static void DtEmitterComponent::setEmitterRequestCallback ( DtSimMessage *  msg, void *  usrData  )

static

virtual void DtEmitterComponent::processSetEmitterRequestMessage ( DtSimMessage *  msg )

virtual

static void DtEmitterComponent::setRadarModeRequestCallback ( DtSimMessage *  msg, void *  usrData  )

static

virtual void DtEmitterComponent::processSetRadarModeRequestMessage ( DtSimMessage *  msg )

virtual

static void DtEmitterComponent::requestRadarModesAdminCallback ( const DtVrfObjectMessage *  msg, void *  usr  )

static

virtual void DtEmitterComponent::processRequestRadarModesAdmin ( DtString  receiver, DtString  sender, bool  isEchelonId, const DtVrfObjectMessage *  msg  )

virtual

static void DtEmitterComponent::setTargetRequestCallback ( DtSimMessage *  msg, void *  usrData  )

static

virtual void DtEmitterComponent::processSetTargetRequestMessage ( DtSimMessage *  msg )

virtual

virtual void DtEmitterComponent::setSystemName ( DtEmitterSysName  nameEnum )

virtual

Accessor and mutators for properties of the beam and emitter system.

virtual DtEmitterSysName DtEmitterComponent::systemName ( ) const

virtual

virtual void DtEmitterComponent::setSystemFunction ( DtEmissionFunc  functionEnum )

virtual

virtual DtEmissionFunc DtEmitterComponent::systemFunction ( ) const

virtual

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

virtual

virtual DtVector DtEmitterComponent::mountLocation ( ) const

virtual

virtual void DtEmitterComponent::setTargetingCapable ( bool  onOff )

virtual

If true, setTargetRequest messages sent to this entity will cause this emitter system to set all tracking beams to target only the entity listed in the targeting request message.

Aditionally, all beams created by the desciptor will be created at tracking beams when this is set to true.

virtual bool DtEmitterComponent::targetingCapable ( ) const

virtual

virtual void DtEmitterComponent::setOn ( bool  onOff )

virtual

When true, EM Emissions PDUs are published as normal.

Otherwise, the emitter system is still published, but without any beams.

virtual bool DtEmitterComponent::on ( ) const

virtual

virtual void DtEmitterComponent::addTrackTarget ( const DtGlobalObjectDesignator &  globalId )

virtual

All beams in the system which are tracking beams will have this entity added to their track/jam lists.

virtual void DtEmitterComponent::removeTrackTarget ( const DtGlobalObjectDesignator &  globalId )

virtual

All beams in the system which are tracking beams will have this entity removed from their track/jam lists.

virtual void DtEmitterComponent::clearTrackTargets ( )

virtual

All beams will have their track/jam lists emptied.

virtual DtEmitterBeamRepository* DtEmitterComponent::addBeam ( DtU8  id )

virtual

Adds a new beam if the ID does not already exist and returns a pointer to the beam repository.

virtual void DtEmitterComponent::removeBeam ( DtU8  id )

virtual

Removes a beam from this system.

virtual DtEmitterBeamRepository* DtEmitterComponent::beam ( DtU8  id = 0 )

virtual

Returns a pointer to the beam repository of this beam, of NULL if there is no beam of this id in the system.

virtual int DtEmitterComponent::numBeams ( ) const

virtual

Returns total number of beams in this system.

virtual DtList* DtEmitterComponent::beamList ( )

virtual

Returns list to the beam repositories.

virtual DtVrfEmitterSystem* DtEmitterComponent::emitterSystem ( )

virtual

Returns the DtVrfEmitterSystem that is implementing the publishing of emitter beams.

When possible, use the other interface methods in this component instead of calling down to the emitter system directly.

virtual void DtEmitterComponent::setRadio ( DtSimBaseRadio *  radio )

protectedvirtual

virtual DtSimBaseRadio* DtEmitterComponent::radio ( )

protectedvirtual

The radio this component is listening to.

virtual bool DtEmitterComponent::createAndInitEmitterSystem ( )

protectedvirtual

Creates a new DtVrfEmitterSystem and assigns it to myEmitterSystem.

virtual void DtEmitterComponent::updateFromDescriptor ( )

protectedvirtual

copies data from this components descriptor into the state repository.

virtual bool DtEmitterComponent::createPSR ( )

protectedvirtual

Creates myProcessState data member, and adds it to our process state repository manager.

Passes in the name and type specified in the component descriptor (if they exist) to the DtVrfProcessStateRepository::createRepository factory method. If name and/or type is not specified, uses the appropriate default strings defined in procSRTypes.h.

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

private

assignment operator; not implemented.

Member Data Documentation

DtSimBaseRadio* DtEmitterComponent::myRadio

protected

bool DtEmitterComponent::myTargetingCapable

protected

DtVrfEmitterSystem* DtEmitterComponent::myEmitterSystem

protected

DtEmitterPSR* DtEmitterComponent::myProcessState

protected

Holds the saveable state.

Container for state data associated with this component. This state is saved and restored as part of a scenario (or checkpoint).

bool DtEmitterComponent::myStateRestored

protected

Set to true once previously checkpointed state (if any) is restored.

DtU8 DtEmitterComponent::myEmitterSystemId

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmodel/emitterComp.h