observable Stream DataDefinition object. More...

#include <datamodel_streams.h>

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

Classes
class	Struct
	DataDefinition object class of datamodel to hold a streamstruct. More...

Public Types
using	Structs = utility::TypeAccessList<Struct, Stream>
	Definiton of the container containts the streamstructs of a stream.

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
	Stream ()=delete
	no default CTOR.

	Stream (Stream &&)
	move CTOR

Stream &	operator= (Stream &&)
	move assignment operator

	Stream (const Stream &other)
	copy CTOR

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

virtual	~Stream ()=default
	DTOR.

	Stream (std::string name, std::string stream_type_name, std::string description={}, const std::vector< Struct > &structs={})
	CTOR.

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

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

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

const std::string &	getName () const
	Get the Name.

void	setStreamTypeName (const std::string &stream_type_name)
	Set the Stream Type Name.

const std::string &	getStreamTypeName () const
	Get the Stream Type Name.

const std::string &	getDescription () const
	Get the Description.

void	setDescription (const std::string &description)
	Set the Description.

const Structs &	getStructs () const
	Get the Structs object.

Structs &	getStructs ()
	Get the Structs object.

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

Detailed Description

observable Stream DataDefinition object.

Constructor & Destructor Documentation

◆ Stream() [1/2]

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

copy CTOR

Parameters

other the stream to copy from.

◆ Stream() [2/2]

ddl::dd::datamodel::Stream::Stream	(	std::string	name,
		std::string	stream_type_name,
		std::string	description = {},
		const std::vector< Struct > &	structs = {} )

CTOR.

Parameters

name	name of the stream
stream_type_name	name of the stream type (may be a stucttype or a streammetatype)
description	the description of the stream
structs	vector of streamstructs that are added.

Exceptions

ddl::dd::Error if a structs containing structs with the same name.

Member Function Documentation

◆ getDescription()

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

Get the Description.

Returns: const std::string&

◆ getName()

const std::string & ddl::dd::datamodel::Stream::getName ( ) const

Get the Name.

Returns: const std::string&

◆ getStreamTypeName()

const std::string & ddl::dd::datamodel::Stream::getStreamTypeName ( ) const

Get the Stream Type Name.

Returns: const std::string&

◆ getStructs() [1/2]

Structs & ddl::dd::datamodel::Stream::getStructs ( )

Get the Structs object.

Returns: Structs&

◆ getStructs() [2/2]

const Structs & ddl::dd::datamodel::Stream::getStructs ( ) const

Get the Structs object.

Returns: const Structs&

◆ operator!=()

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

non equality operator.

Parameters

other the other stream to compare this stream to.

Returns: false the streams are equal.; true the streams are not equal.

◆ operator=() [1/2]

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

copy assignment operator

Parameters

other the stream to copy from.

Returns: Stream&

◆ operator=() [2/2]

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

move assignment operator

Returns: Stream&

◆ operator==()

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

equality operator.

Parameters

other the other stream to compare this stream to.

Returns: true the streams are equal.; false the streams are not equal.

◆ setDescription()

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

Set the Description.

Parameters

description the description to set

Remarks: This is observable.

◆ setName()

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

Set the Name.

Parameters

name the name

Remarks: This is observable.

Exceptions

Throws if a stream with that name already exists in the container this stream is part of.

◆ setStreamTypeName()

void ddl::dd::datamodel::Stream::setStreamTypeName ( const std::string & stream_type_name )

Set the Stream Type Name.

Parameters

stream_type_name the streamtype name (must be a structtype or a streammetatype)

Remarks: This is observable.

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

/workspace/conan/dev_essential/1.6.3/dw/stable/package/65324bff46e457721a7ba250afe9d61dc2b0e57a/include/ddl/dd/datamodel/datamodel_streams.h

Classes

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Stream() [1/2]

◆ Stream() [2/2]

Member Function Documentation

◆ getDescription()

◆ getName()

◆ getStreamTypeName()

◆ getStructs() [1/2]

◆ getStructs() [2/2]

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ setDescription()

◆ setName()

◆ setStreamTypeName()