Initializer for the radio system (including radios) More...

Inheritance diagram for makRadio::DtRadioSystemInitializer:

Public Types
typedef DtRwTemplatedListPtr < DtRwRadioState, true >	Radios

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

Public Member Functions
	DtRadioSystemInitializer (const DtString &name="radio-system", DtReaderWriterRegistry *parentRegistry=0)

	DtRadioSystemInitializer (const DtRadioSystemInitializer &)

virtual	~DtRadioSystemInitializer ()

DtRadioSystemInitializer &	operator= (const DtRadioSystemInitializer &)

virtual void	setPlaybackDevice (const DtString &)
	Only to be used if there is more than one sound card and you know the name. blank or unset is fine for most uses. More...

virtual const DtString &	playbackDevice () const

virtual void	setCaptureDevice (const DtString &)
	Only to be used if there is more than one sound card and you know the name. blank or unset is fine for most uses. More...

virtual const DtString &	captureDevice () const

virtual void	setVoxThreshold (double d)
	Default is 0.1. More...

virtual double	voxThreshold () const

virtual void	setEnableJammers (bool)
	Default is true. More...

virtual bool	enableJammers () const

virtual void	setSampleRate (int)
	Default is 11025; 22050, 44100 are other choices. More...

virtual int	sampleRate () const

virtual void	setFormat (const DtString &)
	Default is MONO8; MLAW8, MONO16 are other choices. More...

virtual const DtString &	format () const

virtual void	setCaptureFrequency (int)
	Default is 20 frequency (in hertz) for how often the capture device should be polled. More...

virtual int	captureFrequency () const

virtual void	setEnabled (bool)
	Whether or not system is enabled (default is true) More...

virtual bool	enabled () const

virtual void	clearRadios ()
	Clears out the current radios. More...

virtual void	addRadio (const DtRwRadioState &)
	Adds in a radio by radio name. Will remove existing radio of given name. More...

virtual void	removeRadio (const DtString &)
	Removes radio by the given name. More...

virtual const Radios &	radios () const
	Radios. More...

virtual bool	load (const DtFilename &)
	Loads the channel configuration from the given file. More...

virtual bool	save ()
	Saves the configuration to the last loaded filename. More...

virtual bool	save (const DtFilename &)
	Saves the configuration to the given filename. More...

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

virtual const char *	xmlType () 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 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	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data. More...

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

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

static void	initializeForReaderWriterFactory ()

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 Attributes
DtRwReal	myVoxThreshold

DtRwBoolean	myEnableJammers

DtRwInt	mySampleRate

DtRwString	myFormat

DtRwInt	myCaptureFrequency

DtRwString	myPlaybackDevice

DtRwString	myCaptureDevice

DtRwBoolean	myEnabled

Radios	myRadios

DtFilename	myConfigurationFile

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

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

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

Initializer for the radio system (including radios)

Member Typedef Documentation

typedef DtRwTemplatedListPtr<DtRwRadioState, true> makRadio::DtRadioSystemInitializer::Radios

Constructor & Destructor Documentation

