DtSetSpotReportingRequest Class Reference

Inheritance diagram for DtSetSpotReportingRequest:

Public Member Functions
	DtSetSpotReportingRequest ()
	default constructor
	DtSetSpotReportingRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a request 'put' itself, the writeName will preface it.
	DtSetSpotReportingRequest (const DtString &writeName, const DtSetSpotReportingRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSetSpotReportingRequest &	operator= (const DtSetSpotReportingRequest &orig)
	assignment operator
virtual	~DtSetSpotReportingRequest ()
virtual const DtSetMessageType &	type () const
	Returns DtSetSpotReportingRequestType.
virtual DtSetDataRequest *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of the request.
virtual DtString	stringRep () const
	Get a readable string representation of this setDataRequest.
virtual const std::vector < DtString > &	spotReportingReceivers () const
virtual void	setSpotReportingReceivers (const std::vector< DtString > &receivers)
virtual bool	useGlobalReceivers () const
virtual void	setUseGlobalReceivers (bool useGlobal)
virtual int	netRepSize () const
	Returns the size of the full network representation padded to an 8-byte boundary.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Fills in the task from the network buffer.
virtual bool	setToNet ()
	Fills in the network buffer (created by base class simTask) with the task contents.
virtual int	spotReporting () const
	If globalEnabledOverridingLocal is not true, this represents the local setting for enabling spot reports.
virtual void	setSpotReporting (int spot)
	If globalEnabledOverridingLocal is not true, this represents the local setting for enabling spot reports.
Public Member Functions inherited from DtSetDataRequest
virtual	~DtSetDataRequest ()
	destructor
virtual bool	init ()
	Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored.
virtual char *	netRep ()
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.

Static Public Member Functions
static DtSetDataRequest *	creator ()
Static Public Member Functions inherited from DtSetDataRequest
static DtSetDataRequest *	createSetDataRequest (DtlObjPtr mtlStream)
	Static functions.
static DtSetDataRequest *	createSetDataRequest (DtSetMessageType requestType)
static void	addSetDataRequestCreatorFcn (const DtSetMessageType &setDataName, DtSetDataRequestCreatorFcn fcn)
static void	setFactory (DtSetDataRequestFactory *factory)
static DtSetDataRequestFactory *	factory ()
static bool	isTypeRegistered (DtSetMessageType setDataType)
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 ()

Protected Attributes
DtRwInt	mySpotReportingOn
DtRwBoolean	myUseGlobalReceivers
DtRwNLengthStringVector	mySpotReportingReceivers
Protected Attributes inherited from DtSetDataRequest
char *	myNetRep
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 )()
Protected Member Functions inherited from DtSetDataRequest
	DtSetDataRequest ()
	Constructors are protected because no one should instantiate the base class, just derived versions.
	DtSetDataRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a request 'put' itself, the write name will preface it.
	DtSetDataRequest (const DtString &writeName, const DtSetDataRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSetDataRequest &	operator= (const DtSetDataRequest &orig)
	assignment operator; same as copy costructor.
virtual char *	createNetworkBuffer ()
	int setDataType);
Static Protected Attributes inherited from DtSetDataRequest
static DtSetDataRequestFactory *	myFactory

Constructor & Destructor Documentation

DtSetSpotReportingRequest::DtSetSpotReportingRequest

(

)

default constructor

DtSetSpotReportingRequest::DtSetSpotReportingRequest	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor If you have a request 'put' itself, the writeName will preface it.

DtSetSpotReportingRequest::DtSetSpotReportingRequest	(	const DtString &	writeName,
		const DtSetSpotReportingRequest &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtSetSpotReportingRequest::~DtSetSpotReportingRequest ( )

virtual

Member Function Documentation

const DtSetSpotReportingRequest& DtSetSpotReportingRequest::operator=

(

const DtSetSpotReportingRequest &

orig

)

assignment operator

virtual const DtSetMessageType& DtSetSpotReportingRequest::type ( ) const

virtual

Returns DtSetSpotReportingRequestType.

Implements DtSetDataRequest.

virtual DtSetDataRequest* DtSetSpotReportingRequest::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = 0  ) const

virtual

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSetSpotReportingRequest::stringRep ( ) const

virtual

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual int DtSetSpotReportingRequest::spotReporting ( ) const

virtual

If globalEnabledOverridingLocal is not true, this represents the local setting for enabling spot reports.

If globalEnabledOverridingLocal is true, this setting is ignored.

virtual void DtSetSpotReportingRequest::setSpotReporting ( int  spot )

virtual

If globalEnabledOverridingLocal is not true, this represents the local setting for enabling spot reports.

If globalEnabledOverridingLocal is true, this setting is ignored.

virtual const std::vector<DtString>& DtSetSpotReportingRequest::spotReportingReceivers ( ) const

virtual

virtual void DtSetSpotReportingRequest::setSpotReportingReceivers ( const std::vector< DtString > &  receivers )

virtual

virtual bool DtSetSpotReportingRequest::useGlobalReceivers ( ) const

virtual

virtual void DtSetSpotReportingRequest::setUseGlobalReceivers ( bool  useGlobal )

virtual

virtual int DtSetSpotReportingRequest::netRepSize ( ) const

virtual

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtSetDataRequest.

virtual bool DtSetSpotReportingRequest::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetSpotReportingRequest::setToNet ( )

virtual

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtSetDataRequest.

static DtSetDataRequest* DtSetSpotReportingRequest::creator ( )

static

Member Data Documentation

DtRwInt DtSetSpotReportingRequest::mySpotReportingOn

protected

DtRwBoolean DtSetSpotReportingRequest::myUseGlobalReceivers

protected

DtRwNLengthStringVector DtSetSpotReportingRequest::mySpotReportingReceivers

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrftasks/setSpotReportingRequest.h