Unit

BaseUnit. More...

Inheritance diagram for Unit:

Classes
class	RefUnit
	datamodel for the refUnit More...

Public Types
using	RefUnits = std::vector< RefUnit >
	definiton of the container for the RefUnits
Public Types inherited from ModelSubjectUtility< MODEL_SUBJECT_T, EVENT_CODE_T >
typedef EVENT_CODE_T	event_code_type
	local definition of the event code type
typedef MODEL_SUBJECT_T	subject_type
	local definition of the subject type
typedef ModelObserverUtility< MODEL_SUBJECT_T, EVENT_CODE_T >	observer_type
	local definition of the observer type to notify

Public Member Functions
	Unit ()
	CTOR.
	Unit (const Unit &)=default
	copy CTOR
Unit &	operator= (const Unit &)=default
	copy assignment operator More...
	Unit (Unit &&)=default
	move CTOR
Unit &	operator= (Unit &&)=default
	move assignment operator More...
virtual	~Unit ()=default
	DTOR.
	Unit (const std::string &name, const std::string &numerator, const std::string &denominator, const std::string &offset, const std::vector< RefUnit > &ref_units={})
	CTOR. More...
bool	operator== (const Unit &other) const
	equality operator. More...
bool	operator!= (const Unit &other) const
	non equality operator. More...
TypeOfUnit	getTypeOfUnit () const override
	Get the Type Of Unit. More...
void	setName (const std::string &name) override
	Set the Name. More...
const std::string &	getNumerator () const
	Get the Numerator. More...
void	setNumerator (const std::string &numerator)
	Set the Numerator object. More...
const std::string &	getDenominator () const
	Get the Denominator. More...
void	setDenominator (const std::string &denominator)
	Set the Denominator. More...
const std::string &	getOffset () const
	Get the Offset. More...
void	setOffset (const std::string &offset)
	Set the Offset. More...
const RefUnits &	getRefUnits () const
	return the refUnits container More...
void	addRefUnit (const RefUnit &ref_unit)
	adding a refunit More...
void	removeRefUnit (const RefUnit &ref_unit)
	remove the refunit More...
Public Member Functions inherited from UnitBase
	UnitBase ()=default
	default CTOR
	UnitBase (const UnitBase &)=default
	copy CTOR
	UnitBase (UnitBase &&)=default
	move CTOR
UnitBase &	operator= (const UnitBase &)=default
	copy assignment operator More...
UnitBase &	operator= (UnitBase &&)=default
	move assignment operator More...
	UnitBase (const std::string &name)
	CTOR. More...
virtual	~UnitBase ()=default
	DTOR.
const std::string &	getName () const
	Get the Name. More...
Public Member Functions inherited from ModelSubjectUtility< MODEL_SUBJECT_T, EVENT_CODE_T >
	ModelSubjectUtility ()=default
	CTOR.
	ModelSubjectUtility (const ModelSubjectUtility &)
	copy CTOR which removes the observers in case of!
ModelSubjectUtility &	operator= (const ModelSubjectUtility &)
	copy assignment operator which removes the observers in case of! More...
virtual	~ModelSubjectUtility ()=default
	DTOR.
void	attachObserver (observer_type *observer)
	adda a observer to notify. More...
void	detachObserver (observer_type *observer)
	remove a observer if in list. More...
Public Member Functions inherited from InfoMap
	InfoMap ()=default
	CTOR.
	InfoMap (const InfoMap &)
	copy CTOR More...
	InfoMap (InfoMap &&)
	move CTOR More...
InfoMap &	operator= (const InfoMap &)
	copy assignment operator More...
InfoMap &	operator= (InfoMap &&)
	move assignment operator More...
template<typename INFO_T >
const INFO_T *	getInfo () const
	Get the Info Pointer. More...
template<typename INFO_T >
INFO_T *	getInfo ()
	Get the Info Pointer. More...
template<typename INFO_T >
void	setInfo (const std::shared_ptr< INFO_T > &info)
	Set the Info object as shared pointer. More...

Private Member Functions
void	notify (ModelEventCode code, utility::TypeAccessMapEventCode map_code, const std::string &additional_info)

Private Attributes
std::string	_numerator = {}
std::string	_denominator = {}
std::string	_offset = {}
RefUnits	_ref_units

Additional Inherited Members
Protected Member Functions inherited from ModelSubjectUtility< MODEL_SUBJECT_T, EVENT_CODE_T >
void	notifyChanged (event_code_type event_code, subject_type &changed_subject, const std::string &additional_info)
	helper utility function to notify the current observers More...
Protected Attributes inherited from UnitBase
std::string	_name
	the name

Detailed Description

BaseUnit.

Definition at line 335 of file datamodel_units.h.

Constructor & Destructor Documentation

Unit()

Unit	(	const std::string &	name,
		const std::string &	numerator,
		const std::string &	denominator,
		const std::string &	offset,
		const std::vector< RefUnit > &	ref_units = {}
	)

CTOR.

Parameters

name	the name of the unit
numerator	the numerator for the unit
denominator	the denominator for the unit
offset	the offset for the unit
ref_units	vector of refunits

Exceptions

dd::Error

this will throw if this list contains a base_unit/prefix pair twice

Member Function Documentation

addRefUnit()

void addRefUnit

(

const RefUnit &

ref_unit

)

adding a refunit

Parameters

ref_unit

the refunit to add

Exceptions

dd::Error

this will throw if this refUnits already contains a base_unit/prefix pair

getDenominator()

const std::string& getDenominator

(

)

const

Get the Denominator.

Returns

const std::string&

getNumerator()

const std::string& getNumerator

(

)

const

Get the Numerator.

Returns

const std::string&

getOffset()

const std::string& getOffset

(

)

const

Get the Offset.

Returns

const std::string&

getRefUnits()

const RefUnits& getRefUnits

(

)

const

return the refUnits container

Returns

const RefUnits&

getTypeOfUnit()

TypeOfUnit getTypeOfUnit ( ) const

overridevirtual

Get the Type Of Unit.

Returns

TypeOfUnit

Implements UnitBase.

operator!=()

bool operator!=

(

const Unit &

other

)

const

non equality operator.

Parameters

other

the other unit to compare this unit to.

Returns

false the unit are equal (and all its refunits)

true the unit are not equal.

operator=() [1/2]

Unit& operator= ( const Unit &  )

default

copy assignment operator

Returns

Unit&

operator=() [2/2]

Unit& operator= ( Unit &&  )

default

move assignment operator

Returns

Unit&

operator==()

bool operator==

(

const Unit &

other

)

const

equality operator.

Parameters

other

the other unit to compare this unit to.

Returns

true the unit are equal (and all its refunits)

false the unit are not equal.

removeRefUnit()

void removeRefUnit

(

const RefUnit &

ref_unit

)

remove the refunit

Parameters

ref_unit

the refunit to remove

setDenominator()

void setDenominator

(

const std::string &

denominator

)

Set the Denominator.

Parameters

denominator

the denominator to set

Remarks

This will notify the change.

setName()

void setName ( const std::string &  name )

overridevirtual

Set the Name.

Parameters

name	the name to set

Remarks

This will notify the change.

Exceptions

dd::Error

If the name already exists in the container this unit is part of it will throw.

Reimplemented from UnitBase.

setNumerator()

void setNumerator

(

const std::string &

numerator

)

Set the Numerator object.

Parameters

numerator

the numerator to set

Remarks

This will notify the change.

setOffset()

void setOffset

(

const std::string &

offset

)

Set the Offset.

Parameters

offset

the offset to set

Remarks

This will notify the change.