PropertiesRegistry Class Reference

PropertiesRegistry. More...

#include <PropertiesRegistry.h>

Public Member Functions
int8_t	createProperty (const std::string &propertyName, const std::string &propertyValue)
	Create a property with the given name (key) and value.
int8_t	queryProperty (const std::string &propertyName, std::string &result)
	Get the Property value corresponding to the given key.
int8_t	modifyProperty (const std::string &propertyName, const std::string &propertyValue)
	Modify the value of the property with the given name.
int8_t	deleteProperty (const std::string &propertyName)
	Delete the Property with the given name (key)

Detailed Description

PropertiesRegistry.

Stores and manages all the properties parsed from the Properties Config files.

Definition at line 16 of file PropertiesRegistry.h.

Member Function Documentation

createProperty()

int8_t PropertiesRegistry::createProperty	(	const std::string &	propertyName,
		const std::string &	propertyValue
	)

Create a property with the given name (key) and value.

Parameters

propertyName	Property Name or Key
propertyValue	Property Value

Returns

int8_t:

• 1: if the property was successfully created
  
• 0: otherwise

deleteProperty()

int8_t PropertiesRegistry::deleteProperty

(

const std::string &

propertyName

)

Delete the Property with the given name (key)

Parameters

propertyName

Property Name or Key

Returns

int8_t:

• 1: if a property was successfully deleted
  
• 0: otherwise

modifyProperty()

int8_t PropertiesRegistry::modifyProperty	(	const std::string &	propertyName,
		const std::string &	propertyValue
	)

Modify the value of the property with the given name.

Parameters

propertyName	Property Name or Key
propertyValue	New Property Value

Returns

int8_t:

• 1: if a property was successfully modified
  
• 0: otherwise

queryProperty()

int8_t PropertiesRegistry::queryProperty	(	const std::string &	propertyName,
		std::string &	result
	)

Get the Property value corresponding to the given key.

Parameters

propertyName	Property Name or Key
result	If the property exists, the value will be stored in this argument

Returns

int8_t:

• 1: if a property with the given name was found
  
• 0: otherwise

---

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

• Core/Framework/Include/PropertiesRegistry.h