DtVreTaskSetBuilder Class Reference

Detailed Description

This class extends the base task set builder to provide VREngage-specific functionality for dynamically creating simulation tasks and data requests. It builds tasks and sets based on parameters provided in a map of DtReaderWriters, allowing for flexible task creation in Lua scripts and other contexts.

#include <vreTaskSetBuilder.h>

Inheritance diagram for DtVreTaskSetBuilder:

Public Types
using	ParamMap = std::map<DtString, DtReaderWriter*>

Public Member Functions
	DtVreTaskSetBuilder (const DtScriptedTaskManager *scriptedTaskManager)
virtual DtSimTask *	buildTask (const DtSimTaskMessageType &taskType, const ParamMap &paremeters)
virtual DtSetDataRequest *	buildSet (const DtSetMessageType &setType, const ParamMap &paremeters)

Protected Member Functions
virtual bool	fillInParameter (DtReaderWriter *rw, const ParamMap &parameters, DtString &usedParam)

Private Member Functions
	DtVreTaskSetBuilder ()
	DtVreTaskSetBuilder (const DtVreTaskSetBuilder &orig)
DtVreTaskSetBuilder &	operator= (const DtVreTaskSetBuilder &orig)

Member Typedef Documentation

ParamMap

using DtVreTaskSetBuilder::ParamMap = std::map<DtString, DtReaderWriter*>

Type definition for parameter map.

Maps parameter names to their corresponding DtReaderWriter values. This is used to pass parameters to task and set creation methods.

Constructor & Destructor Documentation

DtVreTaskSetBuilder() [1/3]

DtVreTaskSetBuilder::DtVreTaskSetBuilder ( )

private

Default constructor (not implemented)

Default constructor is private and not implemented to prevent creation of instances without a scripted task manager.

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

DtVreTaskSetBuilder() [2/3]

DtVreTaskSetBuilder::DtVreTaskSetBuilder ( const DtVreTaskSetBuilder & orig )

private

Copy constructor (not implemented)

Parameters

orig	The source builder to copy from

Copy constructor is private and not implemented to prevent copying.

References DtVreTaskSetBuilder().

DtVreTaskSetBuilder() [3/3]

DtVreTaskSetBuilder::DtVreTaskSetBuilder

(

const DtScriptedTaskManager *

scriptedTaskManager

)

Constructor with scripted task manager.

Parameters

scriptedTaskManager

Pointer to the scripted task manager

Creates a new task set builder associated with the specified scripted task manager. The scripted task manager provides access to task and set creation facilities.

Member Function Documentation

operator=()

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

private

Assignment operator (not implemented)

Parameters

orig	The source builder to copy from

Returns

Reference to this builder after assignment

Assignment operator is private and not implemented to prevent assignment.

References DtVreTaskSetBuilder().

buildTask()

virtual DtSimTask * DtVreTaskSetBuilder::buildTask ( const DtSimTaskMessageType & taskType, const ParamMap & paremeters )

virtual

Builds a simulation task.

Parameters

taskType	The type of task to build
paremeters	Map of parameter names to their values

Returns

Pointer to the newly created task, or nullptr if creation failed

Creates a new simulation task of the specified type, using the parameters provided in the parameter map. The returned task is owned by the caller and must be deleted when no longer needed.

buildSet()

virtual DtSetDataRequest * DtVreTaskSetBuilder::buildSet ( const DtSetMessageType & setType, const ParamMap & paremeters )

virtual

Builds a set data request.

Parameters

setType	The type of set to build
paremeters	Map of parameter names to their values

Returns

Pointer to the newly created set data request, or nullptr if creation failed

Creates a new set data request of the specified type, using the parameters provided in the parameter map. The returned request is owned by the caller and must be deleted when no longer needed.

fillInParameter()

virtual bool DtVreTaskSetBuilder::fillInParameter ( DtReaderWriter * rw, const ParamMap & parameters, DtString & usedParam )

protectedvirtual

Fills a reader/writer parameter from the parameter map.

Parameters

rw	Pointer to the reader/writer to fill
parameters	Map of available parameters
usedParam	Output parameter that will receive the name of the parameter used

Returns

True if the parameter was successfully filled, false otherwise

Attempts to fill the specified reader/writer from the parameter map. If successful, usedParam will be set to the name of the parameter that was used to fill the reader/writer. This method is used internally by buildTask and buildSet to populate task and set parameters from the provided parameter map.

---

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

• include/vrfExtensions/vreVrfobjcore/vreTaskSetBuilder.h