MapHeader

MapHeader contains all information from the header-Tag of a mapping configuration. More...

Public Member Functions
	MapHeader ()
	CTOR.
const std::string &	getDescription () const
	Returns the description from the header tag or an empty string. More...
const std::string &	getDllPaths () const
	Returns the list of dll paths from the "ddl" header tag or an empty string. More...
const std::string &	getLanguageVersion () const
	Returns the version from the language_version-header tag or an empty string. More...
const std::string &	getAuthor () const
	Returns the author from the author-header tag or an empty string. More...
const std::string &	getCreationDate () const
	Returns the date from the date_creation-header tag or an empty string. More...
const std::string &	getModificationDate () const
	Returns the date from the date_change-header tag or an empty string. More...

Private Member Functions
void	reset ()
	Resets the instance to its initial state.
a_util::result::Result	loadFromDOM (const a_util::xml::DOMElement &header, MapErrorList &errors)
	Initializes the header from a header-dom element. More...
a_util::result::Result	writeToDOM (a_util::xml::DOMElement dom_element)
	Export header to a XML dom element. More...
a_util::result::Result	setDescription (const std::string &description)
	Set description. More...
a_util::result::Result	setDdlPaths (const std::string &ddl_paths)
	Set ddl paths. More...
a_util::result::Result	parseVersion (const std::string &version, MapErrorList &lstErrors)
	Parses the language version string. More...

Detailed Description

MapHeader contains all information from the header-Tag of a mapping configuration.

Definition at line 31 of file map_header.h.

Member Function Documentation

getAuthor()

const std::string& getAuthor

(

)

const

Returns the author from the author-header tag or an empty string.

Returns

the author

getCreationDate()

const std::string& getCreationDate

(

)

const

Returns the date from the date_creation-header tag or an empty string.

Returns

the date of creation

getDescription()

const std::string& getDescription

(

)

const

Returns the description from the header tag or an empty string.

Returns

the description

getDllPaths()

const std::string& getDllPaths

(

)

const

Returns the list of dll paths from the "ddl" header tag or an empty string.

Returns

the dll paths

getLanguageVersion()

const std::string& getLanguageVersion

(

)

const

Returns the version from the language_version-header tag or an empty string.

Returns

the language version

getModificationDate()

const std::string& getModificationDate

(

)

const

Returns the date from the date_change-header tag or an empty string.

Returns

the modification date

loadFromDOM()

a_util::result::Result loadFromDOM ( const a_util::xml::DOMElement &  header, MapErrorList &  errors  )

private

Initializes the header from a header-dom element.

Parameters

[in]	header	The dom element from which to import
[out]	errors	The error list for debug

Return values

ERR_INVALID_ARG	Field missing
a_util::result::SUCCESS	Everything went fine

parseVersion()

a_util::result::Result parseVersion ( const std::string &  version, MapErrorList &  lstErrors  )

private

Parses the language version string.

Parameters

[in]	version_string	The version string
[out]	minor_version	The parsed minor version if conversion was successful
[out]	major_version	The parsed major version if conversion was successful
[out]	errors	The error list for debug

Return values

a_util::result::SUCCESS

Everything went fine

setDdlPaths()

a_util::result::Result setDdlPaths ( const std::string &  ddl_paths )

private

Set ddl paths.

Parameters

[in]

ddl_paths

The string containing ddl paths

Return values

a_util::result::SUCCESS

Everything went fine

setDescription()

a_util::result::Result setDescription ( const std::string &  description )

private

Set description.

Parameters

[in]

description

The description

Return values

a_util::result::SUCCESS

Everything went fine

writeToDOM()

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

private

Export header to a XML dom element.

Parameters

[out]

dom_element

The dom element to be written

Return values

a_util::result::SUCCESS

Everything went fine