makVre::DtAttributeProviderComponentDescriptor Class Reference

Detailed Description

This class defines a descriptor for the attribute provider component, which allows entities to provide custom key-value attributes to the simulation system. These attributes can be used for various purposes, including entity classification, capability definition, and property retrieval.

#include <attributeProviderComponentDescriptor.h>

Inheritance diagram for makVre::DtAttributeProviderComponentDescriptor:

Public Member Functions
	DtAttributeProviderComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0)
	DtAttributeProviderComponentDescriptor (const DtAttributeProviderComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtAttributeProviderComponentDescriptor &	operator= (const DtAttributeProviderComponentDescriptor &orig)
virtual	~DtAttributeProviderComponentDescriptor () override
virtual DtString	type () const override
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const override
virtual DtRwKeyValueMap	attributes () const

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Protected Member Functions
	DtAttributeProviderComponentDescriptor ()

Protected Attributes
Configuration Parameters
These parameters are available for setting in the OPD files. The values are copied to the PSR so that other components can access them during simulation.
DtRwKeyValueMap	myAttributes

Constructor & Destructor Documentation

DtAttributeProviderComponentDescriptor() [1/3]

makVre::DtAttributeProviderComponentDescriptor::DtAttributeProviderComponentDescriptor	(	const DtString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = 0 )

Constructor with component name.

Parameters

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

Creates a new attribute provider component descriptor with the specified name.

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

DtAttributeProviderComponentDescriptor() [2/3]

makVre::DtAttributeProviderComponentDescriptor::DtAttributeProviderComponentDescriptor	(	const DtAttributeProviderComponentDescriptor &	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 attribute provider component descriptor as a copy of the provided original.

References DtAttributeProviderComponentDescriptor().

~DtAttributeProviderComponentDescriptor()

virtual makVre::DtAttributeProviderComponentDescriptor::~DtAttributeProviderComponentDescriptor ( )

overridevirtual

Virtual destructor.

Cleans up resources used by the descriptor.

DtAttributeProviderComponentDescriptor() [3/3]

makVre::DtAttributeProviderComponentDescriptor::DtAttributeProviderComponentDescriptor ( )

protected

Default constructor (not implemented)

Default constructor is protected and not implemented to prevent creation of instances without proper initialization.

Member Function Documentation

operator=()

DtAttributeProviderComponentDescriptor & makVre::DtAttributeProviderComponentDescriptor::operator=

(

const DtAttributeProviderComponentDescriptor &

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 DtAttributeProviderComponentDescriptor().

type()

virtual DtString makVre::DtAttributeProviderComponentDescriptor::type ( ) const

overridevirtual

Gets the type identifier for this descriptor.

Returns

String identifying this descriptor type

Returns a unique type identifier string for this descriptor type. Will return makVre::DtAttributeProviderComponentDescriptorType.

clone()

virtual DtComponentDescriptor * makVre::DtAttributeProviderComponentDescriptor::clone ( DtReaderWriterRegistry * parentRegistry = 0 ) const

overridevirtual

Creates a clone of this descriptor.

Parameters

parentRegistry

Parent registry for reader/writer functionality (optional)

Returns

Pointer to a new descriptor that is a clone of this one

Creates a new attribute provider component descriptor as a deep copy of this one.

attributes()

virtual DtRwKeyValueMap makVre::DtAttributeProviderComponentDescriptor::attributes ( ) const

virtual

Gets the attributes map.

Returns

Reference to the key-value map of attributes

Returns the map of custom attributes defined for this component.

creator()

static DtComponentDescriptor * makVre::DtAttributeProviderComponentDescriptor::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

myAttributes

DtRwKeyValueMap makVre::DtAttributeProviderComponentDescriptor::myAttributes

protected

Map of custom attributes.

Stores the key-value pairs of custom attributes to be provided by this component. These attributes can be queried at runtime and used for various purposes in the simulation system.

---

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

• include/vrfExtensions/vreVrfobjparam/attributeProviderComponentDescriptor.h