Libpf::Persistency::IntegerOption Struct Reference

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

#include <TypeDescriptor.h>

Public Member Functions

 IntegerOption (const std::string &name, const std::string &description, int value, int min, int max)
 
 IntegerOption (void)
 
 ~IntegerOption (void)
 
std::string json (void) const
 

Public Attributes

std::string name_
 UTF-8 encoded string. More...
 
std::string description_
 UTF-8 encoded string. More...
 
int value_
 default value More...
 
int min_
 minimum value (inclusive) More...
 
int max_
 maximum value (inclusive) More...
 

Detailed Description

To define the supported integer options within a TypeDescriptor.

See also
TypeDescriptor

Constructor & Destructor Documentation

◆ IntegerOption() [1/2]

Libpf::Persistency::IntegerOption::IntegerOption ( const std::string &  name,
const std::string &  description,
int  value,
int  min,
int  max 
)

◆ IntegerOption() [2/2]

Libpf::Persistency::IntegerOption::IntegerOption ( void  )

◆ ~IntegerOption()

Libpf::Persistency::IntegerOption::~IntegerOption ( void  )

Member Function Documentation

◆ json()

std::string Libpf::Persistency::IntegerOption::json ( void  ) const
Returns
UTF-8 encoded string with the JSON-serialized object

Member Data Documentation

◆ description_

std::string Libpf::Persistency::IntegerOption::description_

UTF-8 encoded string.

◆ max_

int Libpf::Persistency::IntegerOption::max_

maximum value (inclusive)

◆ min_

int Libpf::Persistency::IntegerOption::min_

minimum value (inclusive)

◆ name_

std::string Libpf::Persistency::IntegerOption::name_

UTF-8 encoded string.

◆ value_

int Libpf::Persistency::IntegerOption::value_

default value


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