observable DataDefinition object class to describe StreamMetaType. More...

#include <datamodel_types.h>

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

Public Types
using	Property = KeyValuePair
	defintion of properties by using name - type pair.

using	Properties = utility::TypeAccessMap<Property, StreamMetaType>
	container of properties for the StreamMetaType::Property.

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, TypeAccessMapEventCode >	observer_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, TypeAccessMapEventCode >	observer_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, TypeAccessMapEventCode >	observer_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, TypeAccessMapEventCode >	observer_type
	local definition of the observer type to notify

Public Member Functions
	StreamMetaType ()=delete
	no default CTOR

	StreamMetaType (StreamMetaType &&)
	move CTOR

StreamMetaType &	operator= (StreamMetaType &&)
	move assignment operator

	StreamMetaType (const StreamMetaType &other)
	copy CTOR

StreamMetaType &	operator= (const StreamMetaType &other)
	copy assignment operator

	StreamMetaType (std::string name, std::string version, std::string parent={}, const std::vector< Property > &properties={})
	CTOR.

virtual	~StreamMetaType ()=default
	DTOR.

bool	operator== (const StreamMetaType &other) const
	equality operator.

bool	operator!= (const StreamMetaType &other) const
	non equality operator.

const Properties &	getProperties () const
	Get the Properties object.

Properties &	getProperties ()
	Get the Properties object.

TypeOfType	getTypeOfType () const override
	Get the Type Of the Type (data_type, enum_type, struct_type, stream_meta_type).

void	setName (const std::string &name) override
	Set the Name.

const std::string &	getParent () const
	Get the Parent.

void	setParent (const std::string &parent)
	Set the Parent This is only valid if the parent is a valid other streammetatype.

const std::string &	getVersion () const
	Get the Version.

void	setVersion (const std::string &version)
	Set the Version.

Public Member Functions inherited from ddl::dd::datamodel::TypeBase
	TypeBase ()=default
	CTOR.

	TypeBase (const TypeBase &)=default
	copy CTOR

	TypeBase (TypeBase &&)=default
	move CTOR

TypeBase &	operator= (const TypeBase &)=default
	copy assignment operator

TypeBase &	operator= (TypeBase &&)=default
	move assignment operator

	TypeBase (std::string name)
	CTOR.

virtual	~TypeBase ()=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!

ModelSubjectUtility &	operator= (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!

ModelSubjectUtility &	operator= (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!

ModelSubjectUtility &	operator= (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!

ModelSubjectUtility &	operator= (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!

ModelSubjectUtility &	operator= (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!

ModelSubjectUtility &	operator= (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!

ModelSubjectUtility &	operator= (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!

ModelSubjectUtility &	operator= (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

InfoMap &	operator= (const InfoMap &)
	copy assignment operator

InfoMap &	operator= (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
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::TypeBase
std::string	_name
	name storage value

Detailed Description

observable DataDefinition object class to describe StreamMetaType.

Constructor & Destructor Documentation

◆ StreamMetaType() [1/2]

ddl::dd::datamodel::StreamMetaType::StreamMetaType ( const StreamMetaType & other )

copy CTOR

Parameters

other the other type to copy from

◆ StreamMetaType() [2/2]

ddl::dd::datamodel::StreamMetaType::StreamMetaType	(	std::string	name,
		std::string	version,
		std::string	parent = {},
		const std::vector< Property > &	properties = {} )

CTOR.

Parameters

name	the name of the streammetatype
version	the version of the streammetatype
parent	the parent of the streammetatype
properties	a initial set of properties

Exceptions

may	throw if `properties` contains properties with the same name twice.

Member Function Documentation

◆ getParent()

const std::string & ddl::dd::datamodel::StreamMetaType::getParent ( ) const

Get the Parent.

Returns: const std::string&

◆ getProperties() [1/2]

Properties & ddl::dd::datamodel::StreamMetaType::getProperties ( )

Get the Properties object.

Returns: Properties&

◆ getProperties() [2/2]

const Properties & ddl::dd::datamodel::StreamMetaType::getProperties ( ) const

Get the Properties object.

Returns: const Properties&

◆ getTypeOfType()

TypeOfType ddl::dd::datamodel::StreamMetaType::getTypeOfType ( ) const

overridevirtual

Get the Type Of the Type (data_type, enum_type, struct_type, stream_meta_type).

Returns: TypeOfType

Implements ddl::dd::datamodel::TypeBase.

◆ getVersion()

const std::string & ddl::dd::datamodel::StreamMetaType::getVersion ( ) const

Get the Version.

Returns: const std::string&

◆ operator!=()

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

non equality operator.

Parameters

other the other type to compare to.

Returns: false the type is equal (and all its properties).; true the type is not equal.

◆ operator=() [1/2]

StreamMetaType & ddl::dd::datamodel::StreamMetaType::operator= ( const StreamMetaType & other )

copy assignment operator

Parameters

other the other type to copy from

Returns: StreamMetaType&

◆ operator=() [2/2]

StreamMetaType & ddl::dd::datamodel::StreamMetaType::operator= ( StreamMetaType && )

move assignment operator

Returns: StreamMetaType&

◆ operator==()

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

equality operator.

Parameters

other the other type to compare to.

Returns: true the type is equal (and all its properties).; false the type is not equal.

◆ setName()

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

overridevirtual

Set the Name.

Parameters

name	The name of type.

Exceptions

This	might throw if the set name does already exist in the container this type is part of.

Reimplemented from ddl::dd::datamodel::TypeBase.

◆ setParent()

void ddl::dd::datamodel::StreamMetaType::setParent ( const std::string & parent )

Set the Parent This is only valid if the parent is a valid other streammetatype.

Parameters

parent the parent to set.

Remarks: This is observable.

◆ setVersion()

void ddl::dd::datamodel::StreamMetaType::setVersion ( const std::string & version )

Set the Version.

Parameters

version the version to set

Remarks: This is observable.

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

include/ddl/dd/datamodel/datamodel_types.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StreamMetaType() [1/2]

◆ StreamMetaType() [2/2]

Member Function Documentation

◆ getParent()

◆ getProperties() [1/2]

◆ getProperties() [2/2]

◆ getTypeOfType()

◆ getVersion()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ setName()

◆ setParent()

◆ setVersion()