DtEmitterBeamListEntry Class Reference

DtEmitterBeamListEntry; descriptor that represents members of a DtEmitterBeamList object. More...

Inheritance diagram for DtEmitterBeamListEntry:

Public Member Functions
	DtEmitterBeamListEntry ()
	default constructor
	DtEmitterBeamListEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtEmitterBeamListEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtEmitterBeamListEntry ()
	destructor
	DtEmitterBeamListEntry (const DtString &name, const DtEmitterBeamListEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtEmitterBeamListEntry (const DtSymbolString &name, const DtEmitterBeamListEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtEmitterBeamListEntry &	operator= (const DtEmitterBeamListEntry &orig)
	assignment operator
virtual DtEmitterBeamListEntry *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtEmitterBeamListEntry *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtInt16	index () const
	Accessor/mutator for myIndex.
virtual void	setIndex (DtInt16 index)
	Accessor/mutator for myIndex.
virtual DtString	beamType () const
	Accessor/mutator for myBeamType.
virtual void	setBeamType (const DtString &typeString)
	Accessor/mutator for myBeamType.
virtual DtFloat32	frequency () const
	Accessor/mutator for myFrequency.
virtual void	setFrequency (DtFloat32 value)
	Accessor/mutator for myFrequency.
virtual DtFloat32	frequencyRange () const
	Accessor/mutator for myFrequencyRange.
virtual void	setFrequencyRange (DtFloat32 value)
	Accessor/mutator for myFrequencyRange.
virtual DtFloat32	power () const
	Accessor/mutator for myPower.
virtual void	setPower (DtFloat32 value)
	Accessor/mutator for myPower.
virtual DtFloat32	prf () const
	Accessor/mutator for myPrf.
virtual void	setPrf (DtFloat32 value)
	Accessor/mutator for myPrf.
virtual DtFloat32	pulseWidth () const
	Accessor/mutator for myPulseWidth.
virtual void	setPulseWidth (DtFloat32 value)
	Accessor/mutator for myPulseWidth.
virtual DtFloat32	azimuthCenter () const
	Accessor/mutator for myAzCenter.
virtual void	setAzimuthCenter (DtFloat32 value)
	Accessor/mutator for myAzCenter.
virtual DtFloat32	azimuthSweep () const
	Accessor/mutator for myAzSweep.
virtual void	setAzimuthSweep (DtFloat32 value)
	Accessor/mutator for myAzSweep.
virtual DtFloat32	elevationCenter () const
	Accessor/mutator for myElCenter.
virtual void	setElevationCenter (DtFloat32 value)
	Accessor/mutator for myElCenter.
virtual DtFloat32	elevationSweep () const
	Accessor/mutator for myElSweep.
virtual void	setElevationSweep (DtFloat32 value)
	Accessor/mutator for myElSweep.
virtual DtFloat32	sweepSync () const
	Accessor/mutator for mySweepSync.
virtual void	setSweepSync (DtFloat32 value)
	Accessor/mutator for mySweepSync.
virtual DtU16	beamFunction () const
	Accessor/mutator for myBeamFunction.
virtual void	setBeamFunction (DtU16 functionEnum)
	Accessor/mutator for myBeamFunction.
virtual DtU16	beamParamIndex () const
	Accessor/mutator for myBeamParamIndex.
virtual void	setBeamParamIndex (DtU16 value)
	Accessor/mutator for myBeamParamIndex.
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.

Protected Attributes
Parameters
These parameters are available for setting in the OPD files.
DtRwInt	myIndex
	Parameter Name: index Parameter Description: Parameter Default Value: -1.
DtRwString	myBeamType
	Parameter Name: type Parameter Description: The type of beam, tracking or jamming.
DtRwReal	myFrequency
	Parameter Name: frequency Parameter Description: Center frequency of emission.
DtRwReal	myFrequencyRange
	Parameter Name: frequency-range Parameter Description: Frequency range around center.
DtRwReal	myPower
	Parameter Name: power Parameter Description: Effective radiated power.
DtRwReal	myPrf
	Parameter Name: pulse-repetition-frequency Parameter Description: Pulse repetition frequency.
DtRwReal	myPulseWidth
	Parameter Name: pulse-width Parameter Description: Pulse width.
DtRwReal	myAzCenter
	Parameter Name: azimuth-center Parameter Description: Azimuth center of emission.
DtRwReal	myAzSweep
	Parameter Name: azimuth-sweep Parameter Description: Azimuth range around center.
DtRwReal	myElCenter
	Parameter Name: elevation-center Parameter Description: Elevation center of emission.
DtRwReal	myElSweep
	Parameter Name: elevation-sweep Parameter Description: Elevation range around center.
DtRwReal	mySweepSync
	Parameter Name: sweep-sync Parameter Description: Sweep sync, as a percentage.
DtRwInt	myBeamFunction
	Parameter Name: beam-function-enum Parameter Description: Beam function enumeration.
DtRwInt	myBeamParamIndex
	Parameter Name: beam-param-index Parameter Description: Beam parameter index.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
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 ()
static DtReaderWriterFactory *	factory ()
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 void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
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

Detailed Description

DtEmitterBeamListEntry; descriptor that represents members of a DtEmitterBeamList object.

Instances of DtEmitterBeamListEntry are used by the DtEmitterBeamList class to parse the beam parameters portion of the opd file.

Constructor & Destructor Documentation

DtEmitterBeamListEntry::DtEmitterBeamListEntry

(

)

default constructor

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

real constructor

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

virtual DtEmitterBeamListEntry::~DtEmitterBeamListEntry ( )

virtual

destructor

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

copy constructor

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

Member Function Documentation

DtEmitterBeamListEntry& DtEmitterBeamListEntry::operator=

(

const DtEmitterBeamListEntry &

orig

)

assignment operator

virtual DtEmitterBeamListEntry* DtEmitterBeamListEntry::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = NULL  ) const

virtual

virtual DtEmitterBeamListEntry* DtEmitterBeamListEntry::clone ( const DtSymbolString &  name, DtReaderWriterRegistry *  parentRegistry = NULL  ) const

virtual

virtual DtInt16 DtEmitterBeamListEntry::index ( ) const

virtual

Accessor/mutator for myIndex.

virtual void DtEmitterBeamListEntry::setIndex ( DtInt16  index )

virtual

Accessor/mutator for myIndex.

virtual DtString DtEmitterBeamListEntry::beamType ( ) const

virtual

Accessor/mutator for myBeamType.

virtual void DtEmitterBeamListEntry::setBeamType ( const DtString &  typeString )

virtual

Accessor/mutator for myBeamType.

virtual DtFloat32 DtEmitterBeamListEntry::frequency ( ) const

virtual

Accessor/mutator for myFrequency.

virtual void DtEmitterBeamListEntry::setFrequency ( DtFloat32  value )

virtual

Accessor/mutator for myFrequency.

virtual DtFloat32 DtEmitterBeamListEntry::frequencyRange ( ) const

virtual

Accessor/mutator for myFrequencyRange.

virtual void DtEmitterBeamListEntry::setFrequencyRange ( DtFloat32  value )

virtual

Accessor/mutator for myFrequencyRange.

virtual DtFloat32 DtEmitterBeamListEntry::power ( ) const

virtual

Accessor/mutator for myPower.

virtual void DtEmitterBeamListEntry::setPower ( DtFloat32  value )

virtual

Accessor/mutator for myPower.

virtual DtFloat32 DtEmitterBeamListEntry::prf ( ) const

virtual

Accessor/mutator for myPrf.

virtual void DtEmitterBeamListEntry::setPrf ( DtFloat32  value )

virtual

Accessor/mutator for myPrf.

virtual DtFloat32 DtEmitterBeamListEntry::pulseWidth ( ) const

virtual

Accessor/mutator for myPulseWidth.

virtual void DtEmitterBeamListEntry::setPulseWidth ( DtFloat32  value )

virtual

Accessor/mutator for myPulseWidth.

virtual DtFloat32 DtEmitterBeamListEntry::azimuthCenter ( ) const

virtual

Accessor/mutator for myAzCenter.

virtual void DtEmitterBeamListEntry::setAzimuthCenter ( DtFloat32  value )

virtual

Accessor/mutator for myAzCenter.

virtual DtFloat32 DtEmitterBeamListEntry::azimuthSweep ( ) const

virtual

Accessor/mutator for myAzSweep.

virtual void DtEmitterBeamListEntry::setAzimuthSweep ( DtFloat32  value )

virtual

Accessor/mutator for myAzSweep.

virtual DtFloat32 DtEmitterBeamListEntry::elevationCenter ( ) const

virtual

Accessor/mutator for myElCenter.

virtual void DtEmitterBeamListEntry::setElevationCenter ( DtFloat32  value )

virtual

Accessor/mutator for myElCenter.

virtual DtFloat32 DtEmitterBeamListEntry::elevationSweep ( ) const

virtual

Accessor/mutator for myElSweep.

virtual void DtEmitterBeamListEntry::setElevationSweep ( DtFloat32  value )

virtual

Accessor/mutator for myElSweep.

virtual DtFloat32 DtEmitterBeamListEntry::sweepSync ( ) const

virtual

Accessor/mutator for mySweepSync.

virtual void DtEmitterBeamListEntry::setSweepSync ( DtFloat32  value )

virtual

Accessor/mutator for mySweepSync.

virtual DtU16 DtEmitterBeamListEntry::beamFunction ( ) const

virtual

Accessor/mutator for myBeamFunction.

virtual void DtEmitterBeamListEntry::setBeamFunction ( DtU16  functionEnum )

virtual

Accessor/mutator for myBeamFunction.

virtual DtU16 DtEmitterBeamListEntry::beamParamIndex ( ) const

virtual

Accessor/mutator for myBeamParamIndex.

virtual void DtEmitterBeamListEntry::setBeamParamIndex ( DtU16  value )

virtual

Accessor/mutator for myBeamParamIndex.

Member Data Documentation

DtRwInt DtEmitterBeamListEntry::myIndex

protected

Parameter Name: index
Parameter Description:
Parameter Default Value: -1.

DtRwString DtEmitterBeamListEntry::myBeamType

protected

Parameter Name: type
Parameter Description: The type of beam, tracking or jamming.

The string must be one of the two possible values.
Parameter Default Value: "track"
Parameter Units: "track" or "jam".

DtRwReal DtEmitterBeamListEntry::myFrequency

protected

Parameter Name: frequency
Parameter Description: Center frequency of emission.

Parameter Default Value: 0.
Parameter Units: Hertz

DtRwReal DtEmitterBeamListEntry::myFrequencyRange

protected

Parameter Name: frequency-range
Parameter Description: Frequency range around center.

Parameter Default Value: 0.
Parameter Units: Hertz

DtRwReal DtEmitterBeamListEntry::myPower

protected

Parameter Name: power
Parameter Description: Effective radiated power.

Parameter Default Value: 0.
Parameter Units: dBm

DtRwReal DtEmitterBeamListEntry::myPrf

protected

Parameter Name: pulse-repetition-frequency
Parameter Description: Pulse repetition frequency.

Parameter Default Value: 0.
Parameter Units: Hertz

DtRwReal DtEmitterBeamListEntry::myPulseWidth

protected

Parameter Name: pulse-width
Parameter Description: Pulse width.

Parameter Default Value:
Parameter Units: milliseconds

DtRwReal DtEmitterBeamListEntry::myAzCenter

protected

Parameter Name: azimuth-center
Parameter Description: Azimuth center of emission.

Parameter Default Value: 0.
Parameter Units: radians

DtRwReal DtEmitterBeamListEntry::myAzSweep

protected

Parameter Name: azimuth-sweep
Parameter Description: Azimuth range around center.

Parameter Default Value: 0.
Parameter Units: radians

DtRwReal DtEmitterBeamListEntry::myElCenter

protected

Parameter Name: elevation-center
Parameter Description: Elevation center of emission.

Parameter Default Value: 0.
Parameter Units: radians

DtRwReal DtEmitterBeamListEntry::myElSweep

protected

Parameter Name: elevation-sweep
Parameter Description: Elevation range around center.

Parameter Default Value: 0.
Parameter Units: radians

DtRwReal DtEmitterBeamListEntry::mySweepSync

protected

Parameter Name: sweep-sync
Parameter Description: Sweep sync, as a percentage.

Parameter Default Value: 0.

DtRwInt DtEmitterBeamListEntry::myBeamFunction

protected

Parameter Name: beam-function-enum
Parameter Description: Beam function enumeration.

(See the DIS Enumerations Document.)
Parameter Default Value: 0

DtRwInt DtEmitterBeamListEntry::myBeamParamIndex

protected

Parameter Name: beam-param-index
Parameter Description: Beam parameter index.

Parameter Default Value: 0

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/emtrBeamEnt.h