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

#include <datamodel_streams.h>

Inherits ddl::dd::utility::ModelSubjectUtility< T, TypeAccessListEventCode >, and ddl::dd::datamodel::InfoMap.

Public Member Functions
	Struct ()
	default CTOR

	Struct (const Struct &)=default
	copy CTOR

	Struct (Struct &&)=default
	move CTOR

Struct &	operator= (const Struct &)=default
	copy assignment operator.

Struct &	operator= (Struct &&)=default
	move assignment operator.

	Struct (std::string name, std::string type_name, OptionalSize byte_pos={})
	CTOR.

bool	operator== (const Struct &other) const
	equality operator

bool	operator!= (const Struct &other) const
	non-equality operator

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

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

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

void	setTypeName (const std::string &type_name)
	Set the Type Name.

OptionalSize	getBytePos () const
	Get the Byte Pos.

void	setBytePos (OptionalSize byte_pos)
	Set the Byte Pos.

Public Member Functions inherited from ddl::dd::utility::ModelSubjectUtility< T, TypeAccessListEventCode >
	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
Public Types inherited from ddl::dd::utility::ModelSubjectUtility< T, TypeAccessListEventCode >
typedef TypeAccessListEventCode	event_code_type
	local definition of the event code type

typedef T	subject_type
	local definition of the subject type

typedef ModelObserverUtility< T, TypeAccessListEventCode >	observer_type
	local definition of the observer type to notify

typedef TypeAccessListEventCode	event_code_type
	local definition of the event code type

typedef T	subject_type
	local definition of the subject type

typedef ModelObserverUtility< T, TypeAccessListEventCode >	observer_type
	local definition of the observer type to notify

typedef TypeAccessListEventCode	event_code_type
	local definition of the event code type

typedef T	subject_type
	local definition of the subject type

typedef ModelObserverUtility< T, TypeAccessListEventCode >	observer_type
	local definition of the observer type to notify

typedef TypeAccessListEventCode	event_code_type
	local definition of the event code type

typedef T	subject_type
	local definition of the subject type

typedef ModelObserverUtility< T, TypeAccessListEventCode >	observer_type
	local definition of the observer type to notify

Protected Member Functions inherited from ddl::dd::utility::ModelSubjectUtility< T, TypeAccessListEventCode >
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

DataDefinition object class of datamodel to hold a streamstruct.

Constructor & Destructor Documentation

◆ Struct()

ddl::dd::datamodel::Stream::Struct::Struct	(	std::string	name,
		std::string	type_name,
		OptionalSize	byte_pos = {} )

CTOR.

Parameters

name	name of the stream struct (one single empty name is allowed (says xsd))
type_name	the name of the type to use (must be a valid struct type)
byte_pos	the first bytepos of the structtype (optional ... default is 0)

Member Function Documentation

◆ getBytePos()

OptionalSize ddl::dd::datamodel::Stream::Struct::getBytePos ( ) const

Get the Byte Pos.

Returns: OptionalSize (use 0 if not valid)

◆ getName()

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

Get the Name.

Returns: const std::string&

◆ getTypeName()

const std::string & ddl::dd::datamodel::Stream::Struct::getTypeName ( ) const

Get the Type Name.

Returns: const std::string&

◆ operator!=()

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

non-equality operator

Parameters

other the other streamstruct to compare the streamstruct with.

Returns: false the stream structs are equal; true the stream structs are not equal

◆ operator=() [1/2]

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

default

copy assignment operator.

Returns: Struct&

◆ operator=() [2/2]

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

default

move assignment operator.

Returns: Struct&

◆ operator==()

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

equality operator

Parameters

other the other streamstruct to compare the streamstruct with.

Returns: true the stream structs are equal; false the stream structs are not equal

◆ setBytePos()

void ddl::dd::datamodel::Stream::Struct::setBytePos ( OptionalSize byte_pos )

Set the Byte Pos.

Parameters

byte_pos the byte pos to set

Remarks: Is observable.

◆ setName()

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

Set the Name.

Parameters

name the name

Remarks: Is observable.

Exceptions

may	throw if the name is not unique within the container this struct is part of.

◆ setTypeName()

void ddl::dd::datamodel::Stream::Struct::setTypeName ( const std::string & type_name )

Set the Type Name.

Parameters

type_name the typename to set

Remarks: Is observable.

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

include/ddl/dd/datamodel/datamodel_streams.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Struct()

Member Function Documentation

◆ getBytePos()

◆ getName()

◆ getTypeName()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ setBytePos()

◆ setName()

◆ setTypeName()