Data Definition datamodel for the Header. More...

#include <datamodel_header.h>

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

Public Types
using	ExtDeclaration = KeyValuePair
	Use of the key value pair to declare the ext declaration.

using	ExtDeclarations = utility::TypeAccessMap<ExtDeclaration, Header>
	map container for a set of ext declarations.

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

	Header (const Header &other)
	copy CTOR.

Header &	operator= (const Header &other)
	copy assignment.

	Header (Header &&)=default
	move CTOR.

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

virtual	~Header ()=default
	Destroys the Header.

	Header (Version ddl_version, std::string author={}, std::string date_creation={}, std::string date_change={}, std::string description={}, const std::vector< ExtDeclaration > &ext_declarations={})
	Construct a new Header object.

bool	operator== (const Header &other) const
	Equality operator.

bool	operator!= (const Header &other) const
	Non-Equality operator.

Version	getLanguageVersion () const
	Get the Language Version.

void	setLanguageVersion (const Version &ddl_version)
	Set the Language Version.

const std::string &	getAuthor () const
	Get the Author.

void	setAuthor (const std::string &author)
	Set the Author.

const std::string &	getDateCreation () const
	Get the Date of Creation.

void	setDateCreation (const std::string &date_creation)
	Set the Date of Creation.

const std::string &	getDateChange () const
	Get the Date of last Change.

void	setDateChange (const std::string &date_change)
	Set the Date of last Change.

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

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

const ExtDeclarations &	getExtDeclarations () const
	Get the Ext Declarations object.

ExtDeclarations &	getExtDeclarations ()
	Get the Ext Declarations 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::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

Detailed Description

Data Definition datamodel for the Header.

Constructor & Destructor Documentation

◆ Header() [1/2]

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

copy CTOR.

Parameters

other other header.

◆ Header() [2/2]

ddl::dd::datamodel::Header::Header	(	Version	ddl_version,
		std::string	author = {},
		std::string	date_creation = {},
		std::string	date_change = {},
		std::string	description = {},
		const std::vector< ExtDeclaration > &	ext_declarations = {} )

Construct a new Header object.

Parameters

ddl_version	The Language version
author	the author
date_creation	the date of creation
date_change	the date of last change
description	the description
ext_declarations	a vector of ext declations that are added immediatelly.

Exceptions

throws if ext_declarations contains ext declarations with the same key.

Member Function Documentation

◆ getAuthor()

const std::string & ddl::dd::datamodel::Header::getAuthor ( ) const

Get the Author.

Returns: const std::string&

◆ getDateChange()

const std::string & ddl::dd::datamodel::Header::getDateChange ( ) const

Get the Date of last Change.

Returns: const std::string&

◆ getDateCreation()

const std::string & ddl::dd::datamodel::Header::getDateCreation ( ) const

Get the Date of Creation.

Returns: const std::string&

◆ getDescription()

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

Get the Description.

Returns: const std::string&

◆ getExtDeclarations() [1/2]

ExtDeclarations & ddl::dd::datamodel::Header::getExtDeclarations ( )

Get the Ext Declarations object.

Returns: ExtDeclarations&

◆ getExtDeclarations() [2/2]

const ExtDeclarations & ddl::dd::datamodel::Header::getExtDeclarations ( ) const

Get the Ext Declarations object.

Returns: const ExtDeclarations&

◆ getLanguageVersion()

Version ddl::dd::datamodel::Header::getLanguageVersion ( ) const

Get the Language Version.

Returns: Version

◆ operator!=()

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

Non-Equality operator.

Parameters

other the other header to compare to

Returns: false if every single content is the same; true if content is different

◆ operator=()

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

copy assignment.

Parameters

other other header.

◆ operator==()

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

Equality operator.

Parameters

other the other header to compare to

Returns: true if every single content is the same; false if content is different

◆ setAuthor()

void ddl::dd::datamodel::Header::setAuthor ( const std::string & author )

Set the Author.

Parameters

author the author

Remarks: This change is observable.

◆ setDateChange()

void ddl::dd::datamodel::Header::setDateChange ( const std::string & date_change )

Set the Date of last Change.

Parameters

date_change the date of last change

Remarks: This change is observable.

◆ setDateCreation()

void ddl::dd::datamodel::Header::setDateCreation ( const std::string & date_creation )

Set the Date of Creation.

Parameters

date_creation the date of creation.

Remarks: This change is observable.

◆ setDescription()

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

Set the Description object.

Parameters

description the description

Remarks: This change is observable.

◆ setLanguageVersion()

void ddl::dd::datamodel::Header::setLanguageVersion ( const Version & ddl_version )

Set the Language Version.

Parameters

ddl_version The language version

Remarks: This change is observable.

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

include/ddl/dd/datamodel/datamodel_header.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Header() [1/2]

◆ Header() [2/2]

Member Function Documentation

◆ getAuthor()

◆ getDateChange()

◆ getDateCreation()

◆ getDescription()

◆ getExtDeclarations() [1/2]

◆ getExtDeclarations() [2/2]

◆ getLanguageVersion()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ setAuthor()

◆ setDateChange()

◆ setDateCreation()

◆ setDescription()

◆ setLanguageVersion()