schema_validation::class_key Class Reference

class_key is used to save the information about one key. More...

#include <tag.hpp>

Public Member Functions
	class_key ()
	class_key (const std::string &name, const std::string &type, const std::string &def="\"\"")
	class_key (const config &)
const std::string &	get_name () const
const std::string &	get_type () const
const std::string &	get_default () const
bool	is_mandatory () const
void	set_name (const std::string &name)
void	set_type (const std::string &type)
void	set_default (const std::string &def)
void	set_mandatory (bool mandatory)
void	print (std::ostream &os, int level) const
	is used to print key info the format is next [key] name="name" type="type" default="default" mandatory="true/false" [/key] More...
bool	operator< (const class_key &k) const
	Compares keys by name. More...

Private Attributes
std::string	name_
	Name of key. More...
std::string	type_
	Type of key. More...
std::string	default_
	Default value. More...
bool	mandatory_
	Shows, if key is a mandatory key. More...

Detailed Description

class_key is used to save the information about one key.

Key has next info: name, type, default value or key is mandatory.

Definition at line 37 of file tag.hpp.

Constructor & Destructor Documentation

schema_validation::class_key::class_key ( )

inline

Definition at line 39 of file tag.hpp.

schema_validation::class_key::class_key ( const std::string &  name, const std::string &  type, const std::string &  def = "\"\""  )

inline

Definition at line 41 of file tag.hpp.

schema_validation::class_key::class_key

(

const config &

cfg

)

Definition at line 39 of file tag.cpp.

References default_, config::has_attribute(), and mandatory_.

Member Function Documentation

const std::string& schema_validation::class_key::get_default ( ) const

inline

Definition at line 58 of file tag.hpp.

References default_.

const std::string& schema_validation::class_key::get_name ( ) const

inline

Definition at line 52 of file tag.hpp.

References name_.

Referenced by schema_validation::class_tag::add_key(), and operator<().

const std::string& schema_validation::class_key::get_type ( ) const

inline

Definition at line 55 of file tag.hpp.

References type_.

Referenced by schema_validation::schema_validator::validate_key().

bool schema_validation::class_key::is_mandatory ( ) const

inline

Definition at line 61 of file tag.hpp.

References mandatory_.

Referenced by print().

bool schema_validation::class_key::operator< ( const class_key &  k ) const

inline

Compares keys by name.

Used in std::sort, i.e.

Definition at line 94 of file tag.hpp.

References get_name().

void schema_validation::class_key::print	(	std::ostream &	os,
		int	level
	)		const

is used to print key info the format is next [key] name="name" type="type" default="default" mandatory="true/false" [/key]

Definition at line 53 of file tag.cpp.

References default_, is_mandatory(), name_, and type_.

void schema_validation::class_key::set_default ( const std::string &  def )

inline

Definition at line 71 of file tag.hpp.

References default_, and mandatory_.

void schema_validation::class_key::set_mandatory ( bool  mandatory )

inline

Definition at line 77 of file tag.hpp.

References mandatory_.

void schema_validation::class_key::set_name ( const std::string &  name )

inline

Definition at line 65 of file tag.hpp.

References name_.

void schema_validation::class_key::set_type ( const std::string &  type )

inline

Definition at line 68 of file tag.hpp.

References type_.

Member Data Documentation

std::string schema_validation::class_key::default_

private

Default value.

Definition at line 103 of file tag.hpp.

Referenced by class_key(), get_default(), print(), and set_default().

bool schema_validation::class_key::mandatory_

private

Shows, if key is a mandatory key.

Definition at line 105 of file tag.hpp.

Referenced by class_key(), is_mandatory(), set_default(), and set_mandatory().

std::string schema_validation::class_key::name_

private

Name of key.

Definition at line 99 of file tag.hpp.

Referenced by get_name(), print(), and set_name().

std::string schema_validation::class_key::type_

private

Type of key.

Definition at line 101 of file tag.hpp.

Referenced by get_type(), print(), and set_type().

---

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

• tools/schema/tag.hpp
• tools/schema/tag.cpp