inicpp::option_schema Class Reference

#include <option_schema.h>

Public Member Functions
	option_schema ()=delete
	option_schema (const option_schema &source)
option_schema &	operator= (const option_schema &source)
	option_schema (option_schema &&source)
option_schema &	operator= (option_schema &&source)
template<typename ArgType >
	option_schema (const option_schema_params< ArgType > &arguments)
const std::string &	get_name () const
option_type	get_type () const
bool	is_list () const
const std::string &	get_default_value () const
bool	is_mandatory () const
const std::string &	get_comment () const
void	validate_option (option &opt) const
std::ostream &	write_additional_info (std::ostream &os) const

Friends
INICPP_API friend std::ostream &	operator<< (std::ostream &os, const option_schema &opt_schema)

Detailed Description

In option_schema are defined rules which ini option should fulfil, including its name, type and if option is list or not. Options can be validated against option_schema objects.

Definition at line 66 of file option_schema.h.

Constructor & Destructor Documentation

inicpp::option_schema::option_schema ( )

delete

Deleted default constructor.

inicpp::option_schema::option_schema

(

const option_schema &

source

)

Copy constructor.

Definition at line 6 of file option_schema.cpp.

inicpp::option_schema::option_schema

(

option_schema &&

source

)

Move constructor.

Definition at line 31 of file option_schema.cpp.

template<typename ArgType >

inicpp::option_schema::option_schema ( const option_schema_params< ArgType > &  arguments )

inline

Construct option_schema from given parameters.

Parameters

arguments

creation arguments

Exceptions

invalid_type_exception

if given type is not valid

Definition at line 141 of file option_schema.h.

Member Function Documentation

const std::string & inicpp::option_schema::get_comment

(

)

const

Returns textual description of option.

Returns

constant reference

Definition at line 70 of file option_schema.cpp.

const std::string & inicpp::option_schema::get_default_value

(

)

const

Get option default value.

Returns

constant reference

Definition at line 60 of file option_schema.cpp.

const std::string & inicpp::option_schema::get_name

(

)

const

Get name of this option.

Returns

constant reference

Definition at line 45 of file option_schema.cpp.

option_type inicpp::option_schema::get_type

(

)

const

Gets type of option.

Returns

option_type structure

Definition at line 50 of file option_schema.cpp.

bool inicpp::option_schema::is_list

(

)

const

Determines if list has to be stored in option.

Returns

true if option should store list

Definition at line 55 of file option_schema.cpp.

bool inicpp::option_schema::is_mandatory

(

)

const

Determines whether option is mandatory in configuration.

Returns

true if option is mandatory and should be in configuration

Definition at line 65 of file option_schema.cpp.

option_schema & inicpp::option_schema::operator=

(

const option_schema &

source

)

Copy assignment.

Definition at line 11 of file option_schema.cpp.

option_schema & inicpp::option_schema::operator=

(

option_schema &&

source

)

Move assignment.

Definition at line 36 of file option_schema.cpp.

void inicpp::option_schema::validate_option

(

option &

opt

)

const

Validate given option against this option_schema.

Parameters

opt	validated option

Exceptions

validation_exception

if error occured

Definition at line 75 of file option_schema.cpp.

std::ostream & inicpp::option_schema::write_additional_info

(

std::ostream &

os

)

const

To given output stream writes additional information about option. Written info is in ini comment format.

Parameters

os	output stream

Returns

reference to output stream for better chaining

Definition at line 154 of file option_schema.cpp.

Friends And Related Function Documentation

INICPP_API friend std::ostream& operator<< ( std::ostream &  os, const option_schema &  opt_schema  )

friend

Classic stream operator for printing this instance to output stream.

Parameters

os	output stream
opt_schema	reference to option_schema instance to be written

Returns

reference to output stream which allows chaining

Definition at line 174 of file option_schema.cpp.

---

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

• include/inicpp/option_schema.h
• src/option_schema.cpp