makVre::DtVreAmmunitionParams Class Reference

Detailed Description

This class manages a collection of ammunition parameter entries that configure the DtVreAmmunitionManager. It extends the base ammunition parameters class to support VREngage-specific ammunition properties and behaviors.

#include <vreAmmunitionParams.h>

Inheritance diagram for makVre::DtVreAmmunitionParams:

Public Member Functions
	DtVreAmmunitionParams (const DtString &rwName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtVreAmmunitionParams (const DtSymbolString &rwName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtVreAmmunitionParams (const DtVreAmmunitionParams &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtVreAmmunitionParams &	operator= (const DtVreAmmunitionParams &orig)
virtual	~DtVreAmmunitionParams () override
virtual void	emptyList (bool clearMemory) override
virtual void	copyList (const DtAmmunitionParams &source) override
virtual DtAmmunitionParamsEntry *	createAmmunitionTableEntry () const override

Protected Member Functions
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override

Constructor & Destructor Documentation

DtVreAmmunitionParams() [1/3]

makVre::DtVreAmmunitionParams::DtVreAmmunitionParams	(	const DtString &	rwName,
		DtReaderWriterRegistry *	parentRegistry = NULL )

Constructor with reader/writer name.

Parameters

rwName	The name of this parameters object
parentRegistry	Parent registry for reader/writer functionality (optional)

Creates a new ammunition parameters object with the specified name.

Referenced by DtVreAmmunitionParams(), and operator=().

DtVreAmmunitionParams() [2/3]

makVre::DtVreAmmunitionParams::DtVreAmmunitionParams	(	const DtSymbolString &	rwName,
		DtReaderWriterRegistry *	parentRegistry = NULL )

Constructor with reader/writer name as symbol string.

Parameters

rwName	The name of this parameters object as a symbol string
parentRegistry	Parent registry for reader/writer functionality (optional)

Creates a new ammunition parameters object with the specified name.

DtVreAmmunitionParams() [3/3]

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

Copy constructor.

Parameters

orig	The source parameters object to copy from
parentRegistry	Parent registry for reader/writer functionality (optional)

Creates a new ammunition parameters object as a copy of the provided original.

References DtVreAmmunitionParams().

~DtVreAmmunitionParams()

virtual makVre::DtVreAmmunitionParams::~DtVreAmmunitionParams ( )

overridevirtual

Virtual destructor.

Cleans up resources used by the parameters object.

Member Function Documentation

operator=()

DtVreAmmunitionParams & makVre::DtVreAmmunitionParams::operator=

(

const DtVreAmmunitionParams &

orig

)

Assignment operator.

Parameters

orig	The source parameters object to copy from

Returns

Reference to this parameters object after assignment

Assigns the contents of the provided parameters object to this one.

References DtVreAmmunitionParams().

emptyList()

virtual void makVre::DtVreAmmunitionParams::emptyList ( bool clearMemory )

overridevirtual

Empties the ammunition parameter entries list.

Parameters

clearMemory

Whether to also clear allocated memory

Removes all ammunition parameter entries from the list, optionally freeing the associated memory.

copyList()

virtual void makVre::DtVreAmmunitionParams::copyList ( const DtAmmunitionParams & source )

overridevirtual

Copies ammunition parameter entries from another list.

Parameters

source

The source ammunition parameters to copy from

Copies all ammunition parameter entries from the provided source parameters.

createAmmunitionTableEntry()

virtual DtAmmunitionParamsEntry * makVre::DtVreAmmunitionParams::createAmmunitionTableEntry ( ) const

overridevirtual

Creates a new ammunition parameter entry.

Returns

Pointer to a newly created ammunition parameter entry

Factory method that creates a new VREngage-specific ammunition parameter entry. This method enables creating the appropriate derived entry type for VREngage.

getData()

virtual DtlObjPtr makVre::DtVreAmmunitionParams::getData ( DtlObjPtr args, const DtReaderWriter::SearchPaths & searchPaths, const DtVariableBindingsList & variableBindings )

overrideprotectedvirtual

Processes input data to create ammunition parameter entries.

Parameters

args	Input arguments to process
searchPaths	Search paths for resolving file references
variableBindings	Variable bindings for resolving script variables

Returns

Object pointer containing the processed data

Constructs a DtVreAmmunitionParamsEntry object, reads data from the MTL stream, and adds it to the parameters list.

---

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

• include/vrfExtensions/vreVrfobjparam/vreAmmunitionParams.h