ddl::mapping::MapAssignment Class Reference

#include <map_assignment.h>

Public Member Functions
	MapAssignment ()
	MapAssignment (std::string to)
bool	isValid () const
const std::string &	getFrom () const
const std::string &	getSource () const
a_util::result::Result	connect (const std::string &source_element_path)
const std::string &	getConstant () const
a_util::result::Result	setConstant (const std::string &constant)
const std::string &	getFunction () const
a_util::result::Result	setSimulationTimeFunction ()
a_util::result::Result	setTriggerCounterFunction (const std::string &modulo)
a_util::result::Result	setReceivedFunction (const std::string &source)
const std::string &	getModulo () const
const std::string &	getTo () const
const std::string &	getTransformation () const
a_util::result::Result	setTransformation (const std::string &transformation_name)
a_util::result::Result	removeTransformation ()

Detailed Description

MapAssignment

Constructor & Destructor Documentation

MapAssignment() [1/2]

ddl::mapping::MapAssignment::MapAssignment

(

)

CTOR

MapAssignment() [2/2]

ddl::mapping::MapAssignment::MapAssignment

(

std::string

to

)

CTOR

Parameters

[in]

to

Name of assigned signal or element

Member Function Documentation

connect()

a_util::result::Result ddl::mapping::MapAssignment::connect

(

const std::string &

source_element_path

)

Connects the target element or signal with a source

Parameters

[in]

source_element_path

The complete path to the source element it is constructed with [SignalName].[ElementName]

Return values

ERR_INVALID_ARG	Source is empty
a_util::result::SUCCESS	Everything went fine

getConstant()

const std::string & ddl::mapping::MapAssignment::getConstant

(

)

const

Returns the constant of the assignment (or an empty string)

getFrom()

const std::string & ddl::mapping::MapAssignment::getFrom

(

)

const

Returns the source element name of the assignment (or an empty string)

Returns

the from name

getFunction()

const std::string & ddl::mapping::MapAssignment::getFunction

(

)

const

Returns the constant of the assignment (or an empty string)

getModulo()

const std::string & ddl::mapping::MapAssignment::getModulo

(

)

const

Returns the constant of the assignment (or an empty string)

getSource()

const std::string & ddl::mapping::MapAssignment::getSource

(

)

const

Returns the source name of the assignment (or an empty string)

getTo()

const std::string & ddl::mapping::MapAssignment::getTo

(

)

const

Returns the name of the target element that is assigned

getTransformation()

const std::string & ddl::mapping::MapAssignment::getTransformation

(

)

const

Returns the associated transformation of this assignment (or an empty string)

isValid()

bool ddl::mapping::MapAssignment::isValid

(

)

const

Returns the validity for the current description

removeTransformation()

a_util::result::Result ddl::mapping::MapAssignment::removeTransformation

(

)

Remove the transformation from this assignment

Return values

a_util::result::SUCCESS

Everything went fine

setConstant()

a_util::result::Result ddl::mapping::MapAssignment::setConstant

(

const std::string &

constant

)

Setter for the constant of the assignment

Parameters

[in]

constant

The constant to assign

Return values

ERR_INVALID_ARG	Constant is empty
a_util::result::SUCCESS	Everything went fine

setReceivedFunction()

a_util::result::Result ddl::mapping::MapAssignment::setReceivedFunction

(

const std::string &

source

)

Setter for the Received assignment

Parameters

[in]

source

The name of the source to consider

Return values

ERR_INVALID_ARG	Source is empty
a_util::result::SUCCESS	Everything went fine

setSimulationTimeFunction()

a_util::result::Result ddl::mapping::MapAssignment::setSimulationTimeFunction

(

)

Setter for the SimulationTime assignment

Return values

a_util::result::SUCCESS

Everything went fine

setTransformation()

a_util::result::Result ddl::mapping::MapAssignment::setTransformation

(

const std::string &

transformation_name

)

Associates the transformation to this assignment

Parameters

[in]

transformation_name

The name of the transformation to add

Return values

ERR_INVALID_ARG	Source or from is empty (no signal connected)
a_util::result::SUCCESS	Everything went fine

setTriggerCounterFunction()

a_util::result::Result ddl::mapping::MapAssignment::setTriggerCounterFunction

(

const std::string &

modulo

)

Setter for the TriggerCounter assignment

Parameters

[in]

modulo

The modulo for the function it represents the maximal value that can be assigned before going back to 0 if left empty, the limit will be the maximal value of Float64

Return values

a_util::result::SUCCESS

Everything went fine

---

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/legacy/configuration/map_assignment.h