Datamodel function class used in MappingConfiguration. More...

#include <datamodel_configuration_items.h>

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

Public Types
using	Properties = ddl::utility::TypeAccessMap<Property, Function>
	Type of properties within module.

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
	Function ()=delete
	no CTOR

	Function (const Function &other)
	copy CTOR

	Function (Function &&other)
	move CTOR

	Function (const std::string &name, const std::string &type, const std::vector< Property > &properties={})
	CTOR.

	~Function ()
	DTOR.

Function &	operator= (const Function &other)
	copy operator

Function &	operator= (Function &&other)
	move operator

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

bool	operator!= (const Function &other) const
	inequality operator

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

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

const std::string &	getType () const
	Get the type.

void	setType (const std::string &type)
	Set the thype.

const Properties &	getProperties () const
	Get the Properties.

Properties &	getProperties ()
	Get the Properties object.

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< 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

Datamodel function class used in MappingConfiguration.

Remarks: This class is observable within a ddl::dd::utility::TypeAccessMap

Constructor & Destructor Documentation

◆ Function() [1/3]

ddl::mapping::datamodel::Function::Function ( const Function & other )

copy CTOR

Parameters

other the object to copy

◆ Function() [2/3]

ddl::mapping::datamodel::Function::Function ( Function && other )

move CTOR

Parameters

other the object to move

◆ Function() [3/3]

ddl::mapping::datamodel::Function::Function	(	const std::string &	name,
		const std::string &	type,
		const std::vector< Property > &	properties = {} )

CTOR.

Parameters

name	the name of the module instance to create
type	the type of the module to create
properties	properties for intializing

Member Function Documentation

◆ getName()

const std::string & ddl::mapping::datamodel::Function::getName ( ) const

Get the name.

Returns: const std::string&

◆ getProperties() [1/2]

Properties & ddl::mapping::datamodel::Function::getProperties ( )

Get the Properties object.

Returns: Properties&

◆ getProperties() [2/2]

const Properties & ddl::mapping::datamodel::Function::getProperties ( ) const

Get the Properties.

Returns: const Properties&

◆ getType()

const std::string & ddl::mapping::datamodel::Function::getType ( ) const

Get the type.

Returns: const std::string&

◆ operator!=()

bool ddl::mapping::datamodel::Function::operator!= ( const Function & other ) const

inequality operator

Parameters

other the other object to compare

Returns: true is not equal; false is equal

◆ operator=() [1/2]

Function & ddl::mapping::datamodel::Function::operator= ( const Function & other )

copy operator

Parameters

other the object to copy

Returns: Module&

◆ operator=() [2/2]

Function & ddl::mapping::datamodel::Function::operator= ( Function && other )

move operator

Parameters

other the object to move

Returns: Module&

◆ operator==()

bool ddl::mapping::datamodel::Function::operator== ( const Function & other ) const

equality operator

Parameters

other the other object to compare

Returns: true is equal; false is not equal

◆ setName()

void ddl::mapping::datamodel::Function::setName ( const std::string & name )

Set the name.

Parameters

name the name

Remarks: This change is observable

◆ setType()

void ddl::mapping::datamodel::Function::setType ( const std::string & type )

Set the thype.

Parameters

type the type

Remarks: This change 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/mapping/datamodel/datamodel_configuration_items.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Function() [1/3]

◆ Function() [2/3]

◆ Function() [3/3]

Member Function Documentation

◆ getName()

◆ getProperties() [1/2]

◆ getProperties() [2/2]

◆ getType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ setName()

◆ setType()