Dev Essential
Loading...
Searching...
No Matches
ddl::mapping::rt::TargetElement Class Reference

TargetElement represents a single signal element in the target. More...

#include <element.h>

Public Member Functions

 TargetElement (Target *target)
 
 ~TargetElement ()
 
a_util::result::Result create (void *element_ptr, const ddl::dd::StructElementAccess &element_access, const size_t array_size, const std::string &element_name)
 
a_util::result::Result setTransformation (const MapTransformationBase *transformation)
 
a_util::result::Result setDefaultValue (const std::string &default_value)
 
a_util::result::Result setValue (const void *data, uint32_t src_type, size_t mem_size)
 
TargetgetTarget ()
 

Detailed Description

TargetElement represents a single signal element in the target.

Constructor & Destructor Documentation

◆ TargetElement()

ddl::mapping::rt::TargetElement::TargetElement ( Target * target)

CTOR

Parameters
[in]targetThe target containing this element

◆ ~TargetElement()

ddl::mapping::rt::TargetElement::~TargetElement ( )

DTOR

Member Function Documentation

◆ create()

a_util::result::Result ddl::mapping::rt::TargetElement::create ( void * element_ptr,
const ddl::dd::StructElementAccess & element_access,
const size_t array_size,
const std::string & element_name )

Creation method to initialize the object

Parameters
[in]element_ptrThe Pointer referencing the element in target buffer
[in]element_accessThe element access type
[in]array_sizeThe array size of the element
[in]element_nameThe name of the element in Assignment, for debug only
Returns
Standard result

◆ getTarget()

Target * ddl::mapping::rt::TargetElement::getTarget ( )

Getter for the parent target reference

Returns
The target

◆ setDefaultValue()

a_util::result::Result ddl::mapping::rt::TargetElement::setDefaultValue ( const std::string & default_value)

Method to give a default value to the element

Parameters
[in]default_valueThe default value as a string
Returns
Standard result

◆ setTransformation()

a_util::result::Result ddl::mapping::rt::TargetElement::setTransformation ( const MapTransformationBase * transformation)

Setter for transformation Write constant from Mapping or default value from DataDefinition or 0

Parameters
[in]transformationThe transformation to apply for to element
Returns
Standard result

◆ setValue()

a_util::result::Result ddl::mapping::rt::TargetElement::setValue ( const void * data,
uint32_t src_type,
size_t mem_size )

Setter value to the element

Parameters
[in]dataThe pointer referencing the source buffer
[in]src_typeThe datatype of the source element
[in]mem_sizeThe size of the source buffer
Returns
Standard result

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