VR-Forces 4.3 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Classes | Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes
DtTaskSetBuilder Class Reference

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 DtString &taskType, luabind::object const &parameters)
virtual DtSetDataRequest * buildSet (const DtString &setType, luabind::object const &parameters)
virtual void generateTaskSetLuaDoc (const DtFilename &outputFile)
 Write out a text file with the names of tasks and their parameters that can be an input to the lua documentation.

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.
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)
virtual DtString availableParamsString (DtReaderWriter *taskOrSet, bool longForm=false)
virtual DtSetDataRequest * buildSetReactiveTaskEnabled (luabind::object const &parameters)
 Special processing function for the DtSetReactiveTaskEnabled set data request.
DtString convertToLuaSymbol (const DtString &inputString)
 Converts a string to a lua symbol compatible string, changing '-' to '_' and other operations.
virtual DtString generateRwLuaDoc (DtReaderWriter &rw)
 Generates a string documenting all the parameters in the rw.
virtual bool cleanTaskName (DtString &taskName)
 Modifies taskName in such a way to make it more presentable to the user.

Static Protected Member Functions

static bool findPropertyParam (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 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 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 findStringListParam (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.
std::set< DtSimTaskMessageType > myIgnoredTasks
std::set< DtSetMessageType > myIgnoredSets
std::map< DtString, DtString > mySpecializedDoc

Private Member Functions

 DtTaskSetBuilder ()
 Not implemented.
 DtTaskSetBuilder (const DtTaskSetBuilder &orig)
 Not implemented.
DtTaskSetBuilder & operator= (const DtTaskSetBuilder &orig)
 Not implemented.

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

Not implemented.

DtTaskSetBuilder::DtTaskSetBuilder ( const DtScriptedTaskManager *  scriptedTaskManager)

Member Function Documentation

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

Not implemented.

virtual DtSimTask* DtTaskSetBuilder::buildTask ( const DtString &  taskType,
luabind::object const &  parameters 
)
virtual
virtual DtSetDataRequest* DtTaskSetBuilder::buildSet ( const DtString &  setType,
luabind::object const &  parameters 
)
virtual
virtual void DtTaskSetBuilder::generateTaskSetLuaDoc ( const DtFilename &  outputFile)
virtual

Write out a text file with the names of tasks and their parameters that can be an input to the lua documentation.

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
usedParamThe name in the lua table that was used to fill in the parameter, if successful.
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
longFormIf 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::findStringParam ( 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::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::findStringListParam ( 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
DtString DtTaskSetBuilder::convertToLuaSymbol ( const DtString &  inputString)
protected

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

virtual DtString DtTaskSetBuilder::generateRwLuaDoc ( DtReaderWriter &  rw)
protectedvirtual

Generates a string documenting all the parameters in the rw.

virtual bool DtTaskSetBuilder::cleanTaskName ( DtString &  taskName)
protectedvirtual

Modifies taskName in such a way to make it more presentable to the user.

Returns
True if any modifications are made.

Member Data Documentation

const DtScriptedTaskManager* DtTaskSetBuilder::myScriptedTaskManager
protected
DtParamFcnMap DtTaskSetBuilder::myFindParamFcnMap
protected
std::set<DtString> DtTaskSetBuilder::myParamsIgnored
protected

List of parameters that are ignored.

std::set<DtSimTaskMessageType> DtTaskSetBuilder::myIgnoredTasks
protected
std::set<DtSetMessageType> DtTaskSetBuilder::myIgnoredSets
protected
std::map<DtString, DtString> DtTaskSetBuilder::mySpecializedDoc
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)