attributeProviderComponentDescriptor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file attributeProviderComponentDescriptor.h
//! \ingroup vreVrfobjparam
//! \brief Attribute provider component descriptor for VREngage
//!
//! This file defines the DtAttributeProviderComponentDescriptor class, which configures
//! the attribute provider component in VREngage. This component allows entities to
//! provide custom key-value attributes to the simulation system, enabling dynamic
//! property assignment and retrieval.
 
#pragma once
 
 
#include <vrfobjparam/componentDescriptor.h>
#include <vrfutil/rwTemplatedMap.h>
 
#include <vreVrfobjparam/export.h>
 
class DtReaderWriterRegistry;
 
 
namespace makVre
{
//! \brief Type identifier string for the attribute provider component descriptor
const char DtAttributeProviderComponentDescriptorType[] = "attribute-provider-component-descriptor";
 
//! \brief Key-value map type for storing attribute pairs
//!
//! This typedef defines a map of string keys to string values, used for
//! storing and retrieving custom attributes in the simulation system.
using DtRwKeyValueMap = DtRwTemplatedMapPtr<DtRwString, DtRwString>;
 
//! \brief Attribute provider component descriptor for VREngage
//!
//! 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.
class VREVRFOBJPARAM_DLL DtAttributeProviderComponentDescriptor : public DtComponentDescriptor
{
public:
   //! \brief Constructor with component name
   //! \param componentName The name of this component
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new attribute provider component descriptor with the specified name.
   DtAttributeProviderComponentDescriptor(const DtString& componentName, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Copy constructor
   //! \param orig The source descriptor to copy from
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new attribute provider component descriptor as a copy of the provided original.
   DtAttributeProviderComponentDescriptor(
      const DtAttributeProviderComponentDescriptor& orig, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Assignment operator
   //! \param orig The source descriptor to copy from
   //! \return Reference to this descriptor after assignment
   //!
   //! Assigns the contents of the provided descriptor to this one.
   DtAttributeProviderComponentDescriptor& operator=(const DtAttributeProviderComponentDescriptor& orig);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the descriptor.
   virtual ~DtAttributeProviderComponentDescriptor() override;
 
   //! \brief Gets the type identifier for this descriptor
   //! \return String identifying this descriptor type
   //!
   //! Returns a unique type identifier string for this descriptor type.
   //! Will return makVre::DtAttributeProviderComponentDescriptorType.
   virtual DtString type() const override;
 
   //! \brief Creates a clone of this descriptor
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //! \return 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.
   virtual DtComponentDescriptor* clone(DtReaderWriterRegistry* parentRegistry = 0) const override;
 
   //! \brief Gets the attributes map
   //! \return Reference to the key-value map of attributes
   //!
   //! Returns the map of custom attributes defined for this component.
   virtual DtRwKeyValueMap attributes() const;
 
   //! \brief Factory function to create a new instance of this descriptor
   //! \return Pointer to a newly created descriptor
   //!
   //! Static factory function used by the descriptor creation system to instantiate
   //! new instances of this descriptor type.
   static DtComponentDescriptor* creator();
 
protected:
   //! \brief Default constructor (not implemented)
   //!
   //! Default constructor is protected and not implemented to prevent
   //! creation of instances without proper initialization.
   DtAttributeProviderComponentDescriptor();
 
protected:
   //! \name 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.
   //! @{
 
   //! \brief 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.
   DtRwKeyValueMap myAttributes;
 
   //! @}
};
} // namespace makVre