ADTF  3.18.2
Header

Data Definition datamodel for the Header. More...

Inheritance diagram for Header:
[legend]

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 ModelSubjectUtility< MODEL_SUBJECT_T, EVENT_CODE_T >
typedef EVENT_CODE_T event_code_type
 local definition of the event code type
 
typedef MODEL_SUBJECT_T subject_type
 local definition of the subject type
 
typedef ModelObserverUtility< MODEL_SUBJECT_T, EVENT_CODE_T > observer_type
 local definition of the observer type to notify
 

Public Member Functions

 Header ()=delete
 no default CTOR.
 
 Header (const Header &other)
 copy CTOR. More...
 
Headeroperator= (const Header &other)
 copy assignment. More...
 
 Header (Header &&)=default
 move CTOR.
 
Headeroperator= (Header &&)=default
 move assignment.
 
virtual ~Header ()=default
 Destroys the Header.
 
 Header (const Version &ddl_version, const std::string &author={}, const std::string &date_creation={}, const std::string &date_change={}, const std::string &description={}, const std::vector< ExtDeclaration > &ext_declarations={})
 Construct a new Header object. More...
 
bool operator== (const Header &other) const
 Equality operator. More...
 
bool operator!= (const Header &other) const
 Non-Equality operator. More...
 
Version getLanguageVersion () const
 Get the Language Version. More...
 
void setLanguageVersion (const Version &ddl_version)
 Set the Language Version. More...
 
const std::string & getAuthor () const
 Get the Author. More...
 
void setAuthor (const std::string &author)
 Set the Author. More...
 
const std::string & getDateCreation () const
 Get the Date of Creation. More...
 
void setDateCreation (const std::string &date_creation)
 Set the Date of Creation. More...
 
const std::string & getDateChange () const
 Get the Date of last Change. More...
 
void setDateChange (const std::string &date_change)
 Set the Date of last Change. More...
 
const std::string & getDescription () const
 Get the Description. More...
 
void setDescription (const std::string &description)
 Set the Description object. More...
 
const ExtDeclarationsgetExtDeclarations () const
 Get the Ext Declarations object. More...
 
ExtDeclarationsgetExtDeclarations ()
 Get the Ext Declarations object. More...
 
- Public Member Functions inherited from ModelSubjectUtility< MODEL_SUBJECT_T, EVENT_CODE_T >
 ModelSubjectUtility ()=default
 CTOR.
 
 ModelSubjectUtility (const ModelSubjectUtility &)
 copy CTOR which removes the observers in case of!
 
ModelSubjectUtilityoperator= (const ModelSubjectUtility &)
 copy assignment operator which removes the observers in case of! More...
 
virtual ~ModelSubjectUtility ()=default
 DTOR.
 
void attachObserver (observer_type *observer)
 adda a observer to notify. More...
 
void detachObserver (observer_type *observer)
 remove a observer if in list. More...
 
- Public Member Functions inherited from InfoMap
 InfoMap ()=default
 CTOR.
 
 InfoMap (const InfoMap &)
 copy CTOR More...
 
 InfoMap (InfoMap &&)
 move CTOR More...
 
InfoMapoperator= (const InfoMap &)
 copy assignment operator More...
 
InfoMapoperator= (InfoMap &&)
 move assignment operator More...
 
template<typename INFO_T >
const INFO_T * getInfo () const
 Get the Info Pointer. More...
 
template<typename INFO_T >
INFO_T * getInfo ()
 Get the Info Pointer. More...
 
template<typename INFO_T >
void setInfo (const std::shared_ptr< INFO_T > &info)
 Set the Info object as shared pointer. More...
 

Private Member Functions

bool validateContains (const ExtDeclarations::access_type &ext_declarations_name) const
 
void notifyChangedMapContent (utility::TypeAccessMapEventCode code, ExtDeclarations::access_type &ext_declaration, const std::string &additional_info)
 

Private Attributes

Version _ddl_version = {}
 
std::string _author
 
std::string _date_creation
 
std::string _date_change
 
std::string _description
 
ExtDeclarations _ext_declarations
 

Additional Inherited Members

- Protected Member Functions inherited from ModelSubjectUtility< MODEL_SUBJECT_T, EVENT_CODE_T >
void notifyChanged (event_code_type event_code, subject_type &changed_subject, const std::string &additional_info)
 helper utility function to notify the current observers More...
 

Detailed Description

Data Definition datamodel for the Header.

Definition at line 37 of file datamodel_header.h.

Constructor & Destructor Documentation

◆ Header() [1/2]

Header ( const Header other)

copy CTOR.

Parameters
otherother header.

◆ Header() [2/2]

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

Construct a new Header object.

Parameters
ddl_versionThe Language version
authorthe author
date_creationthe date of creation
date_changethe date of last change
descriptionthe description
ext_declarationsa vector of ext declations that are added immediatelly.
Exceptions
throwsif ext_declarations contains ext declarations with the same key.

Member Function Documentation

◆ getAuthor()

const std::string& getAuthor ( ) const

Get the Author.

Returns
const std::string&

Referenced by DDToXMLFactory< DOM_NODE_TYPE >::createNode().

◆ getDateChange()

const std::string& getDateChange ( ) const

Get the Date of last Change.

Returns
const std::string&

Referenced by DDToXMLFactory< DOM_NODE_TYPE >::createNode().

◆ getDateCreation()

const std::string& getDateCreation ( ) const

Get the Date of Creation.

Returns
const std::string&

Referenced by DDToXMLFactory< DOM_NODE_TYPE >::createNode().

◆ getDescription()

const std::string& getDescription ( ) const

Get the Description.

Returns
const std::string&

Referenced by DDToXMLFactory< DOM_NODE_TYPE >::createNode().

◆ getExtDeclarations() [1/2]

ExtDeclarations& getExtDeclarations ( )

Get the Ext Declarations object.

Returns
ExtDeclarations&

◆ getExtDeclarations() [2/2]

const ExtDeclarations& getExtDeclarations ( ) const

Get the Ext Declarations object.

Returns
const ExtDeclarations&

Referenced by DDToXMLFactory< DOM_NODE_TYPE >::createNode().

◆ getLanguageVersion()

Version getLanguageVersion ( ) const

Get the Language Version.

Returns
Version

Referenced by DDToXMLFactory< DOM_NODE_TYPE >::createNode().

◆ operator!=()

bool operator!= ( const Header other) const

Non-Equality operator.

Parameters
otherthe other header to compare to
Returns
false if every single content is the same
true if content is different

◆ operator=()

Header& operator= ( const Header other)

copy assignment.

Parameters
otherother header.

◆ operator==()

bool operator== ( const Header other) const

Equality operator.

Parameters
otherthe other header to compare to
Returns
true if every single content is the same
false if content is different

◆ setAuthor()

void setAuthor ( const std::string &  author)

Set the Author.

Parameters
authorthe author
Remarks
This change is observable.

Referenced by DDFromXMLFactory< DOM_NODE_TYPE >::createHeader().

◆ setDateChange()

void setDateChange ( const std::string &  date_change)

Set the Date of last Change.

Parameters
date_changethe date of last change
Remarks
This change is observable.

◆ setDateCreation()

void setDateCreation ( const std::string &  date_creation)

Set the Date of Creation.

Parameters
date_creationthe date of creation.
Remarks
This change is observable.

◆ setDescription()

void setDescription ( const std::string &  description)

Set the Description object.

Parameters
descriptionthe description
Remarks
This change is observable.

◆ setLanguageVersion()

void setLanguageVersion ( const Version ddl_version)

Set the Language Version.

Parameters
ddl_versionThe language version
Remarks
This change is observable.