ddl::mapping::datamodel::Header Class Reference

Datamodel header class This class is observable. More...

#include <datamodel_configuration_items.h>

Inherits ModelSubject< Header >, and ddl::dd::datamodel::InfoMap.

Public Member Functions
	Header ()=delete
	no CTOR
	Header (const Header &other)
	copy CTOR
	Header (Header &&other)
	move CTOR
	Header (const Version &mapping_version, const std::string &author={}, const std::string &date_creation={}, const std::string &date_change={}, const std::string &description={})
	CTOR.
	~Header ()
	DTOR.
Header &	operator= (const Header &other)
	copy operator
Header &	operator= (Header &&other)
	move operator
bool	operator== (const Header &other) const
	equality operator (the header must have exacly the same content)
bool	operator!= (const Header &other) const
	inequality operator
Version	getMappingVersion () const
	Get the mapping version.
void	setMappingVersion (const Version &mapping_version)
	Set the mapping 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.
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.

Detailed Description

Datamodel header class This class is observable.

Constructor & Destructor Documentation

Header() [1/3]

ddl::mapping::datamodel::Header::Header

(

const Header &

other

)

copy CTOR

Parameters

other

the header to copy

Header() [2/3]

ddl::mapping::datamodel::Header::Header

(

Header &&

other

)

move CTOR

Parameters

other

the header to move

Header() [3/3]

ddl::mapping::datamodel::Header::Header	(	const Version &	mapping_version,
		const std::string &	author = {},
		const std::string &	date_creation = {},
		const std::string &	date_change = {},
		const std::string &	description = {} )

CTOR.

Parameters

mapping_version	the mapping version
author	the author
date_creation	the date of creation
date_change	the date of change
description	the description of the mapping configuration

Member Function Documentation

getAuthor()

const std::string & ddl::mapping::datamodel::Header::getAuthor

(

)

const

Get the author.

Returns

const std::string&

getDateChange()

const std::string & ddl::mapping::datamodel::Header::getDateChange

(

)

const

Get the date of last change.

Returns

const std::string&

getDateCreation()

const std::string & ddl::mapping::datamodel::Header::getDateCreation

(

)

const

Get the date of creation.

Returns

const std::string&

getDescription()

const std::string & ddl::mapping::datamodel::Header::getDescription

(

)

const

Get the description.

Returns

const std::string&

getMappingVersion()

Version ddl::mapping::datamodel::Header::getMappingVersion

(

)

const

Get the mapping version.

Returns

Version

operator!=()

bool ddl::mapping::datamodel::Header::operator!=

(

const Header &

other

)

const

inequality operator

Parameters

other

the other header to compare

Returns

true is not equal

false is equal

operator=() [1/2]

Header & ddl::mapping::datamodel::Header::operator=

(

const Header &

other

)

copy operator

Parameters

other

the header to copy

Returns

Header& the header

operator=() [2/2]

Header & ddl::mapping::datamodel::Header::operator=

(

Header &&

other

)

move operator

Parameters

other

the header to move

Returns

Header& the header

operator==()

bool ddl::mapping::datamodel::Header::operator==

(

const Header &

other

)

const

equality operator (the header must have exacly the same content)

Parameters

other

the other header to compare

Returns

true is equal

false is not equal

setAuthor()

void ddl::mapping::datamodel::Header::setAuthor

(

const std::string &

author

)

Set the author.

Parameters

author

the author

Remarks

This change is observable.

setDateChange()

void ddl::mapping::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::mapping::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::mapping::datamodel::Header::setDescription

(

const std::string &

description

)

Set the description.

Parameters

description

the description

Remarks

This change is observable.

setMappingVersion()

void ddl::mapping::datamodel::Header::setMappingVersion

(

const Version &

mapping_version

)

Set the mapping version.

Parameters

mapping_version

The mapping file version

Remarks

This change is observable.

---

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

• include/ddl/mapping/datamodel/datamodel_configuration_items.h