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)

virtual	~DtEmitterComponent ()
	destructor More...

virtual void	tick ()
	Tick the publisher if the component is on. More...

virtual bool	tickWhileDestroyed () const

bool	init ()
	Calls createAndInitEmitterSystem, #updateEmitterFromDescriptoe, determineTrackJamAbility, etc. More...

virtual void	preFirstTickInit ()
	Calls updateEmitterFromPsr and registers #nameChangedCallback. More...

virtual const char *	type () const
	Returns a string identifies the class type of component. More...

virtual void	registerSetRequestMsgCallbacks ()
	Registers its interest in setEmitter and setTarget messages. More...

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)
	Sets the name of the currently targeted object. More...

virtual DtString	radarMode () const
	Gets the name of the currently targeted object. More...

virtual void	setTrackTargetList (const std::vector< DtUUID > &strings)
	Convenience method that clears the current track target list and replaces it with the given list. More...

virtual void	setJamTargetList (const std::vector< DtUUID > &strings)
	Convenience method that clears the current jam target list and replaces it with the given list. More...

virtual void	addTrackTarget (const DtUUID &target)
	All beams in the system which are tracking beams will have this entity added to their track/jam lists. More...

virtual void	removeTrackTarget (const DtUUID &target)
	All beams in the system which are tracking beams will have this entity removed from their track/jam lists. More...

virtual void	addJamTarget (const DtUUID &target)
	All beams in the system which are jamming beams will have this entity added to their track/jam lists. More...

virtual void	removeJamTarget (const DtUUID &target)
	All beams in the system which are jamming beams will have this entity removed from their track/jam lists. More...

virtual void	clearTrackTargets ()
	All tracking beams will have their track target list emptied. More...

virtual void	clearJamTargets ()
	All jamming beams will have their jam target list emptied. More...

virtual DtEmitterBeamRepository *	addBeam (DtU8 id)
	Adds a new beam if the ID does not already exist and returns a pointer to the beam repository. More...

virtual void	removeBeam (DtU8 id)
	Removes a beam from this system. More...

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

virtual int	numBeams () const
	Returns total number of beams in this system. More...

virtual DtList *	beamList ()
	Returns list to the beam repositories. More...

virtual DtVrfEmitterSystem *	emitterSystem ()
	Returns the DtVrfEmitterSystem that is implementing the publishing of emitter beams. More...


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)
	When true, EM Emissions PDUs are published as normal. More...

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, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtSimComponent ()
	destructor More...

virtual void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component. More...

DtComponentSystem *	parentSystem () const

virtual bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager. More...

virtual void	registerAttributeFunctions ()
	Called to register functions that provide system attribute values. More...

virtual void	postTick ()
	This function is called immediately after tick() is called. More...

virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived. More...

virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as More...

virtual double	minTickPeriod () const
	access the minimum tick period More...

virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time More...

virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period More...

virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally. More...

virtual double	nextTickTime () const
	access the next tick time More...

virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. More...

virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at. More...

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

virtual DtSimComponent *	nextComponent ()
	List management functions. More...

virtual DtSimComponent *	prevComponent ()

virtual void	setListItem (DtListItem *item)
	Used by DtComponentList. More...

virtual DtListItem *	listItem ()

virtual void	putData (std::string &fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class. More...

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored. More...

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

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

virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component. More...

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

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

virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component. More...

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

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

virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component. More...

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

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

virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component. More...

virtual int	priority () const
	Return the current connection priority for this component. More...

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

double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT. More...

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

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

virtual const DtComponentDescriptor *	componentDescriptor () const

DtVrfProcessStateRepositoryManager *	psrManager ()

virtual const DtSymbolString &	componentFullName () const

DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in. More...

const DtPhysicalWorld *	physicalWorld () const

DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any. More...

const DtAttachedTerrain *	terrainAttachedTo () const

DtVrfObject *	entity ()
	Gets the entity. More...

const DtVrfObject *	entity () const

const DtVrfObject *	const_entity () const
	You would want to use this call if you could be either a const or non-const entity, and you wanted to be sure you only had const access. More...

DtSimManager *	simManager ()
	Gets the sim manager. More...

const DtSimManager *	simManager () const

const Coordinate_System *	coordinateSystem () const
	Gets the coordinate system, as it should always exist if the physical world is in a valid state! More...

DtVrfObjectStateRepository *	localStateRepository ()
	Gets the local state repository. More...

const DtVrfObjectStateRepository *	localStateRepository () const

const DtVrfObjectStateRepository *	const_localStateRepository () const
	You would want to use this call if you could be either a const or non-const local state repository, and you wanted to be sure you only had const access. More...

virtual DtTaskVisualizationMap &	taskVisualizations ()
	Returns the list of task visualizations for this component. More...

virtual bool	taskVisualizationsActive () const
	Returns true if task visualizations are currently active for this component. More...

virtual bool	taskVisualizationsEnabled () const
	Returns true if task visualizations are enabled for this component. More...

virtual bool	isThreadSafe () const
	Returns true if this component is marked as being thread safe. More...

virtual void	addVRLinkDeferredJob (const boost::function< void()> &callback)
	Adds a deferred job to the VRLink job queue in the DtParallelTickManager, but only if this component is marked at thread safe. More...

virtual void	onRestore ()
	Called whenever a component is restored. Default is no-op. More...

virtual void	enable ()
	Is this component enabled or not. More...

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 DtSimResourceManager &	resourceManager ()

virtual const DtSimResourceManager &	resourceManager () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...

bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()
	destructor More...

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file. More...

virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...

virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...

virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...

virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...

virtual void	writeSelf (std::string &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. More...

virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...

virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)
	Set read-only flag. More...

bool	isReadonly () const

virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...

virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...

virtual bool	variableIsBound () const

virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...

virtual void	setName (const DtString &)
	Set the name of the object. More...

virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...

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

virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...

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

virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...

virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...

virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...

virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...

virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values. More...

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...

virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified. More...

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here. More...

const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...

virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...

virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...

virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...

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())
	Gets data from the environment value. More...

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More...

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject owner, DtSimManager 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 DtSimComponent *	MarkThreadSafe (DtSimComponent *)
	Marks an instance of a component as being thread safe. More...

