eproperty::InterfaceData Class Reference

#include <InterfaceData.hpp>

Public Member Functions
	InterfaceData ()
virtual	~InterfaceData ()
void	add (Property *_pointerOnProperty)
void	clean ()
bool	set (const std::string &_property, const std::string &_value)
std::string	get (const std::string &_property) const
void	display (bool _changeOnly=false) const
std::map< std::string, std::string >	getAll (bool _notIfDefault=true) const
size_t	size () const
eproperty::Property *	getRaw (const size_t &_id) const
eproperty::Property *	getRaw (const std::string _name) const

Detailed Description

Interface data to collect the property list (for abstarction connection)

Constructor & Destructor Documentation

InterfaceData()

eproperty::InterfaceData::InterfaceData

(

)

Constructor.

~InterfaceData()

virtual eproperty::InterfaceData::~InterfaceData ( )

virtual

Destructor.

Member Function Documentation

add()

void eproperty::InterfaceData::add

(

Property *

_pointerOnProperty

)

Register a property class pointer in the List of propertys.

Note

This class does not destroy the property pointer!!!

Parameters

[in]

_pointerOnProperty

Pointer on the property that might be added.

clean()

void eproperty::InterfaceData::clean

(

)

Remove all the property reference in this class.

Note

no delete, just clean and inform that a property has not been removed.

display()

void eproperty::InterfaceData::display

(

bool

_changeOnly = false

)

const

Display all the property value with there name.

Parameters

[in]

_changeOnly

check at true if the user want to display only property that are not at default value.

get()

std::string eproperty::InterfaceData::get

(

const std::string &

_property

)

const

Get a specific value of the property reference name.

Parameters

[in]

_property

The property string name.

Returns

The value of the property (string).

getAll()

std::map<std::string, std::string> eproperty::InterfaceData::getAll

(

bool

_notIfDefault = true

)

const

Get All the property configuration:

Parameters

[in]

_notIfDefault

if true the parameter value with default value are not extracted.

Returns

map on the propertys

getRaw() [1/2]

eproperty::Property* eproperty::InterfaceData::getRaw

(

const size_t &

_id

)

const

Get name of a propertys.

Parameters

[in]

_id

Id of the property.

Returns

pointer on the property.

getRaw() [2/2]

eproperty::Property* eproperty::InterfaceData::getRaw

(

const std::string

_name

)

const

Get name of a propertys.

Parameters

[in]

_name

name of the property.

Returns

pointer on the property.

set()

bool eproperty::InterfaceData::set	(	const std::string &	_property,
		const std::string &	_value
	)

Set a specific value to the property reference name.

Parameters

[in]	_property	The property string name.
[in]	_value	The new value of the property (string).

Returns

true Property update.

false Property not update.

size()

size_t eproperty::InterfaceData::size

(

)

const

Get count of propertys.

Returns

The number of the property.

---

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

• framework/atria-soft/eproperty/eproperty/InterfaceData.hpp