cpplocate::ModuleInfo Class Reference

#include <C:/Coding-Space/git-repos/cpplocate/source/cpplocate/include/cpplocate/ModuleInfo.h>

Public Member Functions
	ModuleInfo ()
	ModuleInfo (const ModuleInfo &rh)
	ModuleInfo (ModuleInfo &&rh)
	~ModuleInfo ()
ModuleInfo &	operator= (const ModuleInfo &rh)
ModuleInfo &	operator= (ModuleInfo &&rh)
bool	load (const std::string &filename)
bool	save (const std::string &filename) const
void	clear ()
bool	empty () const
const std::map< std::string, std::string > &	values () const
std::string	value (const std::string &key, const std::string &defaultValue="") const
const std::string &	value (const std::string &key, std::string &defaultValue) const
void	setValue (const std::string &key, const std::string &value)
void	setValue (std::string &&key, std::string &&value)
void	print () const
void	print (std::ostream &stream) const

Detailed Description

Description of a module, containing key/value pairs.

Constructor & Destructor Documentation

cpplocate::ModuleInfo::ModuleInfo

(

)

Constructor.

cpplocate::ModuleInfo::ModuleInfo

(

const ModuleInfo &

rh

)

Copy constructor.

Parameters

[in]

rh

Right-hand value to copy

cpplocate::ModuleInfo::ModuleInfo

(

ModuleInfo &&

rh

)

Move constructor.

Parameters

[in]

rh

Right-hand value to move

cpplocate::ModuleInfo::~ModuleInfo

(

)

Destructor.

Member Function Documentation

ModuleInfo& cpplocate::ModuleInfo::operator=

(

const ModuleInfo &

rh

)

Copy assignment operator.

Parameters

[in]

rh

Right-hand value to copy

Returns

Reference to this value

ModuleInfo& cpplocate::ModuleInfo::operator=

(

ModuleInfo &&

rh

)

Move assignment operator.

Parameters

[in]

rh

Right-hand value to move

Returns

Reference to this value

bool cpplocate::ModuleInfo::load

(

const std::string &

filename

)

Load module information from file.

Parameters

[in]

filename

Filename

Returns

'true' if module information file could be loaded, 'false' on error

bool cpplocate::ModuleInfo::save

(

const std::string &

filename

)

const

Save module information to file.

Parameters

[in]

filename

Filename

Returns

'true' if module information file could be written, 'false' on error

void cpplocate::ModuleInfo::clear

(

)

Clear module info.

bool cpplocate::ModuleInfo::empty

(

)

const

Check if module info is empty.

Returns

'true' if empty, else 'false'

const std::map<std::string, std::string>& cpplocate::ModuleInfo::values

(

)

const

Get key/value map.

Returns

Map

std::string cpplocate::ModuleInfo::value	(	const std::string &	key,
		const std::string &	defaultValue = ""
	)		const

Get value.

Parameters

[in]	key	Key name
[in]	defaultValue	Default value

Returns

Value, if the specified key does not exist, defaultValue is returned

const std::string& cpplocate::ModuleInfo::value	(	const std::string &	key,
		std::string &	defaultValue
	)		const

Get value.

Parameters

[in]	key	Key name
[in]	defaultValue	Default value

Returns

Value, if the specified key does not exist, defaultValue is returned

void cpplocate::ModuleInfo::setValue	(	const std::string &	key,
		const std::string &	value
	)

Set value.

Parameters

[in]

key

Key name Value

void cpplocate::ModuleInfo::setValue	(	std::string &&	key,
		std::string &&	value
	)

Set value.

Parameters

[in]

key

Key name Value

void cpplocate::ModuleInfo::print

(

)

const

Print module info to the console.

void cpplocate::ModuleInfo::print

(

std::ostream &

stream

)

const

Print module info to stream.

Parameters

[in]

stream

The stream to print to

---

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

• ModuleInfo.h