static DtSimComponentFactory *	factory ()
	A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set. More...

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

static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
	Adds a DtSimComponent creation function to the DtSimComponentFactory, using the given type as the key. More...

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 ()
	The type that is used when archiving to an XML stream. More...

static const DtFilename &	appPath ()
	Gets the current working directory. More...

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...

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)
	Given a filename, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

Protected Member Functions
virtual void	setRadio (DtSimRadio *radio)

virtual DtSimRadio *	radio ()
	The radio this component is listening to. More...

virtual bool	createAndInitEmitterSystem ()
	Creates a new DtVrfEmitterSystem and assigns it to myEmitterSystem. More...

virtual void	updateEmitterFromDescriptor ()
	Copies data from this components descriptor into the state repository. More...

virtual void	updateEmitterFromPsr ()
	Conditionally updates the emitter system based on PSR or descriptor defaults. More...

virtual void	determineTrackJamAbility ()
	Iterates over the beam descriptors to find out if we need to register for track/jam messages. More...

virtual bool	createPSR ()
	Creates myProcessState data member, and adds it to our process state repository manager. More...

Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()
	Compute current time and myDT. More...

bool	testInvariant () const

virtual bool	createPortGroups ()
	Called by init. More...

virtual bool	createPorts ()
	Called by init. More...

DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
	Creates a PSR for this component and registers it with the PSR manager. More...

virtual void	updateTaskVisualizations ()
	Called to update task visualizations after every tick. More...

virtual void	destroyTaskVisualizations ()
	Destroys all task visualizations for this component. More...

virtual void	destroyTaskVisualization (const DtString &name)
	Destroys an existing task visualization. More...

virtual DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
	Finds an existing or creates a new point task visualization with the given name. More...

virtual DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
	Finds an existing or creates a new line task visualization with the given name. More...

virtual DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
	Finds an existing or creates a new area task visualization with the given name. More...

virtual DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
	Finds an existing or creates a new text task visualization with the given name. More...

double	calculateNextTaskVisTickTime () const
	Determines the next time the task visualizations should be ticked. More...

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...

Protected Attributes
DtSimRadio *	myRadio

DtVrfEmitterSystem *	myEmitterSystem

DtU8	myEmitterSystemId

bool	myRegisterForTrackMessages
	Set up in init by determineTrackJamAbility. More...

bool	myRegisterForJamMessages

DtEmitterPSR *	myProcessState
	Container for state data associated with this component. More...

Protected Attributes inherited from DtSimComponent
DtVrfObject *	myEntity

DtVrfObjectStateRepository *	myLocalStateRepository

DtSimManager *	mySimManager

DtComponentSystem *	mySystem
	Pointer to the DtComponentSystem that this component belongs. More...

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

bool	myFirstTick
	Initialized to true in the constructor, set to false by the first call to postTick. More...

bool	myIsThreadSafe
	Whether this component can be use the DtCriticalSection versions of the tick functions and be ticked in parallel with other components Defaults to false. More...

const DtComponentDescriptor *	myComponentDescriptor

std::list < DtVrfProcessStateRepository * >	myComponentPsrs
	List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed. More...

bool	myTickEveryFrame
	Flag indicating that tickPeriod is set to 0, and the component will tick every frame. More...

DtTaskVisualizationMap	myTaskVisualizations
	The visualization objects to be drawn for this component. More...

double	myNextTaskVisTickTime
	The next tick time for updating the task visualizations. More...

DtSymbolString	myFullComponentName

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
	Container for the aliases which represent alternative names for the object. More...

bool	myInvalid
	Set to true if there is a problem reading this item. More...

bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

Private Member Functions
	DtEmitterComponent ()
	Default constructor; not implemented. More...

	DtEmitterComponent (const DtEmitterComponent &orig)
	copy constructor; not implemented. More...

const DtEmitterComponent &	operator= (const DtEmitterComponent &orig)
	assignment operator; not implemented. More...

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

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

Constructor & Destructor Documentation

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

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

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.

Reimplemented in DtRadarJammer.

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 createAndInitEmitterSystem, #updateEmitterFromDescriptoe, determineTrackJamAbility, etc.

Reimplemented from DtSimComponent.

Reimplemented in DtRadarJammer.

virtual void DtEmitterComponent::preFirstTickInit ( )

virtual

Calls updateEmitterFromPsr and registers #nameChangedCallback.

Reimplemented from DtSimComponent.

Reimplemented in DtRadarJammer.

virtual const char* 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. 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,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

static

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

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

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::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::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

virtual void DtEmitterComponent::setUseHighDensityJamming ( bool useHdMode )

virtual

virtual bool DtEmitterComponent::useHighDensityJamming ( ) const

virtual

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 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 ( 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 procSRTypes.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

DtU8 DtEmitterComponent::myEmitterSystemId

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.vrf4-10-branch/include/vrfmodel/emitterComponent.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation