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

BaseUnit. More...

#include <datamodel_units.h>

Inherits ddl::dd::datamodel::UnitBase, ddl::dd::utility::ModelSubjectUtility< TYPE, ModelEventCode >, ddl::dd::utility::ModelSubjectUtility< T, TypeAccessMapEventCode >, and ddl::dd::datamodel::InfoMap.

Inherited by ddl::BaseUnit< T >.

Public Member Functions

 BaseUnit ()
 CTOR.
 
 BaseUnit (const BaseUnit &)=default
 copy CTOR
 
 BaseUnit (BaseUnit &&)=default
 move CTOR
 
BaseUnitoperator= (const BaseUnit &)=default
 copy assignment operator
 
BaseUnitoperator= (BaseUnit &&)=default
 move assignment operator
 
 BaseUnit (std::string name, std::string symbol, std::string description={})
 CTOR.
 
virtual ~BaseUnit ()=default
 DTOR.
 
TypeOfUnit getTypeOfUnit () const override
 Get the Type Of Unit.
 
void setName (const std::string &name) override
 Set the Name.
 
const std::string & getSymbol () const
 Get the Symbol.
 
void setSymbol (const std::string &symbol)
 Set the Symbol.
 
const std::string & getDescription () const
 Get the Description.
 
void setDescription (const std::string &description)
 Set the Description.
 
bool operator== (const BaseUnit &other) const
 equality operator.
 
bool operator!= (const BaseUnit &other) const
 non equality operator.
 
- Public Member Functions inherited from ddl::dd::datamodel::UnitBase
 UnitBase ()=default
 default CTOR
 
 UnitBase (const UnitBase &)=default
 copy CTOR
 
 UnitBase (UnitBase &&)=default
 move CTOR
 
UnitBaseoperator= (const UnitBase &)=default
 copy assignment operator
 
UnitBaseoperator= (UnitBase &&)=default
 move assignment operator
 
 UnitBase (std::string name)
 CTOR.
 
virtual ~UnitBase ()=default
 DTOR.
 
const std::string & getName () const
 Get the Name.
 
- Public Member Functions inherited from ddl::dd::utility::ModelSubjectUtility< TYPE, ModelEventCode >
 ModelSubjectUtility ()=default
 CTOR.
 
 ModelSubjectUtility (const ModelSubjectUtility &)
 copy CTOR which removes the observers in case of!
 
ModelSubjectUtilityoperator= (const ModelSubjectUtility &)
 copy assignment operator which removes the observers in case of!
 
virtual ~ModelSubjectUtility ()=default
 DTOR.
 
void attachObserver (observer_type *observer)
 adda a observer to notify.
 
void detachObserver (observer_type *observer)
 remove a observer if in list.
 
 ModelSubjectUtility ()=default
 CTOR.
 
 ModelSubjectUtility (const ModelSubjectUtility &)
 copy CTOR which removes the observers in case of!
 
ModelSubjectUtilityoperator= (const ModelSubjectUtility &)
 copy assignment operator which removes the observers in case of!
 
virtual ~ModelSubjectUtility ()=default
 DTOR.
 
void attachObserver (observer_type *observer)
 adda a observer to notify.
 
void detachObserver (observer_type *observer)
 remove a observer if in list.
 
 ModelSubjectUtility ()=default
 CTOR.
 
 ModelSubjectUtility (const ModelSubjectUtility &)
 copy CTOR which removes the observers in case of!
 
ModelSubjectUtilityoperator= (const ModelSubjectUtility &)
 copy assignment operator which removes the observers in case of!
 
virtual ~ModelSubjectUtility ()=default
 DTOR.
 
void attachObserver (observer_type *observer)
 adda a observer to notify.
 
void detachObserver (observer_type *observer)
 remove a observer if in list.
 
 ModelSubjectUtility ()=default
 CTOR.
 
 ModelSubjectUtility (const ModelSubjectUtility &)
 copy CTOR which removes the observers in case of!
 
ModelSubjectUtilityoperator= (const ModelSubjectUtility &)
 copy assignment operator which removes the observers in case of!
 
virtual ~ModelSubjectUtility ()=default
 DTOR.
 
void attachObserver (observer_type *observer)
 adda a observer to notify.
 
void detachObserver (observer_type *observer)
 remove a observer if in list.
 
- Public Member Functions inherited from ddl::dd::utility::ModelSubjectUtility< T, TypeAccessMapEventCode >
 ModelSubjectUtility ()=default
 CTOR.
 
 ModelSubjectUtility (const ModelSubjectUtility &)
 copy CTOR which removes the observers in case of!
 
ModelSubjectUtilityoperator= (const ModelSubjectUtility &)
 copy assignment operator which removes the observers in case of!
 
virtual ~ModelSubjectUtility ()=default
 DTOR.
 
void attachObserver (observer_type *observer)
 adda a observer to notify.
 
void detachObserver (observer_type *observer)
 remove a observer if in list.
 
 ModelSubjectUtility ()=default
 CTOR.
 
 ModelSubjectUtility (const ModelSubjectUtility &)
 copy CTOR which removes the observers in case of!
 
ModelSubjectUtilityoperator= (const ModelSubjectUtility &)
 copy assignment operator which removes the observers in case of!
 
virtual ~ModelSubjectUtility ()=default
 DTOR.
 
void attachObserver (observer_type *observer)
 adda a observer to notify.
 
void detachObserver (observer_type *observer)
 remove a observer if in list.
 
 ModelSubjectUtility ()=default
 CTOR.
 
 ModelSubjectUtility (const ModelSubjectUtility &)
 copy CTOR which removes the observers in case of!
 
ModelSubjectUtilityoperator= (const ModelSubjectUtility &)
 copy assignment operator which removes the observers in case of!
 
virtual ~ModelSubjectUtility ()=default
 DTOR.
 
void attachObserver (observer_type *observer)
 adda a observer to notify.
 
void detachObserver (observer_type *observer)
 remove a observer if in list.
 
 ModelSubjectUtility ()=default
 CTOR.
 
 ModelSubjectUtility (const ModelSubjectUtility &)
 copy CTOR which removes the observers in case of!
 
ModelSubjectUtilityoperator= (const ModelSubjectUtility &)
 copy assignment operator which removes the observers in case of!
 
virtual ~ModelSubjectUtility ()=default
 DTOR.
 
void attachObserver (observer_type *observer)
 adda a observer to notify.
 
void detachObserver (observer_type *observer)
 remove a observer if in list.
 
- Public Member Functions inherited from ddl::dd::datamodel::InfoMap
 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.
 

Additional Inherited Members

- Public Types inherited from ddl::dd::utility::ModelSubjectUtility< TYPE, ModelEventCode >
typedef ModelEventCode event_code_type
 local definition of the event code type
 
typedef TYPE subject_type
 local definition of the subject type
 
typedef ModelObserverUtility< TYPE, ModelEventCode > observer_type
 local definition of the observer type to notify
 
typedef ModelEventCode event_code_type
 local definition of the event code type
 
typedef TYPE subject_type
 local definition of the subject type
 
typedef ModelObserverUtility< TYPE, ModelEventCode > observer_type
 local definition of the observer type to notify
 
typedef ModelEventCode event_code_type
 local definition of the event code type
 
typedef TYPE subject_type
 local definition of the subject type
 
typedef ModelObserverUtility< TYPE, ModelEventCode > observer_type
 local definition of the observer type to notify
 
typedef ModelEventCode event_code_type
 local definition of the event code type
 
typedef TYPE subject_type
 local definition of the subject type
 
typedef ModelObserverUtility< TYPE, ModelEventCode > observer_type
 local definition of the observer type to notify
 
- Public Types inherited from ddl::dd::utility::ModelSubjectUtility< T, TypeAccessMapEventCode >
typedef TypeAccessMapEventCode event_code_type
 local definition of the event code type
 
typedef T subject_type
 local definition of the subject type
 
typedef ModelObserverUtility< T, TypeAccessMapEventCodeobserver_type
 local definition of the observer type to notify
 
typedef TypeAccessMapEventCode event_code_type
 local definition of the event code type
 
typedef T subject_type
 local definition of the subject type
 
typedef ModelObserverUtility< T, TypeAccessMapEventCodeobserver_type
 local definition of the observer type to notify
 
typedef TypeAccessMapEventCode event_code_type
 local definition of the event code type
 
typedef T subject_type
 local definition of the subject type
 
typedef ModelObserverUtility< T, TypeAccessMapEventCodeobserver_type
 local definition of the observer type to notify
 
