Class which builds tasks dynamically based on a set of parameters passed in from a Lua Script call. More...

Classes
struct	RwParamInfo
	Structure used in myFindParamFcnMap to store info on various RW types used as parameters in tasks and sets. More...

Public Member Functions
	DtTaskSetBuilder (const DtScriptedTaskManager *scriptedTaskManager)

virtual DtSimTask *	buildTask (const DtSimTaskMessageType &taskType, luabind::object const &parameters)

virtual DtSetDataRequest *	buildSet (const DtSetMessageType &setType, luabind::object const &parameters)

virtual DtSimCommand *	buildSimCommand (const DtSimCommandMessageType &setType, luabind::object const &parameters)

Protected Types
typedef bool(*	findParamFcn )(const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )
	Function signature for all findParam functions used to get a param of a particular type and fill it in to result. More...

typedef DtString(*	printRwFcn )(DtReaderWriter *rw)

typedef std::map< DtString, RwParamInfo >	DtParamFcnMap

Protected Member Functions
virtual DtReaderWriter *	scriptedTaskVariableToReaderWriter (const DtScriptedTaskVariable &variable, luabind::object const &parameters)

virtual bool	fillInParameter (DtReaderWriter *rw, luabind::object const &parameters, DtString &usedParam)

DtString	paramDetailsString (DtReaderWriter *rw, bool longForm)

virtual DtString	availableParamsString (DtReaderWriter *taskOrSet, bool longForm=false)

virtual DtSetDataRequest *	buildSetReactiveTaskEnabled (luabind::object const &parameters)
	Special processing function for the DtSetReactiveTaskEnabled set data request. More...

virtual bool	fillInReaderWriterType (const DtString &paramName, luabind::object const &parameters, DtReaderWriter *result, bool &error)

DtString	convertToLuaSymbol (const DtString &inputString)
	Converts a string to a lua symbol compatible string, changing '-' to '_' and other operations. More...

virtual bool	findValidTaskType (const DtSimTaskMessageType &taskType, DtSimTaskMessageType &taskTypeToUse) const
	Returns a correct task type trying a few iterations based on the initial task given. More...

virtual DtSetDataRequest *	findValidSetType (const DtSetMessageType &setType, DtSetMessageType &setTypeToUse) const
	Returns a correct set type trying a few iterations based on the initial set given. More...

Static Protected Member Functions
static bool	findPropertyParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findColorParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findStringParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findObjectNameStringParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findUUIDParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findAnimationModelParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findIntParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findDoubleParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findBoolParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findVectorParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findTaitBryanParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findPriorityTargetListParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findOffsetVectorParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findLifeformPostureParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findLifeformWeaponStateParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findAggregateStateParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findForceTypeParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findNLengthStringVectorParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findStringAttributeListParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findNLengthUUIDVectorParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findStringListParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findVectorListParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findOffsetVectorListParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findEntityTypeParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

static bool	findKeyValueListParam (const DtString &paramName, luabind::object const &parameters, DtReaderWriter result, const DtScriptedTaskManager )

Protected Attributes
const DtScriptedTaskManager *	myScriptedTaskManager

DtParamFcnMap	myFindParamFcnMap

std::set< DtString >	myParamsIgnored
	List of parameters that are ignored. More...

Private Member Functions

	DtTaskSetBuilder ()
	Not implemented. More...

	DtTaskSetBuilder (const DtTaskSetBuilder &orig)

DtTaskSetBuilder &	operator= (const DtTaskSetBuilder &orig)

Detailed Description

Class which builds tasks dynamically based on a set of parameters passed in from a Lua Script call.

Member Typedef Documentation

typedef bool(* DtTaskSetBuilder::findParamFcn)(const DtString &paramName, luabind::object const &parameters, DtReaderWriter *result, const DtScriptedTaskManager *)

protected

Function signature for all findParam functions used to get a param of a particular type and fill it in to result.

typedef DtString(* DtTaskSetBuilder::printRwFcn)(DtReaderWriter *rw)

protected

typedef std::map<DtString, RwParamInfo> DtTaskSetBuilder::DtParamFcnMap

protected

Constructor & Destructor Documentation

DtTaskSetBuilder::DtTaskSetBuilder ( )

private

Not implemented.

DtTaskSetBuilder::DtTaskSetBuilder ( const DtTaskSetBuilder & orig )

private

DtTaskSetBuilder::DtTaskSetBuilder ( const DtScriptedTaskManager * scriptedTaskManager )

Member Function Documentation

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

private

virtual DtSimTask* DtTaskSetBuilder::buildTask	(	const DtSimTaskMessageType &	taskType,
		luabind::object const &	parameters
	)

virtual

virtual DtSetDataRequest* DtTaskSetBuilder::buildSet	(	const DtSetMessageType &	setType,
		luabind::object const &	parameters
	)

virtual

virtual DtSimCommand* DtTaskSetBuilder::buildSimCommand	(	const DtSimCommandMessageType &	setType,
		luabind::object const &	parameters
	)

virtual

virtual DtReaderWriter* DtTaskSetBuilder::scriptedTaskVariableToReaderWriter	(	const DtScriptedTaskVariable &	variable,
		luabind::object const &	parameters
	)

protectedvirtual

Returns: ReaderWriter object based on the scripted task varaible and possible parameter supplied from lua.

virtual bool DtTaskSetBuilder::fillInParameter	(	DtReaderWriter *	rw,
		luabind::object const &	parameters,
		DtString &	usedParam
	)

protectedvirtual

Parameters

usedParam The name in the lua table that was used to fill in the parameter, if successful.

DtString DtTaskSetBuilder::paramDetailsString	(	DtReaderWriter *	rw,
		bool	longForm
	)

protected

Returns: A string containing the parameter name with type and default value information.

Parameters

longForm If true, a more verbose full line is returned for each parameter.

virtual DtString DtTaskSetBuilder::availableParamsString	(	DtReaderWriter *	taskOrSet,
		bool	longForm = `false`
	)

protectedvirtual

Returns: A string containing a list of all the available parameters for the specified task or set, that is suitable to return to the user.

Parameters

longForm If true, a more verbose multi-line string will be produced.

virtual DtSetDataRequest* DtTaskSetBuilder::buildSetReactiveTaskEnabled ( luabind::object const & parameters )

protectedvirtual

Special processing function for the DtSetReactiveTaskEnabled set data request.

static bool DtTaskSetBuilder::findPropertyParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findColorParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findStringParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findObjectNameStringParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findUUIDParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findAnimationModelParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findIntParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findDoubleParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findBoolParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findVectorParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findTaitBryanParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findPriorityTargetListParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findOffsetVectorParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findLifeformPostureParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findLifeformWeaponStateParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findAggregateStateParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findForceTypeParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findNLengthStringVectorParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findStringAttributeListParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findNLengthUUIDVectorParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findStringListParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findVectorListParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findOffsetVectorListParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findEntityTypeParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

static bool DtTaskSetBuilder::findKeyValueListParam	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		const DtScriptedTaskManager *
	)

staticprotected

virtual bool DtTaskSetBuilder::fillInReaderWriterType	(	const DtString &	paramName,
		luabind::object const &	parameters,
		DtReaderWriter *	result,
		bool &	error
	)

protectedvirtual

DtString DtTaskSetBuilder::convertToLuaSymbol ( const DtString & inputString )

protected

Converts a string to a lua symbol compatible string, changing '-' to '_' and other operations.

virtual bool DtTaskSetBuilder::findValidTaskType	(	const DtSimTaskMessageType &	taskType,
		DtSimTaskMessageType &	taskTypeToUse
	)		const

protectedvirtual

Returns a correct task type trying a few iterations based on the initial task given.

virtual DtSetDataRequest* DtTaskSetBuilder::findValidSetType	(	const DtSetMessageType &	setType,
		DtSetMessageType &	setTypeToUse
	)		const

protectedvirtual

Returns a correct set type trying a few iterations based on the initial set given.

Member Data Documentation

const DtScriptedTaskManager* DtTaskSetBuilder::myScriptedTaskManager

protected

DtParamFcnMap DtTaskSetBuilder::myFindParamFcnMap

protected

std::set<DtString> DtTaskSetBuilder::myParamsIgnored

protected

List of parameters that are ignored.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfLua/taskSetBuilder.h

Classes

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation