DtVrfRadioTransmitterParams Class Reference

Inheritance diagram for DtVrfRadioTransmitterParams:

Public Member Functions
	DtVrfRadioTransmitterParams (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtVrfRadioTransmitterParams (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtVrfRadioTransmitterParams (const DtVrfRadioTransmitterParams &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtVrfRadioTransmitterParams &	operator= (const DtVrfRadioTransmitterParams &orig)
	assignment
virtual	~DtVrfRadioTransmitterParams ()
virtual const DtRadioEntityType &	radioType () const
	See myRadioType.
virtual void	setRadioType (const DtRadioEntityType &radioType)
	See myRadioType.
virtual double	initialFrequency () const
	See myInitialFrequency.
virtual void	setInitialFrequency (double freq)
	See myInitialFrequency.
virtual double	power () const
	See myPower.
virtual void	setPower (double power)
	See myPower.
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
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 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
DtRwRadioEntityType	myRadioType
	The radio type enumeration for the transmitter to publish.
DtRwReal	myInitialFrequency
	The initial frequency published by the transmitter.
DtRwReal	myPower
	The power published by the transmitter.
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
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 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 DtReaderWriterFactory	theFactory

Constructor & Destructor Documentation

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

real constructor

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

DtVrfRadioTransmitterParams::DtVrfRadioTransmitterParams	(	const DtVrfRadioTransmitterParams &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtVrfRadioTransmitterParams::~DtVrfRadioTransmitterParams ( )

virtual

Member Function Documentation

DtVrfRadioTransmitterParams& DtVrfRadioTransmitterParams::operator=

(

const DtVrfRadioTransmitterParams &

orig

)

assignment

virtual const DtRadioEntityType& DtVrfRadioTransmitterParams::radioType ( ) const

virtual

See myRadioType.

virtual void DtVrfRadioTransmitterParams::setRadioType ( const DtRadioEntityType &  radioType )

virtual

See myRadioType.

virtual double DtVrfRadioTransmitterParams::initialFrequency ( ) const

virtual

See myInitialFrequency.

virtual void DtVrfRadioTransmitterParams::setInitialFrequency ( double  freq )

virtual

See myInitialFrequency.

virtual double DtVrfRadioTransmitterParams::power ( ) const

virtual

See myPower.

virtual void DtVrfRadioTransmitterParams::setPower ( double  power )

virtual

See myPower.

Member Data Documentation

DtRwRadioEntityType DtVrfRadioTransmitterParams::myRadioType

protected

The radio type enumeration for the transmitter to publish.

See the DIS Enumerations Document for details.

DtRwReal DtVrfRadioTransmitterParams::myInitialFrequency

protected

The initial frequency published by the transmitter.

Specified in Hz.

DtRwReal DtVrfRadioTransmitterParams::myPower

protected

The power published by the transmitter.

Specified in dB-millitwatts.

---

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

• include/vrfobjparam/vrfRadioTransmitterParams.h