This class is a collection of different kinds of scenario data that is saved in the .xtr file in the scenario file set.

Inheritance diagram for DtRwScenarioExtras:

Public Member Functions
	DtRwScenarioExtras (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)

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

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

const DtRwScenarioExtras &	operator= (const DtRwScenarioExtras &orig)

virtual	~DtRwScenarioExtras ()

virtual const char *	readerWriterType () const

virtual void	clear ()


virtual void	setForceHostilityList (const DtRwForceDescriptionList &l)

virtual const DtRwForceDescriptionList &	forceHostilityList () const


virtual void	setSpawnTemplates (const DtRwSpawnDataList &t)

virtual const DtRwSpawnDataList &	spawnTemplates () const


virtual void	setDoctrineAssignments (const std::map< int, std::string > &t)

virtual void	setDoctrineAssignments (const DtRwStringAttributeList &t)

virtual std::map< int, std::string >	doctrineAssignments () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

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

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

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	wasUpdatedSince (DtTime t) const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

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

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

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

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Member Functions
	DtRwScenarioExtras ()

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes

DtRwForceDescriptionList	myForceHostilityList

DtRwSpawnDataList	mySpawnTemplates

DtRwStringAttributeList	myDoctrineAssignments

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

bool	myInvalid

bool	myChangedFlag

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

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

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)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

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

Constructor & Destructor Documentation

DtRwScenarioExtras::DtRwScenarioExtras ( )

protected

Constructors etc.

Default constructor; not implemented.

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

constructor

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

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

copy constructor

virtual DtRwScenarioExtras::~DtRwScenarioExtras ( )

virtual

Destructor.

Member Function Documentation

const DtRwScenarioExtras& DtRwScenarioExtras::operator= ( const DtRwScenarioExtras & orig )

assignment operator

virtual const char* DtRwScenarioExtras::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.

virtual void DtRwScenarioExtras::clear ( )

virtual

Accessors and mutators for the scenario data.

Clears (deletes) current data; used e.g. by scenario extras mgr to init

virtual void DtRwScenarioExtras::setForceHostilityList ( const DtRwForceDescriptionList & l )

virtual

Force-hostility data (managed by the hostility manager).

virtual const DtRwForceDescriptionList& DtRwScenarioExtras::forceHostilityList ( ) const

virtual

Force-hostility data (managed by the hostility manager).

virtual void DtRwScenarioExtras::setSpawnTemplates ( const DtRwSpawnDataList & t )

virtual

Spawn templates (managed by the spawn-sink manager).

virtual const DtRwSpawnDataList& DtRwScenarioExtras::spawnTemplates ( ) const

virtual

Spawn templates (managed by the spawn-sink manager).

virtual void DtRwScenarioExtras::setDoctrineAssignments ( const std::map< int, std::string > & t )

virtual

Doctrine assignments (managed by the scripted task manager).

virtual void DtRwScenarioExtras::setDoctrineAssignments ( const DtRwStringAttributeList & t )

virtual

Doctrine assignments (managed by the scripted task manager).

virtual std::map<int, std::string> DtRwScenarioExtras::doctrineAssignments ( ) const

virtual

Doctrine assignments (managed by the scripted task manager).

Member Data Documentation

DtRwForceDescriptionList DtRwScenarioExtras::myForceHostilityList

protected

These members are saved and loaded in the .xtr scenario file.

DtRwSpawnDataList DtRwScenarioExtras::mySpawnTemplates

protected

These members are saved and loaded in the .xtr scenario file.

DtRwStringAttributeList DtRwScenarioExtras::myDoctrineAssignments

protected

These members are saved and loaded in the .xtr scenario file.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfmsgs/rwScenarioExtras.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation