ddl::mapping::MapSource Class Reference

#include <map_source.h>

Public Member Functions
	MapSource (MapConfiguration *config)
	MapSource (MapConfiguration *config, std::string name, std::string type)
const std::string &	getName () const
a_util::result::Result	setName (const std::string &new_name)
const std::string &	getType () const
a_util::result::Result	setType (const std::string &type_name)
bool	isValid () const

Detailed Description

MapSource represents a mapping source from the configuration file

Constructor & Destructor Documentation

MapSource() [1/2]

ddl::mapping::MapSource::MapSource

(

MapConfiguration *

config

)

CTOR

MapSource() [2/2]

ddl::mapping::MapSource::MapSource	(	MapConfiguration *	config,
		std::string	name,
		std::string	type )

CTOR

Parameters

[in]	name	signal name
[in]	type	signal type
[in]	config	the config

Member Function Documentation

getName()

const std::string & ddl::mapping::MapSource::getName

(

)

const

Returns the name of the mapping source

getType()

const std::string & ddl::mapping::MapSource::getType

(

)

const

Returns the DataDefinition typename of the mapping source

isValid()

bool ddl::mapping::MapSource::isValid

(

)

const

Returns the validity for the current description

setName()

a_util::result::Result ddl::mapping::MapSource::setName

(

const std::string &

new_name

)

Set name

Parameters

[in]

new_name

The new name of the target

Return values

ERR_INVALID_STATE	No description found
ERR_INVALID_ARG	Signal name already used in configuration
a_util::result::SUCCESS	Everything went fine

setType()

a_util::result::Result ddl::mapping::MapSource::setType

(

const std::string &

type_name

)

Set type

Parameters

[in]

type_name

The type of the target

Return values

ERR_INVALID_STATE	No description found
ERR_INVALID_ARG	Signal name already used in configuration
ERR_INVALID_TYPE	Inconsistency with ddl
a_util::result::SUCCESS	Everything went fine

---

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

• include/ddl/mapping/legacy/configuration/map_source.h