Dev Essential  1.6.3
Loading...
Searching...
No Matches
ddl::mapping::MapEnumTableTransformation Class Reference

MapEnumTableTransformation represents a transformation between to enumerations. More...

#include <map_transformation.h>

Inherits ddl::mapping::MapTransformationBase.

Public Types

using ConversionMap = std::map<int64_t, int64_t>
 Alias for the conversion map.
 

Public Member Functions

 MapEnumTableTransformation (MapConfiguration *config, const std::string &name)
 
const std::string & getEnumFrom () const
 
const std::string & getEnumTo () const
 
a_util::result::Result setEnums (const std::string &enum_from, const std::string &enum_to)
 
int64_t getDefault () const
 
std::string getDefaultStr () const
 
a_util::result::Result setDefault (const std::string &default_value)
 
const ConversionMapgetConversions () const
 
const std::map< std::string, std::string > & getConversionsStr () const
 
a_util::result::Result addConversion (const std::string &from, const std::string &to)
 
a_util::result::Result removeConversion (const std::string &from)
 
bool isEqual (const MapTransformationBase &other) const
 
double evaluate (double value) const
 
MapTransformationBaseclone () const
 nodoc
 
- Public Member Functions inherited from ddl::mapping::MapTransformationBase
 MapTransformationBase (MapConfiguration *config, const std::string &name)
 
virtual ~MapTransformationBase ()
 
const std::string & getName () const
 
bool isValid () const
 

Friends

class MapTransformationBase
 

Detailed Description

MapEnumTableTransformation represents a transformation between to enumerations.

Constructor & Destructor Documentation

◆ MapEnumTableTransformation()

ddl::mapping::MapEnumTableTransformation::MapEnumTableTransformation ( MapConfiguration * config,
const std::string & name )

CTOR

Parameters
[in]configThe configuration
[in]nameThe transformation name

Member Function Documentation

◆ addConversion()

a_util::result::Result ddl::mapping::MapEnumTableTransformation::addConversion ( const std::string & from,
const std::string & to )

Add a conversion as string

Parameters
[in]fromstring for source value
[in]tostring for target value
Return values
a_util::result::SUCCESSEverything went fine

◆ clone()

MapTransformationBase * ddl::mapping::MapEnumTableTransformation::clone ( ) const
virtual

◆ evaluate()

double ddl::mapping::MapEnumTableTransformation::evaluate ( double value) const
virtual

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Implements ddl::mapping::MapTransformationBase.

◆ getConversions()

const ConversionMap & ddl::mapping::MapEnumTableTransformation::getConversions ( ) const

Returns conversion list

◆ getConversionsStr()

const std::map< std::string, std::string > & ddl::mapping::MapEnumTableTransformation::getConversionsStr ( ) const

Returns conversion list as string

◆ getDefault()

int64_t ddl::mapping::MapEnumTableTransformation::getDefault ( ) const

Returns default value

◆ getDefaultStr()

std::string ddl::mapping::MapEnumTableTransformation::getDefaultStr ( ) const

Returns default value as string

◆ getEnumFrom()

const std::string & ddl::mapping::MapEnumTableTransformation::getEnumFrom ( ) const

Returns the name of the source enumeration

◆ getEnumTo()

const std::string & ddl::mapping::MapEnumTableTransformation::getEnumTo ( ) const

Returns the name of the target enumeration

◆ isEqual()

bool ddl::mapping::MapEnumTableTransformation::isEqual ( const MapTransformationBase & other) const
virtual

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Implements ddl::mapping::MapTransformationBase.

◆ removeConversion()

a_util::result::Result ddl::mapping::MapEnumTableTransformation::removeConversion ( const std::string & from)

Remove a conversion as string

Parameters
[in]fromstring for source value
Return values
a_util::result::SUCCESSEverything went fine

◆ setDefault()

a_util::result::Result ddl::mapping::MapEnumTableTransformation::setDefault ( const std::string & default_value)

Set default value as string

Parameters
[in]default_valuestring for default value
Return values
a_util::result::SUCCESSEverything went fine

◆ setEnums()

a_util::result::Result ddl::mapping::MapEnumTableTransformation::setEnums ( const std::string & enum_from,
const std::string & enum_to )

Set the name of the target and source enumerations

Parameters
[in]enum_frominput enumeration name
[in]enum_tooutput enumeration name
Return values
ERR_INVALID_TYPEEnums not found in ddl
a_util::result::SUCCESSEverything went fine

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