makVre::DtVreScriptReactiveTaskControllerDescriptor Class Reference

Detailed Description

This class defines a descriptor for script reactive task controller components in VREngage. It maintains a mapping between roles and allowed reactive task script lists, controlling which scripts can be executed based on entity roles. This allows for role-specific behavior scripts to be assigned to entities during engagement scenarios.

#include <vreScriptReactiveTaskControllerDescriptor.h>

Inheritance diagram for makVre::DtVreScriptReactiveTaskControllerDescriptor:

Public Member Functions
	DtVreScriptReactiveTaskControllerDescriptor ()=delete
	DtVreScriptReactiveTaskControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtVreScriptReactiveTaskControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtVreScriptReactiveTaskControllerDescriptor (const DtVreScriptReactiveTaskControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtVreScriptReactiveTaskControllerDescriptor &	operator= (const DtVreScriptReactiveTaskControllerDescriptor &orig)
virtual	~DtVreScriptReactiveTaskControllerDescriptor () override
virtual void	setRoleToScriptListMap (const DtRoleToScriptListMap &map)
virtual const DtRoleToScriptListMap &	roleToScriptListMap () const
virtual const char *	readerWriterType () const override
virtual const char *	xmlType () const override

Static Public Member Functions
static const char *	theXmlType ()
static DtComponentDescriptor *	creator ()

Protected Attributes
DtRwRoleToScriptListMap	myAllowedReactiveTasksWhileEngaged

Constructor & Destructor Documentation

DtVreScriptReactiveTaskControllerDescriptor() [1/4]

makVre::DtVreScriptReactiveTaskControllerDescriptor::DtVreScriptReactiveTaskControllerDescriptor ( )

delete

Default constructor (deleted)

Default constructor is explicitly deleted to prevent creation of instances without proper initialization.

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

DtVreScriptReactiveTaskControllerDescriptor() [2/4]

makVre::DtVreScriptReactiveTaskControllerDescriptor::DtVreScriptReactiveTaskControllerDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0 )

Constructor with component name.

Parameters

name	The name of this component
parentRegistry	Parent registry for reader/writer functionality (optional)

Creates a new script reactive task controller descriptor with the specified name.

DtVreScriptReactiveTaskControllerDescriptor() [3/4]

makVre::DtVreScriptReactiveTaskControllerDescriptor::DtVreScriptReactiveTaskControllerDescriptor	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0 )

Constructor with component name as symbol string.

Parameters

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

Creates a new script reactive task controller descriptor with the specified name.

DtVreScriptReactiveTaskControllerDescriptor() [4/4]

makVre::DtVreScriptReactiveTaskControllerDescriptor::DtVreScriptReactiveTaskControllerDescriptor	(	const DtVreScriptReactiveTaskControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0 )

Copy constructor.

Parameters

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

Creates a new script reactive task controller descriptor as a copy of the provided original.

References DtVreScriptReactiveTaskControllerDescriptor().

~DtVreScriptReactiveTaskControllerDescriptor()

virtual makVre::DtVreScriptReactiveTaskControllerDescriptor::~DtVreScriptReactiveTaskControllerDescriptor ( )

overridevirtual

Virtual destructor.

Cleans up resources used by the descriptor.

Member Function Documentation

operator=()

DtVreScriptReactiveTaskControllerDescriptor & makVre::DtVreScriptReactiveTaskControllerDescriptor::operator=

(

const DtVreScriptReactiveTaskControllerDescriptor &

orig

)

Assignment operator.

Parameters

orig	The source descriptor to copy from

Returns

Reference to this descriptor after assignment

Assigns the contents of the provided descriptor to this one.

References DtVreScriptReactiveTaskControllerDescriptor().

setRoleToScriptListMap()

virtual void makVre::DtVreScriptReactiveTaskControllerDescriptor::setRoleToScriptListMap ( const DtRoleToScriptListMap & map )

virtual

Sets the role to script list mapping.

Parameters

map	The mapping of roles to allowed script lists

Sets the mapping between roles and lists of scripts that are allowed to be executed by entities with those roles while they are engaged in tasks.

roleToScriptListMap()

virtual const DtRoleToScriptListMap & makVre::DtVreScriptReactiveTaskControllerDescriptor::roleToScriptListMap ( ) const

virtual

Gets the role to script list mapping.

Returns

Reference to the mapping of roles to allowed script lists

Returns the mapping between roles and lists of scripts that are allowed to be executed by entities with those roles while they are engaged in tasks.

readerWriterType()

virtual const char * makVre::DtVreScriptReactiveTaskControllerDescriptor::readerWriterType ( ) const

overridevirtual

Gets the reader/writer type identifier.

Returns

String identifying the reader/writer type

Returns the type string used for reader/writer registration and lookup. Overrides the base class implementation.

theXmlType()

static const char * makVre::DtVreScriptReactiveTaskControllerDescriptor::theXmlType ( )

static

Gets the XML type string used when archiving to an XML stream.

Returns

String identifying the XML type

Returns the type string used when archiving this descriptor to an XML stream.

Referenced by xmlType().

xmlType()

virtual const char * makVre::DtVreScriptReactiveTaskControllerDescriptor::xmlType ( ) const

inlineoverridevirtual

Gets the XML type for this instance.

Returns

String identifying the XML type

Returns the type string used when archiving this descriptor to an XML stream. Overrides the base class implementation.

References theXmlType().

creator()

static DtComponentDescriptor * makVre::DtVreScriptReactiveTaskControllerDescriptor::creator ( )

static

Factory function to create a new instance of this descriptor.

Returns

Pointer to a newly created descriptor

Static factory function used by the descriptor creation system to instantiate new instances of this descriptor type.

Member Data Documentation

myAllowedReactiveTasksWhileEngaged

DtRwRoleToScriptListMap makVre::DtVreScriptReactiveTaskControllerDescriptor::myAllowedReactiveTasksWhileEngaged

protected

Mapping of roles to allowed reactive task scripts.

Stores the mapping between roles and lists of scripts that are allowed to be executed by entities with those roles while they are engaged in tasks. This controls which reactive behavior scripts can run based on entity role assignments.

---

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

• include/vrfExtensions/vreVrfobjparam/vreScriptReactiveTaskControllerDescriptor.h