Libpf::Persistency::StringOption Struct Reference

To define the supported string options within a TypeDescriptor. More...

#include <TypeDescriptor.h>

Public Member Functions
	StringOption (const std::string &name, const std::string &description, const std::string &value, const std::string &enumerator)
	StringOption ()
	~StringOption (void)
std::string	json (void) const

Public Attributes
std::string	name_
	UTF-8 encoded string. More...
std::string	description_
	UTF-8 encoded string. More...
std::string	value_
	default value, UTF-8 encoded string More...
std::string	enumerator_
	name of the matching Enumerator, UTF-8 encoded string More...

Detailed Description

To define the supported string options within a TypeDescriptor.

See also

TypeDescriptor

Constructor & Destructor Documentation

StringOption() [1/2]

Libpf::Persistency::StringOption::StringOption	(	const std::string &	name,
		const std::string &	description,
		const std::string &	value,
		const std::string &	enumerator
	)

StringOption() [2/2]

Libpf::Persistency::StringOption::StringOption

(

)

~StringOption()

Libpf::Persistency::StringOption::~StringOption

(

void

)

Member Function Documentation

json()

std::string Libpf::Persistency::StringOption::json

(

void

)

const

Returns

UTF-8 encoded string with the JSON-serialized object

Member Data Documentation

description_

std::string Libpf::Persistency::StringOption::description_

UTF-8 encoded string.

enumerator_

std::string Libpf::Persistency::StringOption::enumerator_

name of the matching Enumerator, UTF-8 encoded string

name_

std::string Libpf::Persistency::StringOption::name_

UTF-8 encoded string.

value_

std::string Libpf::Persistency::StringOption::value_

default value, UTF-8 encoded string

---

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

• TypeDescriptor.h