MapSource

MapSource represents a mapping source from the configuration file. More...

Public Member Functions
	MapSource (MapConfiguration *config)
	CTOR.
	MapSource (MapConfiguration *config, std::string name, std::string type)
	CTOR. More...
const std::string &	getName () const
	Returns the name of the mapping source.
a_util::result::Result	setName (const std::string &new_name)
	Set name. More...
const std::string &	getType () const
	Returns the DataDefinition typename of the mapping source.
a_util::result::Result	setType (const std::string &type_name)
	Set type. More...
bool	isValid () const
	Returns the validity for the current description.

Private Member Functions
a_util::result::Result	loadFromDOM (const a_util::xml::DOMElement &source)
	Initializes the source from a source-dom element. More...
a_util::result::Result	writeToDOM (a_util::xml::DOMElement &dom_element) const
	Export source to a XML dom element. More...

Detailed Description

MapSource represents a mapping source from the configuration file.

Definition at line 31 of file map_source.h.

Constructor & Destructor Documentation

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

loadFromDOM()

a_util::result::Result loadFromDOM ( const a_util::xml::DOMElement &  source )

private

Initializes the source from a source-dom element.

Parameters

[in]

source

The dom element from which to import

Return values

ERR_INVALID_ARG	Missing name or type
a_util::result::SUCCESS	Everything went fine

setName()

a_util::result::Result 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 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

writeToDOM()

a_util::result::Result writeToDOM ( a_util::xml::DOMElement &  dom_element ) const

private

Export source to a XML dom element.

Parameters

[in]

dom_element

The dom element to be written

Return values

a_util::result::SUCCESS

Everything went fine