typedef TypeAccessMapEventCode event_code_type
 local definition of the event code type
 
typedef T subject_type
 local definition of the subject type
 
typedef ModelObserverUtility< T, TypeAccessMapEventCodeobserver_type
 local definition of the observer type to notify
 
- Protected Member Functions inherited from ddl::dd::utility::ModelSubjectUtility< TYPE, ModelEventCode >
void notifyChanged (event_code_type event_code, subject_type &changed_subject, const std::string &additional_info)
 helper utility function to notify the current observers
 
void notifyChanged (event_code_type event_code, subject_type &changed_subject, const std::string &additional_info)
 helper utility function to notify the current observers
 
void notifyChanged (event_code_type event_code, subject_type &changed_subject, const std::string &additional_info)
 helper utility function to notify the current observers
 
void notifyChanged (event_code_type event_code, subject_type &changed_subject, const std::string &additional_info)
 helper utility function to notify the current observers
 
- Protected Member Functions inherited from ddl::dd::utility::ModelSubjectUtility< T, TypeAccessMapEventCode >
void notifyChanged (event_code_type event_code, subject_type &changed_subject, const std::string &additional_info)
 helper utility function to notify the current observers
 
void notifyChanged (event_code_type event_code, subject_type &changed_subject, const std::string &additional_info)
 helper utility function to notify the current observers
 
void notifyChanged (event_code_type event_code, subject_type &changed_subject, const std::string &additional_info)
 helper utility function to notify the current observers
 
void notifyChanged (event_code_type event_code, subject_type &changed_subject, const std::string &additional_info)
 helper utility function to notify the current observers
 
- Protected Attributes inherited from ddl::dd::datamodel::UnitBase
std::string _name
 the name
 

Detailed Description

Constructor & Destructor Documentation

◆ BaseUnit()

ddl::dd::datamodel::BaseUnit::BaseUnit ( std::string name,
std::string symbol,
std::string description = {} )

CTOR.

Parameters
namename of the base unit
symbolsymbol of the baseunit
descriptiondescription of the baseunit

Member Function Documentation

◆ getDescription()

const std::string & ddl::dd::datamodel::BaseUnit::getDescription ( ) const

Get the Description.

Returns
const std::string&

◆ getSymbol()

const std::string & ddl::dd::datamodel::BaseUnit::getSymbol ( ) const

Get the Symbol.

Returns
const std::string&

◆ getTypeOfUnit()

TypeOfUnit ddl::dd::datamodel::BaseUnit::getTypeOfUnit ( ) const
overridevirtual

Get the Type Of Unit.

Returns
TypeOfUnit

Implements ddl::dd::datamodel::UnitBase.

◆ operator!=()

bool ddl::dd::datamodel::BaseUnit::operator!= ( const BaseUnit & other) const

non equality operator.

Parameters
otherthe other baseunit to compare this baseunit to.
Returns
false the baseunit are equal.
true the baseunit are not equal.

◆ operator=() [1/2]

BaseUnit & ddl::dd::datamodel::BaseUnit::operator= ( BaseUnit && )
default

move assignment operator

Returns
BaseUnit&

◆ operator=() [2/2]

BaseUnit & ddl::dd::datamodel::BaseUnit::operator= ( const BaseUnit & )
default

copy assignment operator

Returns
BaseUnit&

◆ operator==()

bool ddl::dd::datamodel::BaseUnit::operator== ( const BaseUnit & other) const

equality operator.

Parameters
otherthe other baseunit to compare this baseunit to.
Returns
true the baseunit are equal.
false the baseunit are not equal.

◆ setDescription()

void ddl::dd::datamodel::BaseUnit::setDescription ( const std::string & description)

Set the Description.

Parameters
descriptionthe description to set
Remarks
This will notify the change.

◆ setName()

void ddl::dd::datamodel::BaseUnit::setName ( const std::string & name)
overridevirtual

Set the Name.

Parameters
namethe name to set
Remarks
This will notify the change.
Exceptions
dd::ErrorIf the name already exists in the container this unit prefix is part of it will throw.

Reimplemented from ddl::dd::datamodel::UnitBase.

◆ setSymbol()

void ddl::dd::datamodel::BaseUnit::setSymbol ( const std::string & symbol)

Set the Symbol.

Parameters
symbolthe symbol to set
Remarks
This will notify the change.

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