ADTF
Loading...
Searching...
No Matches
ddl::mapping::Mapper Class Referencefinal

The mapper to create the targets from sources. More...

#include <mapper.h>

Classes

struct  ParameterValueDescription
 Assignement Paramter Value Description. More...
 

Public Member Functions

 Mapper ()
 
 ~Mapper ()
 
std::shared_ptr< UpdateableaddSource (std::shared_ptr< Source > source)
 add a source instance
 
void addTarget (std::shared_ptr< Target > target)
 adds a target instance
 
void addFunction (std::shared_ptr< Function > function)
 adds a module instance
 
void addAssignment (const std::string &target_name, const std::string &target_value_name, const std::string &function_name, const std::vector< ParameterValueDescription > &parameter_values)
 adds a assignment call assignment
 
void addAssignment (const std::string &target_name, const std::string &target_value_name, const std::string &source_name, const std::string &source_value_name)
 adds a simple source value to target value assignment
 
void addAssignment (const std::string &target_name, const std::string &target_value_name, const std::string &const_value)
 adds a simple const value to target value assignment
 
std::shared_ptr< SourcegetSource (const std::string_view &source_name) const
 Get the source.
 
std::shared_ptr< TargetgetTarget (const std::string_view &target_name) const
 Get the target.
 
std::shared_ptr< AssignmentTriggergetTargetTrigger (const std::string_view &target_name) const
 Get the Target Trigger.
 
void initialize ()
 initializes the mapper
 
void deinitialize ()
 deintitialzes the mapper
 

Detailed Description

The mapper to create the targets from sources.

Constructor & Destructor Documentation

◆ Mapper()

ddl::mapping::Mapper::Mapper ( )

CTOR

◆ ~Mapper()

ddl::mapping::Mapper::~Mapper ( )

DTOR

Member Function Documentation

◆ addAssignment() [1/3]

void ddl::mapping::Mapper::addAssignment ( const std::string & target_name,
const std::string & target_value_name,
const std::string & const_value )

adds a simple const value to target value assignment

Parameters
target_namethe target name
target_value_namethe value name of the target to assign to
const_valuethe const value to assign

◆ addAssignment() [2/3]

void ddl::mapping::Mapper::addAssignment ( const std::string & target_name,
const std::string & target_value_name,
const std::string & function_name,
const std::vector< ParameterValueDescription > & parameter_values )

adds a assignment call assignment

Parameters
target_namethe target name
target_value_namethe value name of the target to assign to
function_namethe function name to call within modulebool das
parameter_valuesthe parameter value list

◆ addAssignment() [3/3]

void ddl::mapping::Mapper::addAssignment ( const std::string & target_name,
const std::string & target_value_name,
const std::string & source_name,
const std::string & source_value_name )

adds a simple source value to target value assignment

Parameters
target_namethe target name
target_value_namethe value name of the target to assign to
source_namethe source name
source_value_namethe value name of the source to retrieve the value from

◆ getSource()

std::shared_ptr< Source > ddl::mapping::Mapper::getSource ( const std::string_view & source_name) const

Get the source.

Parameters
source_namethe name of the source
Returns
std::shared_ptr<const Source>

◆ getTarget()

std::shared_ptr< Target > ddl::mapping::Mapper::getTarget ( const std::string_view & target_name) const

Get the target.

Parameters
target_namethe name of the target
Returns
std::shared_ptr<Target>

◆ getTargetTrigger()

std::shared_ptr< AssignmentTrigger > ddl::mapping::Mapper::getTargetTrigger ( const std::string_view & target_name) const

Get the Target Trigger.

Parameters
target_namethe name of the target
Returns
std::shared_ptr<AssignmentTrigger>

The documentation for this class was generated from the following file: