Datamodel assignment class used in Target. More...

#include <datamodel_configuration_items.h>

Inherits ddl::utility::TypeAccessListSubject< Assignment >, and ddl::dd::datamodel::InfoMap.

Classes
struct	FunctionCall
	FunctionCall type. More...

Public Types
enum class	Type { source_value , const_value , function_call }
	the type of the assignment More...

using	SourceValue = ParameterValue::SourceValue
	SourceValue type.

using	ConstValue = ParameterValue::ConstValue
	ConstValue type.

using	ParameterValues = ddl::utility::TypeAccessList<ParameterValue, Assignment>
	ParameterValues type within Assignment.

Public Member Functions
	Assignment ()=delete
	no CTOR

	Assignment (const Assignment &other)
	copy CTOR

	Assignment (Assignment &&other)
	move CTOR

	Assignment (const std::string &to_target_value_name, const SourceValue &from_source_value)
	CTOR.

	Assignment (const std::string &to_target_value_name, const ConstValue &from_const_value)
	CTOR.

	Assignment (const std::string &to_target_value_name, const FunctionCall &from_module_call, const std::vector< ParameterValue > &parameter_values={})
	CTOR.

	~Assignment ()
	DTOR.

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

Assignment &	operator= (Assignment &&other)
	move operator

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

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

Type	getType () const
	Get the type.

const std::string &	getTo () const
	Get the assignment value to assign to.

const std::string &	getName () const
	Get the name of the assignment value to assign to (the same as getTo)

void	setTo (const std::string &to)
	Set the assignment value to assign to.

SourceValue	getSourceValue () const
	Get the source value if type is set to Type::source_value.

void	setAsSourceValue (const SourceValue &source_value)
	Set as source value assignment.

ConstValue	getConstValue () const
	Get the const value if type is set to Type::const_value.

void	setAsConstValue (const ConstValue &const_value)
	Set as const value assignment.

FunctionCall	getFunctionCall () const
	Get the function call value if type is set to Type::function_call.

void	setAsFunctionCall (const FunctionCall &function_call)
	Set as function call assignment.

void	setAsFunctionCall (const FunctionCall &module_call, const std::vector< ParameterValue > &parameter_values)
	Set as module call assignment and the parameters to use for the function.

const ParameterValues &	getParameterValues () const
	Get the ParameterValues.

ParameterValues &	getParameterValues ()
	Get the ParameterValues.

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 assignment class used in Target.

Remarks: This class is observable within a ddl::utility::TypeAccessList

Member Enumeration Documentation

◆ Type

enum class ddl::mapping::datamodel::Assignment::Type

strong

the type of the assignment

Enumerator

source_value

The assignment is a source value assignment.

See also: Assignment::getSourceValue, SourceValue

const_value

The assignment is a const value assignment.

See also: Assignment::getConstValue, ConstValue

function_call

The assignment is a function call assignment.

See also: Assignment::getFunctionCall, FunctionCall

Constructor & Destructor Documentation

◆ Assignment() [1/5]

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

copy CTOR

Parameters

other the object to copy

◆ Assignment() [2/5]

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

move CTOR

Parameters

other the object to move

◆ Assignment() [3/5]

ddl::mapping::datamodel::Assignment::Assignment	(	const std::string &	to_target_value_name,
		const SourceValue &	from_source_value )

CTOR.

the type will be set to Type::source_value

Parameters

to_target_value_name	the target value name to assign to
from_source_value	the source value to take the value from

◆ Assignment() [4/5]

ddl::mapping::datamodel::Assignment::Assignment	(	const std::string &	to_target_value_name,
		const ConstValue &	from_const_value )

CTOR.

the type will be set to Type::const_value

Parameters

to_target_value_name	the target value name to assign to
from_const_value	the const value to set

◆ Assignment() [5/5]

ddl::mapping::datamodel::Assignment::Assignment	(	const std::string &	to_target_value_name,
		const FunctionCall &	from_module_call,
		const std::vector< ParameterValue > &	parameter_values = {} )

CTOR.

The assignment will lead into a call of the given function within the given module instance. The type will be set to Type::function_call. The target value is set as kind of:

to_target_value = module_name.function_name(param1, param2)

Parameters

to_target_value_name	the target value name to assign to
from_module_call	the module name and function to call and set the return value from
parameter_values	the parameters for the function call