makRadio::DtRadioSystemInitializer::DtRadioSystemInitializer	(	const DtString &	name = `"radio-system"`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

makRadio::DtRadioSystemInitializer::DtRadioSystemInitializer ( const DtRadioSystemInitializer & )

virtual makRadio::DtRadioSystemInitializer::~DtRadioSystemInitializer ( )

virtual

Member Function Documentation

DtRadioSystemInitializer& makRadio::DtRadioSystemInitializer::operator= ( const DtRadioSystemInitializer & )

virtual void makRadio::DtRadioSystemInitializer::setPlaybackDevice ( const DtString & )

virtual

Only to be used if there is more than one sound card and you know the name. blank or unset is fine for most uses.

virtual const DtString& makRadio::DtRadioSystemInitializer::playbackDevice ( ) const

virtual

virtual void makRadio::DtRadioSystemInitializer::setCaptureDevice ( const DtString & )

virtual

Only to be used if there is more than one sound card and you know the name. blank or unset is fine for most uses.

virtual const DtString& makRadio::DtRadioSystemInitializer::captureDevice ( ) const

virtual

virtual void makRadio::DtRadioSystemInitializer::setVoxThreshold ( double d )

virtual

Default is 0.1.

virtual double makRadio::DtRadioSystemInitializer::voxThreshold ( ) const

virtual

virtual void makRadio::DtRadioSystemInitializer::setEnableJammers ( bool )

virtual

Default is true.

virtual bool makRadio::DtRadioSystemInitializer::enableJammers ( ) const

virtual

virtual void makRadio::DtRadioSystemInitializer::setSampleRate ( int )

virtual

Default is 11025; 22050, 44100 are other choices.

virtual int makRadio::DtRadioSystemInitializer::sampleRate ( ) const

virtual

virtual void makRadio::DtRadioSystemInitializer::setFormat ( const DtString & )

virtual

Default is MONO8; MLAW8, MONO16 are other choices.

virtual const DtString& makRadio::DtRadioSystemInitializer::format ( ) const

virtual

virtual void makRadio::DtRadioSystemInitializer::setCaptureFrequency ( int )

virtual

Default is 20 frequency (in hertz) for how often the capture device should be polled.

larger numbers means more frequent polling and smaller capture buffers and lower latency smaller numbers means less frequent polling and larger capture buffers with higher latency

virtual int makRadio::DtRadioSystemInitializer::captureFrequency ( ) const

virtual

virtual void makRadio::DtRadioSystemInitializer::setEnabled ( bool )

virtual

Whether or not system is enabled (default is true)

virtual bool makRadio::DtRadioSystemInitializer::enabled ( ) const

virtual

virtual void makRadio::DtRadioSystemInitializer::clearRadios ( )

virtual

Clears out the current radios.

virtual void makRadio::DtRadioSystemInitializer::addRadio ( const DtRwRadioState & )

virtual

Adds in a radio by radio name. Will remove existing radio of given name.

virtual void makRadio::DtRadioSystemInitializer::removeRadio ( const DtString & )

virtual

Removes radio by the given name.

virtual const Radios& makRadio::DtRadioSystemInitializer::radios ( ) const

virtual

Radios.

virtual bool makRadio::DtRadioSystemInitializer::load ( const DtFilename & )

virtual

Loads the channel configuration from the given file.

virtual bool makRadio::DtRadioSystemInitializer::save ( )

virtual

Saves the configuration to the last loaded filename.

virtual bool makRadio::DtRadioSystemInitializer::save ( const DtFilename & )

virtual

Saves the configuration to the given filename.

virtual const char* makRadio::DtRadioSystemInitializer::readerWriterType ( ) const

virtual

Used to supply a string type that this reader writer type is.

This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create

Reimplemented from DtReaderWriter.

static const char* makRadio::DtRadioSystemInitializer::theXmlType ( )

static

The type that is used when archiving to an XML stream.

virtual const char* makRadio::DtRadioSystemInitializer::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

static void makRadio::DtRadioSystemInitializer::initializeForReaderWriterFactory ( )

static

Member Data Documentation

DtRwReal makRadio::DtRadioSystemInitializer::myVoxThreshold

protected

DtRwBoolean makRadio::DtRadioSystemInitializer::myEnableJammers

protected

DtRwInt makRadio::DtRadioSystemInitializer::mySampleRate

protected

DtRwString makRadio::DtRadioSystemInitializer::myFormat

protected

DtRwInt makRadio::DtRadioSystemInitializer::myCaptureFrequency

protected

DtRwString makRadio::DtRadioSystemInitializer::myPlaybackDevice

protected

DtRwString makRadio::DtRadioSystemInitializer::myCaptureDevice

protected

DtRwBoolean makRadio::DtRadioSystemInitializer::myEnabled

protected

Radios makRadio::DtRadioSystemInitializer::myRadios

protected

DtFilename makRadio::DtRadioSystemInitializer::myConfigurationFile

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/makRadio/radioSystemInitializer.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation