DtActiveSonarBeamListEntry Class Reference

DtActiveSonarBeamListEntry; descriptor that represents members of a DtActiveSonarBeamList object. More...

Inheritance diagram for DtActiveSonarBeamListEntry:

Public Member Functions
	DtActiveSonarBeamListEntry ()
	default constructor
	DtActiveSonarBeamListEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtActiveSonarBeamListEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtActiveSonarBeamListEntry ()
	destructor
	DtActiveSonarBeamListEntry (const DtString &name, const DtActiveSonarBeamListEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtActiveSonarBeamListEntry (const DtSymbolString &name, const DtActiveSonarBeamListEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtActiveSonarBeamListEntry &	operator= (const DtActiveSonarBeamListEntry &orig)
	assignment operator
virtual DtActiveSonarBeamListEntry *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtActiveSonarBeamListEntry *	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	azimuthCenter () const
	Accessor/mutator for myAzCenter.
virtual void	setAzimuthCenter (DtFloat32 value)
	Accessor/mutator for myAzCenter.
virtual DtFloat32	azimuthBeamwidth () const
	Accessor/mutator for myAzBeamwidth.
virtual void	setAzimuthBeamwidth (DtFloat32 value)
	Accessor/mutator for myAzBeamwidth.
virtual DtFloat32	elevationCenter () const
	Accessor/mutator for myElCenter.
virtual void	setElevationCenter (DtFloat32 value)
	Accessor/mutator for myElCenter.
virtual DtFloat32	elevationBeamwidth () const
	Accessor/mutator for myElBeamwidth.
virtual void	setElevationBeamwidth (DtFloat32 value)
	Accessor/mutator for myElBeamwidth.
virtual DtU16	beamParamIndex () const
	Accessor/mutator for myBeamParamIndex.
virtual void	setBeamParamIndex (DtU16 value)
	Accessor/mutator for myBeamParamIndex.
virtual DtU16	scanPattern () const
	Accessor/mutator for myScanPattern.
virtual void	setScanPattern (DtU16 value)
	Accessor/mutator for myScanPattern.
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
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	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
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 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.
virtual bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
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.
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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.
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.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

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	myAzCenter
	Parameter Name: azimuth-center Parameter Description: Azimuth center of beam.
DtRwReal	myAzBeamwidth
	Parameter Name: azimuth-beamwidth Parameter Description: Azimuth width of beam.
DtRwReal	myElCenter
	Parameter Name: elevation-center Parameter Description: Elevation center of beam.
DtRwReal	myElBeamwidth
	Parameter Name: elevation-beamwidth Parameter Description: Elevation width of beam.
DtRwInt	myBeamFunction
	Parameter Name: beam-function-enum Parameter Description: Beam function enumeration.
DtRwInt	myBeamParamIndex
	Parameter Name: beam-param-index Parameter Description: Beam parameter index.
DtRwInt	myScanPattern
	Parameter Name: scan-pattern Parameter Description: Beam scan pattern.
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.
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::vector< DtFilename >	SearchPaths
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 char *	theXmlType ()
	The type that is used when archiving to an XML stream.
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 void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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

DtActiveSonarBeamListEntry; descriptor that represents members of a DtActiveSonarBeamList object.

Instances of DtActiveSonarBeamListEntry are used by the DtActiveSonarBeamList class to parse the beam parameters portion of the opd file.

Constructor & Destructor Documentation

DtActiveSonarBeamListEntry::DtActiveSonarBeamListEntry

(

)

default constructor

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

real constructor

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

virtual DtActiveSonarBeamListEntry::~DtActiveSonarBeamListEntry ( )

virtual

destructor

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

copy constructor

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

Member Function Documentation

DtActiveSonarBeamListEntry& DtActiveSonarBeamListEntry::operator=

(

const DtActiveSonarBeamListEntry &

orig

)

assignment operator

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

virtual

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

virtual

virtual DtInt16 DtActiveSonarBeamListEntry::index ( ) const

virtual

Accessor/mutator for myIndex.

virtual void DtActiveSonarBeamListEntry::setIndex ( DtInt16  index )

virtual

Accessor/mutator for myIndex.

virtual DtString DtActiveSonarBeamListEntry::beamType ( ) const

virtual

Accessor/mutator for myBeamType.

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

virtual

Accessor/mutator for myBeamType.

virtual DtFloat32 DtActiveSonarBeamListEntry::azimuthCenter ( ) const

virtual

Accessor/mutator for myAzCenter.

virtual void DtActiveSonarBeamListEntry::setAzimuthCenter ( DtFloat32  value )

virtual

Accessor/mutator for myAzCenter.

virtual DtFloat32 DtActiveSonarBeamListEntry::azimuthBeamwidth ( ) const

virtual

Accessor/mutator for myAzBeamwidth.

virtual void DtActiveSonarBeamListEntry::setAzimuthBeamwidth ( DtFloat32  value )

virtual

Accessor/mutator for myAzBeamwidth.

virtual DtFloat32 DtActiveSonarBeamListEntry::elevationCenter ( ) const

virtual

Accessor/mutator for myElCenter.

virtual void DtActiveSonarBeamListEntry::setElevationCenter ( DtFloat32  value )

virtual

Accessor/mutator for myElCenter.

virtual DtFloat32 DtActiveSonarBeamListEntry::elevationBeamwidth ( ) const

virtual

Accessor/mutator for myElBeamwidth.

virtual void DtActiveSonarBeamListEntry::setElevationBeamwidth ( DtFloat32  value )

virtual

Accessor/mutator for myElBeamwidth.

virtual DtU16 DtActiveSonarBeamListEntry::beamParamIndex ( ) const

virtual

Accessor/mutator for myBeamParamIndex.

virtual void DtActiveSonarBeamListEntry::setBeamParamIndex ( DtU16  value )

virtual

Accessor/mutator for myBeamParamIndex.

virtual DtU16 DtActiveSonarBeamListEntry::scanPattern ( ) const

virtual

Accessor/mutator for myScanPattern.

virtual void DtActiveSonarBeamListEntry::setScanPattern ( DtU16  value )

virtual

Accessor/mutator for myScanPattern.

Member Data Documentation

DtRwInt DtActiveSonarBeamListEntry::myIndex

protected

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

DtRwString DtActiveSonarBeamListEntry::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 DtActiveSonarBeamListEntry::myAzCenter

protected

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

Parameter Default Value: 0.
Parameter Units: radians

DtRwReal DtActiveSonarBeamListEntry::myAzBeamwidth

protected

Parameter Name: azimuth-beamwidth
Parameter Description: Azimuth width of beam.

Parameter Default Value: 0.
Parameter Units: radians

DtRwReal DtActiveSonarBeamListEntry::myElCenter

protected

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

Parameter Default Value: 0.
Parameter Units: radians

DtRwReal DtActiveSonarBeamListEntry::myElBeamwidth

protected

Parameter Name: elevation-beamwidth
Parameter Description: Elevation width of beam.

Parameter Default Value: 0.
Parameter Units: radians

DtRwInt DtActiveSonarBeamListEntry::myBeamFunction

protected

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

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

DtRwInt DtActiveSonarBeamListEntry::myBeamParamIndex

protected

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

Parameter Default Value: 0

DtRwInt DtActiveSonarBeamListEntry::myScanPattern

protected

Parameter Name: scan-pattern
Parameter Description: Beam scan pattern.

Parameter Default Value: 0

---

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

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