Dev Essential  1.6.3
Loading...
Searching...
No Matches
ddl::dd::datamodel::InfoMap Class Reference

Info Map for the datamodel to hold a set of optional IInfo instances. Only one instance of one Info type is possible. More...

#include <infomodel_base.h>

Inherited by ddl::dd::datamodel::BaseUnit, ddl::dd::datamodel::DataDefinition, ddl::dd::datamodel::DataType, ddl::dd::datamodel::EnumType, ddl::dd::datamodel::Header, ddl::dd::datamodel::KeyValuePair, ddl::dd::datamodel::Stream, ddl::dd::datamodel::Stream::Struct, ddl::dd::datamodel::StreamMetaType, ddl::dd::datamodel::StructType, ddl::dd::datamodel::StructType::Element, ddl::dd::datamodel::Unit, ddl::dd::datamodel::UnitPrefix, ddl::mapping::datamodel::Assignment, ddl::mapping::datamodel::Function, ddl::mapping::datamodel::Header, ddl::mapping::datamodel::MappingConfiguration, ddl::mapping::datamodel::ParameterValue, ddl::mapping::datamodel::Property, ddl::mapping::datamodel::Source, ddl::mapping::datamodel::Target, and ddl::mapping::datamodel::Trigger.

Public Member Functions

 InfoMap ()=default
 CTOR.
 
 InfoMap (const InfoMap &)
 copy CTOR
 
 InfoMap (InfoMap &&)
 move CTOR
 
InfoMapoperator= (const InfoMap &)
 copy assignment operator
 
InfoMapoperator= (InfoMap &&)
 move assignment operator
 
template<typename INFO_T>
const INFO_T * getInfo () const
 Get the Info Pointer.
 
template<typename INFO_T>
INFO_T * getInfo ()
 Get the Info Pointer.
 
template<typename INFO_T>
void setInfo (const std::shared_ptr< INFO_T > &info)
 Set the Info object as shared pointer.
 

Detailed Description

Info Map for the datamodel to hold a set of optional IInfo instances. Only one instance of one Info type is possible.

Constructor & Destructor Documentation

◆ InfoMap() [1/2]

ddl::dd::datamodel::InfoMap::InfoMap ( const InfoMap & )
inline

copy CTOR

Remarks
InfoMaps will be never copied!

◆ InfoMap() [2/2]

ddl::dd::datamodel::InfoMap::InfoMap ( InfoMap && )
inline

move CTOR

Remarks
InfoMaps will be never moved!

Member Function Documentation

◆ getInfo() [1/2]

template<typename INFO_T>
INFO_T * ddl::dd::datamodel::InfoMap::getInfo ( )
inline

Get the Info Pointer.

Template Parameters
INFO_TThe Info type class type to retrieve.
Returns
INFO_T*

◆ getInfo() [2/2]

template<typename INFO_T>
const INFO_T * ddl::dd::datamodel::InfoMap::getInfo ( ) const
inline

Get the Info Pointer.

Template Parameters
INFO_TThe Info type class type to retrieve.
Returns
const INFO_T*

◆ operator=() [1/2]

InfoMap & ddl::dd::datamodel::InfoMap::operator= ( const InfoMap & )
inline

copy assignment operator

Remarks
InfoMaps will be never copied!
Returns
InfoMap&

◆ operator=() [2/2]

InfoMap & ddl::dd::datamodel::InfoMap::operator= ( InfoMap && )
inline

move assignment operator

Remarks
InfoMaps will be never moved!
Returns
InfoMap&

◆ setInfo()

template<typename INFO_T>
void ddl::dd::datamodel::InfoMap::setInfo ( const std::shared_ptr< INFO_T > & info)
inline

Set the Info object as shared pointer.

Template Parameters
INFO_TThe Info type class type to set.
Parameters
infothe info pointer to set.
Exceptions
ddl::dd::Errorif samething went wrong while setting the info.

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