Member Function Documentation

◆ getConstValue()

ConstValue ddl::mapping::datamodel::Assignment::getConstValue ( ) const

Get the const value if type is set to Type::const_value.

Returns: ConstValue

◆ getFunctionCall()

FunctionCall ddl::mapping::datamodel::Assignment::getFunctionCall ( ) const

Get the function call value if type is set to Type::function_call.

Returns: FunctionCall

◆ getName()

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

Get the name of the assignment value to assign to (the same as getTo)

Returns: const std::string&

◆ getParameterValues() [1/2]

ParameterValues & ddl::mapping::datamodel::Assignment::getParameterValues ( )

Get the ParameterValues.

Returns: ParameterValues&

◆ getParameterValues() [2/2]

const ParameterValues & ddl::mapping::datamodel::Assignment::getParameterValues ( ) const

Get the ParameterValues.

Returns: const ParameterValues&

◆ getSourceValue()

SourceValue ddl::mapping::datamodel::Assignment::getSourceValue ( ) const

Get the source value if type is set to Type::source_value.

Returns: SourceValue

◆ getTo()

const std::string & ddl::mapping::datamodel::Assignment::getTo ( ) const

Get the assignment value to assign to.

Returns: const std::string&

◆ getType()

Type ddl::mapping::datamodel::Assignment::getType ( ) const

Get the type.

If type is Assignment::Type::source_value only getSourceValue is a valid call.
If type is Assignment::Type::const_value only getConstValue is a valid call.
If type is Assignment::Type::function_call only getFunctionCall is a valid call.
Returns
Type

◆ operator!=()

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

inequality operator

Parameters

other the other object to compare

Returns: true is not equal; false is equal

◆ operator=() [1/2]

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

move operator

Parameters

other the object to move

Returns: Assignment&

◆ operator=() [2/2]

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

copy operator

Parameters

other the object to copy

Returns: Assignment&

◆ operator==()

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

equality operator

Parameters

other the other object to compare

Returns: true is equal; false is not equal

◆ setAsConstValue()

void ddl::mapping::datamodel::Assignment::setAsConstValue ( const ConstValue & const_value )

Set as const value assignment.

the type will be set to Type::const_value

Parameters

const_value the const value to set

Remarks: This change is observable, the additional_info is set to "values"!

◆ setAsFunctionCall() [1/2]

void ddl::mapping::datamodel::Assignment::setAsFunctionCall ( const FunctionCall & function_call )

Set as function call assignment.

The assignment will lead into a call of the given function instance instance. The type will be set to Type::function_call The target value is set as kind of:

to_target_value = function_name(param1, param2)

Parameters

function_call the function call value to set

Remarks: This change is observable, the additional_info is set to "values"!

◆ setAsFunctionCall() [2/2]

void ddl::mapping::datamodel::Assignment::setAsFunctionCall	(	const FunctionCall &	module_call,
		const std::vector< ParameterValue > &	parameter_values )

Set as module call assignment and the parameters to use for the function.

The assignment will lead into a call of the given function within the given module instance with the given parameter_values The type will be set to Type::function_call

Parameters

module_call	the module call value to set
parameter_values	the module call parameters to set

Remarks: This change is observable, the additional_info is set to "values" and may also lead into parameters added/removed events!

◆ setAsSourceValue()

void ddl::mapping::datamodel::Assignment::setAsSourceValue ( const SourceValue & source_value )

Set as source value assignment.

the type will be set to Type::source_value

Parameters

source_value the source value to set

Remarks: This change is observable, the additional_info is set to "values"!

◆ setTo()

void ddl::mapping::datamodel::Assignment::setTo ( const std::string & to )

Set the assignment value to assign to.

Parameters

to	the name of the assignment value

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

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ Assignment() [1/5]

◆ Assignment() [2/5]

◆ Assignment() [3/5]

◆ Assignment() [4/5]

◆ Assignment() [5/5]

Member Function Documentation

◆ getConstValue()

◆ getFunctionCall()

◆ getName()

◆ getParameterValues() [1/2]

◆ getParameterValues() [2/2]

◆ getSourceValue()

◆ getTo()

◆ getType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ setAsConstValue()

◆ setAsFunctionCall() [1/2]

◆ setAsFunctionCall() [2/2]

◆ setAsSourceValue()

◆ setTo()