DtEmitterComponent Class Reference

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 functionality. 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 class uses the DtVrfEmitterSystem class internally to simulate the emitter.

Uses Descriptor Type: DtEmitterComponentDescriptor

Inheritance diagram for DtEmitterComponent:

Public Member Functions
	DtEmitterComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtEmitterComponent () override
virtual void	tick () override
virtual bool	tickWhileDestroyed () const override
virtual bool	init () override
virtual void	preFirstTickInit () override
virtual const char *	type () const override
virtual void	registerSetRequestMsgCallbacks ()
virtual void	processSetEmitterRequestMessage (DtSimMessage *msg)
virtual void	processSetRadarModeRequestMessage (DtSimMessage *msg)
virtual void	procesSetEmitterTrackJamTargetsRequestMessage (DtSimMessage *msg)
virtual void	processRequestRadarModesAdmin (const DtUUID &receiver, const DtUUID &sender, const DtVrfObjectMessage *msg)
virtual void	setRadarMode (const DtString &mode)
virtual DtString	radarMode () const
virtual void	setTrackTargetList (const std::vector< DtUUID > &strings)
virtual void	setJamTargetList (const std::vector< DtUUID > &strings)
virtual void	addTrackTarget (const DtUUID &target)
virtual void	removeTrackTarget (const DtUUID &target)
virtual void	addJamTarget (const DtUUID &target)
virtual void	removeJamTarget (const DtUUID &target)
virtual void	clearTrackTargets ()
virtual void	clearJamTargets ()
virtual makVrf::DtEmitterSystemBeamStateData *	addBeam ()
virtual void	removeBeam (DtU8 id)
virtual makVrf::DtEmitterSystemBeamStateData *	beam (DtU8 id=0)
virtual int	numBeams () const
virtual std::vector < makVrf::DtEmitterSystemBeamStateData > &	beamList ()
virtual DtVrfEmitterSystem *	emitterSystem ()
virtual void	setSystemName (DtEmitterSysName nameEnum)
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	setOn (bool onOff)
virtual bool	on () const
virtual void	setUseHighDensityTracking (bool useHdMode)
virtual bool	useHighDensityTracking () const
virtual void	setUseHighDensityJamming (bool useHdMode)
virtual bool	useHighDensityJamming () const
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent () override
virtual void	setParentSystem (DtComponentSystem *system)
DtComponentSystem *	parentSystem () const
virtual bool	postAddComponentsInit ()
virtual void	registerAttributeFunctions ()
virtual void	postTick ()
virtual void	timedTick ()
virtual void	setMinTickPeriod (double minTickPeriod, double minTickPeriodVariance)
virtual void	setupFirstTickTime ()
virtual void	setEntity (DtLocalObject *entity)
virtual DtSimComponent *	nextComponent ()
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
virtual DtListItem *	listItem ()
virtual void	putData (std::string &fp, int indentLevel=0) override
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
virtual void	addInputPort (DtInputPort *port)
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
virtual DtList	inputPortList () const
virtual void	addOutputPort (DtOutputPort *port)
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
virtual DtList	outputPortList () const
virtual void	addInputPortGroup (DtInputPortGroup *group)
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
virtual DtList	inputPortGroupList () const
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
virtual DtList	outputPortGroupList () const
virtual int	priority () const
virtual void	setPriority (int priority)
double	dT () const
virtual void	setDT (double deltaT)
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
virtual const DtComponentDescriptor *	componentDescriptor () const
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual const DtSymbolString &	componentFullName () const
DtPhysicalWorld *	physicalWorld ()
const DtPhysicalWorld *	physicalWorld () const
const DtAttachedTerrain *	terrainAttachedTo () const
DtLocalObject *	entity ()
const DtLocalObject *	entity () const
DtSimulationServices *	simulationServices ()
const DtSimulationServices *	simulationServices () const
const Coordinate_System *	coordinateSystem () const
virtual void	isClutterChanged ()
virtual bool	taskVisualizationsActive () const
virtual bool	taskVisualizationsEnabled () const
virtual void	onRestore ()
makVrf::DtTaskVisualizationMap &	taskVisualizations ()
virtual void	updateImgui ()
virtual bool	debugActive () const
virtual void	enable ()
virtual void	disable ()
virtual bool	isEnabled ()
virtual void	setIsEnabled (bool yesNo)
virtual DtOutputStream &	objectConsoleDebug (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleVerbose (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleInfo (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleWarn (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleError (const DtString &channel="") const
virtual int	notifyLevel () const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
VRF4API_METHOD const DtSimulationServices *	simManager () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs) const
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
static void	setEmitterRequestCallback (DtSimMessage *msg, void *usrData)
static void	setRadarModeRequestCallback (DtSimMessage *msg, void *usrData)
static void	setEmitterTrackJamTargetsCallback (DtSimMessage *msg, void *usrData)
static void	requestRadarModesAdminCallback (const DtVrfObjectMessage *msg, void *usr)
Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactory *	factory ()
static void	setFactory (DtSimComponentFactory *factory)
static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
static VRF4API_METHOD DtSimComponent *	MarkThreadSafe (DtSimComponent *comp)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions
virtual void	setRadio (DtSimRadio *radio)
virtual DtSimRadio *	radio ()
virtual bool	createAndInitEmitterSystem ()
virtual void	updateEmitterFromDescriptor ()
virtual void	updateEmitterFromPsr ()
virtual void	determineTrackJamAbility ()
virtual bool	createPSR ()
Protected Member Functions inherited from DtSimComponent
virtual void	setupTimedTickLogic (double minTickPeriod, double minTickPeriodVariance)
virtual double	computeCurrentTime ()
bool	testInvariant () const
virtual bool	createPortGroups ()
virtual bool	createPorts ()
DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
virtual void	updateTaskVisualizations ()
virtual void	destroyTaskVisualizations ()
virtual void	destroyTaskVisualization (const DtString &name)
virtual makVrf::DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
virtual makVrf::DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
virtual makVrf::DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
virtual makVrf::DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
double	calculateNextTaskVisTickTime () const
DtVrfObjectStateRepository *	localStateRepository ()
const DtVrfObjectStateRepository *	localStateRepository () const
DtPropertyInterface *	cachedNextFrameStateProperty (DtPropertyInterface **prop, const DtString &propName)
template<typename ValType >
void	setCachedNextFrameStatePropertyValue (DtPropertyInterface **prop, const DtString &propName, ValType value)
const DtPropertyInterface *	cachedCurrentFrameStateProperty (const DtPropertyInterface **prop, const DtString &propName) const
template<typename ValType >
bool	getCachedCurrentFrameStatePropertyValue (const DtPropertyInterface **prop, const DtString &propName, ValType &value) const
void	addSimObjectPredicateCallback (DtSimObjectReference, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
void	removeSimObjectPredicateCallback (const DtSimObject *, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
void	invokeSimObjectPredicateCallbacks ()
virtual void	clearPredicateCallbacks ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtSimRadio *	myRadio
DtVrfEmitterSystem *	myEmitterSystem
bool	myRegisterForTrackMessages
bool	myRegisterForJamMessages
DtEmitterPSR *	myProcessState
Protected Attributes inherited from DtSimComponent
DtLocalObject *	myEntity
DtComponentSystem *	mySystem
DtListItem *	myListItem
DtInputPortMap	myInputPortList
DtOutputPortMap	myOutputPortList
DtInputPortGroupMap	myInputPortGroupList
DtOutputPortGroupMap	myOutputPortGroupList
int	myPriority
double	myLastTickSimTime
std::unique_ptr< DtTimedTickLogic >	myTimedTickLogic
double	myDT
bool	myIsEnabled
bool	myFirstTick
const DtComponentDescriptor *	myComponentDescriptor
std::list < DtVrfProcessStateRepository * >	myComponentPsrs
makVrf::DtTaskVisualizationMap	myTaskVisualizations
double	myNextTaskVisTickTime
DtSymbolString	myFullComponentName
DtSimulationServices *	mySimServices
DtPredicateCallbackManager *	myPredicateCallbackManager
boost::signals2::scoped_connection	myIsClutterChangedConnection
bool	myLocalDebug
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
bool	myInvalid
bool	myChangedFlag

Private Member Functions
	DtEmitterComponent ()
	DtEmitterComponent (const DtEmitterComponent &orig)
const DtEmitterComponent &	operator= (const DtEmitterComponent &orig)

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
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
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

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

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject 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).

virtual DtEmitterComponent::~DtEmitterComponent ( )

overridevirtual

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 ( )

overridevirtual

Tick the publisher if the component is on.

Reimplemented from DtSimComponent.

Reimplemented in DtRadarJammer.

virtual bool DtEmitterComponent::tickWhileDestroyed ( ) const

overridevirtual

Returns

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

Reimplemented from DtSimComponent.

virtual bool DtEmitterComponent::init ( )

overridevirtual

Calls createAndInitEmitterSystem, #updateEmitterFromDescriptoe, determineTrackJamAbility, etc..

Reimplemented from DtSimComponent.

Reimplemented in DtRadarJammer.

virtual void DtEmitterComponent::preFirstTickInit ( )

overridevirtual

Calls updateEmitterFromPsr and registers #nameChangedCallback.

Reimplemented from DtSimComponent.

Reimplemented in DtRadarJammer.

virtual const char* DtEmitterComponent::type ( ) const

overridevirtual

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. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.

Returns

DtEmitterComponentType

Implements DtSimComponent.

Reimplemented in DtRadarJammer.

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

static

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject 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).

Returns

New instance of this class.

virtual void DtEmitterComponent::registerSetRequestMsgCallbacks ( )

virtual

Registers its interest in setEmitter and setTarget messages.

Reimplemented in DtRadarJammer.

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::setEmitterTrackJamTargetsCallback ( DtSimMessage *  msg, void *  usrData  )

static

virtual void DtEmitterComponent::procesSetEmitterTrackJamTargetsRequestMessage ( DtSimMessage *  msg )

virtual

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

static

virtual void DtEmitterComponent::processRequestRadarModesAdmin ( const DtUUID &  receiver, const DtUUID &  sender, const DtVrfObjectMessage *  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

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

virtual void DtEmitterComponent::setSystemFunction ( DtEmissionFunc  functionEnum )

virtual

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

virtual DtEmissionFunc DtEmitterComponent::systemFunction ( ) const

virtual

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

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

virtual

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

virtual DtVector DtEmitterComponent::mountLocation ( ) const

virtual

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

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

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

virtual void DtEmitterComponent::setUseHighDensityTracking ( bool  useHdMode )

virtual

Accessors for the emitter's High-Density track/jam indicator on or off. When on, the receiving simulation is responsible for determining which entities are actually tracked/jammed. When off, the track/jam lists are populated explicitly, and should be used instead.

virtual bool DtEmitterComponent::useHighDensityTracking ( ) const

virtual

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

virtual void DtEmitterComponent::setUseHighDensityJamming ( bool  useHdMode )

virtual

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

virtual bool DtEmitterComponent::useHighDensityJamming ( ) const

virtual

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

virtual void DtEmitterComponent::setRadarMode ( const DtString &  mode )

virtual

Sets the name of the currently targeted object.

virtual DtString DtEmitterComponent::radarMode ( ) const

virtual

Gets the name of the currently targeted object.

virtual void DtEmitterComponent::setTrackTargetList ( const std::vector< DtUUID > &  strings )

virtual

Convenience method that clears the current track target list and replaces it with the given list.

virtual void DtEmitterComponent::setJamTargetList ( const std::vector< DtUUID > &  strings )

virtual

Convenience method that clears the current jam target list and replaces it with the given list.

virtual void DtEmitterComponent::addTrackTarget ( const DtUUID &  target )

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 DtUUID &  target )

virtual

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

virtual void DtEmitterComponent::addJamTarget ( const DtUUID &  target )

virtual

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

virtual void DtEmitterComponent::removeJamTarget ( const DtUUID &  target )

virtual

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

virtual void DtEmitterComponent::clearTrackTargets ( )

virtual

All tracking beams will have their track target list emptied.

virtual void DtEmitterComponent::clearJamTargets ( )

virtual

All jamming beams will have their jam target list emptied.

virtual makVrf::DtEmitterSystemBeamStateData* DtEmitterComponent::addBeam ( )

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 makVrf::DtEmitterSystemBeamStateData* 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 std::vector<makVrf::DtEmitterSystemBeamStateData>& 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 ( DtSimRadio *  radio )

protectedvirtual

virtual DtSimRadio* DtEmitterComponent::radio ( )

protectedvirtual

The radio this component is listening to.

virtual bool DtEmitterComponent::createAndInitEmitterSystem ( )

protectedvirtual

Creates a new DtVrfEmitterSystem and assigns it to myEmitterSystem.

Reimplemented in DtRadarJammer.

virtual void DtEmitterComponent::updateEmitterFromDescriptor ( )

protectedvirtual

Copies data from this components descriptor into the state repository.

virtual void DtEmitterComponent::updateEmitterFromPsr ( )

protectedvirtual

Conditionally updates the emitter system based on PSR or descriptor defaults.

virtual void DtEmitterComponent::determineTrackJamAbility ( )

protectedvirtual

Iterates over the beam descriptors to find out if we need to register for track/jam messages.

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 psrTypes.h.

Reimplemented in DtRadarJammer.

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

private

assignment operator; not implemented.

Member Data Documentation

DtSimRadio* DtEmitterComponent::myRadio

protected

DtVrfEmitterSystem* DtEmitterComponent::myEmitterSystem

protected

bool DtEmitterComponent::myRegisterForTrackMessages

protected

Set up in init by determineTrackJamAbility.

bool DtEmitterComponent::myRegisterForJamMessages

protected

DtEmitterPSR* DtEmitterComponent::myProcessState

protected

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

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfmodel/emitterComponent.h