MPropertiesMap Class Reference

Class holding a set of properties of a MJob. More...

Public Types
enum	kItemModifiedStatus { kNotModified = 0, kModified = 1, kNew = 2 }
	Enumerates the modification status of an item in the properties map. More...

Public Member Functions
void	clear ()
bool	getBool (const char *key, bool &dest, bool *state=0)
bool	getFloat (const char *key, float &dest, bool *state=0)
bool	getInt (const char *key, int &dest, bool *state=0)
bool	getInt64 (const char *key, long long int &dest, bool *state=0)
std::vector< std::string >	getKeys ()
bool	getLong (const char *key, long &dest, bool *state=0)
itemAttributesMap &	getMap ()
size_t	getSize ()
bool	getString (const char *key, std::string &dest, bool *state=0, bool *subst=0)
std::string	getString (const char *key)
bool	getTimet (const char *key, time_t &dest, bool *state=0)
bool	isEmpty ()
bool	isEnabled (const char *key)
	MPropertiesMap ()
bool	removeKey (const char *key)
void	setBool (const char *key, bool value, bool state=true, bool notModified=false)
void	setFloat (const char *key, float value, bool state=true, bool notModified=false)
void	setInt (const char *key, int value, bool state=true, bool notModified=false)
void	setInt64 (const char *key, long long int value, bool state=true, bool notModified=false)
void	setLong (const char *key, long value, bool state=true, bool notModified=false)
void	setString (const char *key, std::string value, bool state=true, bool subst=false, bool notModified=false)
void	setTimet (const char *key, time_t *value, bool state=true, bool notModified=false)
	~MPropertiesMap ()

Detailed Description

Class holding a set of properties of a MJob.

Definition at line 65 of file MProperties.h.

Member Enumeration Documentation

enum kItemModifiedStatus

Enumerates the modification status of an item in the properties map.

Enumerator
kNotModified	Item is not modified
kModified	Item is modified
kNew	Item is new

Definition at line 73 of file MProperties.h.

Constructor & Destructor Documentation

MPropertiesMap

(

)

Default constructor. It creates an empty MPropertiesMap

~MPropertiesMap

(

)

Default destructor

Member Function Documentation

void clear

(

)

Clears the properties map

bool getBool	(	const char *	key,
		bool &	dest,
		bool *	state = 0
	)

Gets a value as a bool

bool getFloat	(	const char *	key,
		float &	dest,
		bool *	state = 0
	)

Gets a value as a float

bool getInt	(	const char *	key,
		int &	dest,
		bool *	state = 0
	)

Gets a value as an int

bool getInt64	(	const char *	key,
		long long int &	dest,
		bool *	state = 0
	)

Gets a value as an long long int

std::vector<std::string> getKeys

(

)

Gets a vector of all the keys inside the properties map

bool getLong	(	const char *	key,
		long &	dest,
		bool *	state = 0
	)

Gets a value as a long

itemAttributesMap& getMap

(

)

Gets the inner std::map as an itemAttributesMap type

size_t getSize

(

)

Gets the amount of elements inside the properties map

bool getString	(	const char *	key,
		std::string &	dest,
		bool *	state = 0,
		bool *	subst = 0
	)

Gets a value as a string

std::string getString

(

const char *

key

)

Gets the value as a string, do not check for validity

bool getTimet	(	const char *	key,
		time_t &	dest,
		bool *	state = 0
	)

Gets a value as a time_t

bool isEmpty

(

)

Returns true if the properties map is empty

bool isEnabled

(

const char *

key

)

Returns true is the value exists and is enabled

bool removeKey

(

const char *

key

)

Remove a specific key from the properties map

void setBool	(	const char *	key,
		bool	value,
		bool	state = true,
		bool	notModified = false
	)

Sets a value with a bool

void setFloat	(	const char *	key,
		float	value,
		bool	state = true,
		bool	notModified = false
	)

Sets a value with a float

void setInt	(	const char *	key,
		int	value,
		bool	state = true,
		bool	notModified = false
	)

Sets a value with an int

void setInt64	(	const char *	key,
		long long int	value,
		bool	state = true,
		bool	notModified = false
	)

Sets a value with a long long int

void setLong	(	const char *	key,
		long	value,
		bool	state = true,
		bool	notModified = false
	)

Sets a value with a long

void setString	(	const char *	key,
		std::string	value,
		bool	state = true,
		bool	subst = false,
		bool	notModified = false
	)

Sets a value with a string

void setTimet	(	const char *	key,
		time_t *	value,
		bool	state = true,
		bool	notModified = false
	)

Sets a value with a time_t

---

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

• MClientLib/MProperties.h