Datamodel assignment class used in Target.
More...
#include <datamodel_configuration_items.h>
Inherits ddl::utility::TypeAccessListSubject< Assignment >, and ddl::dd::datamodel::InfoMap.
Datamodel assignment class used in Target.
◆ Type
the type of the assignment
◆ Assignment() [1/5]
| ddl::mapping::datamodel::Assignment::Assignment |
( |
const Assignment & | other | ) |
|
◆ Assignment() [2/5]
| ddl::mapping::datamodel::Assignment::Assignment |
( |
Assignment && | other | ) |
|
◆ 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 |
◆ getConstValue()
| ConstValue ddl::mapping::datamodel::Assignment::getConstValue |
( |
| ) |
const |
◆ getFunctionCall()
| FunctionCall ddl::mapping::datamodel::Assignment::getFunctionCall |
( |
| ) |
const |
◆ 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 |
( |
| ) |
|
◆ getParameterValues() [2/2]
| const ParameterValues & ddl::mapping::datamodel::Assignment::getParameterValues |
( |
| ) |
const |
◆ getSourceValue()
| SourceValue ddl::mapping::datamodel::Assignment::getSourceValue |
( |
| ) |
const |
◆ 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 |
◆ 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]
move operator, which assigns like the copy operator
- Parameters
-
- Returns
- Assignment&
- Exceptions
-
| ddl::dd::Error | if the assignment is in a list that has another item of the name |
◆ operator=() [2/2]
copy operator
Assigns the values through the setters, so an owning list is notified of each change like for the setters. The name is assigned first with setTo, and if the list refuses it, the assignment stays unchanged.
- Parameters
-
- Returns
- Assignment&
- Exceptions
-
| ddl::dd::Error | if the assignment is in a list that has another item of the name |
◆ 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 |
◆ 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 |
◆ 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 |
◆ 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 |
◆ 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: