#include <ptree_fwd.hpp>

Public Types
typedef String::value_type	char_type

typedef Translator::external_type	key_type

Public Member Functions
std::string	dump () const

bool	empty () const
	Test if the path is empty. More...

string_path &	operator/= (const string_path &o)

string_path &	operator= (const string_path &o)

key_type	reduce ()
	Take a single element off the path at the front and return it. More...

char_type	separator () const
	Get the separator used by this path. More...

bool	single () const
	Test if the path contains a single element, i.e. no separators. More...

	string_path (char_type separator=char_type('.'))
	Create an empty path. More...

	string_path (const char_type *value, char_type separator=char_type('.'), Translator tr=Translator())

	string_path (const String &value, char_type separator=char_type('.'), Translator tr=Translator())

	string_path (const string_path &o)

Private Types
typedef String::const_iterator	s_c_iter

typedef String::iterator	s_iter

Private Member Functions
	BOOST_STATIC_ASSERT ((is_same< String, typename Translator::internal_type >::value))

s_c_iter	cstart () const

Private Attributes
char_type	m_separator

s_iter	m_start

Translator	m_tr

String	m_value

Detailed Description

template<typename String, typename Translator>
class boost::property_tree::string_path< String, Translator >

Default path class. A path is a sequence of values. Groups of values are separated by the separator value, which defaults to '.' cast to the sequence's value type. The group of values is then passed to the translator to get a key.

If instantiated with std::string and id_translator<std::string>, it accepts paths of the form "one.two.three.four".

Template Parameters

String	Any Sequence. If the sequence does not support random- access iteration, concatenation of paths assumes that insertions at the end preserve iterator validity.
Translator	A translator with internal_type == String.

Definition at line 36 of file ptree_fwd.hpp.

Member Typedef Documentation

◆ char_type

template<typename String , typename Translator >

typedef String::value_type boost::property_tree::string_path< String, Translator >::char_type

Definition at line 88 of file string_path.hpp.

◆ key_type

template<typename String , typename Translator >

typedef Translator::external_type boost::property_tree::string_path< String, Translator >::key_type

Definition at line 87 of file string_path.hpp.

◆ s_c_iter

template<typename String , typename Translator >

typedef String::const_iterator boost::property_tree::string_path< String, Translator >::s_c_iter

private

Definition at line 156 of file string_path.hpp.

◆ s_iter

template<typename String , typename Translator >

typedef String::iterator boost::property_tree::string_path< String, Translator >::s_iter

private

Definition at line 155 of file string_path.hpp.

Constructor & Destructor Documentation

◆ string_path() [1/4]

template<typename String , typename Translator >

boost::property_tree::string_path< String, Translator >::string_path ( char_type separator = char_type('.') )

inlineexplicit

Create an empty path.

Definition at line 165 of file string_path.hpp.

◆ string_path() [2/4]

template<typename String , typename Translator >

boost::property_tree::string_path< String, Translator >::string_path	(	const String &	value,
		char_type	separator = `char_type('.')`,
		Translator	tr = `Translator()`
	)

inline

Create a path by parsing the given string.

Parameters

value	A sequence, possibly with separators, that describes the path, e.g. "one.two.three".
separator	The separator used in parsing. Defaults to '.'.
tr	The translator used by this path to convert the individual parts to keys.

Definition at line 170 of file string_path.hpp.

◆ string_path() [3/4]

template<typename String , typename Translator >

boost::property_tree::string_path< String, Translator >::string_path	(	const char_type *	value,
		char_type	separator = `char_type('.')`,
		Translator	tr = `Translator()`
	)

inline

Create a path by parsing the given string.

Parameters

value	A zero-terminated array of values. Only use if zero- termination makes sense for your type, and your sequence supports construction from it. Intended for string literals.
separator	The separator used in parsing. Defaults to '.'.
tr	The translator used by this path to convert the individual parts to keys.

Definition at line 178 of file string_path.hpp.

◆ string_path() [4/4]

template<typename String , typename Translator >

boost::property_tree::string_path< String, Translator >::string_path ( const string_path< String, Translator > & o )

inline

Definition at line 186 of file string_path.hpp.

Member Function Documentation

◆ BOOST_STATIC_ASSERT()

template<typename String , typename Translator >

boost::property_tree::string_path< String, Translator >::BOOST_STATIC_ASSERT ( (is_same< String, typename Translator::internal_type >::value) )

private

◆ cstart()

template<typename String , typename Translator >

s_c_iter boost::property_tree::string_path< String, Translator >::cstart ( ) const

inlineprivate

Definition at line 161 of file string_path.hpp.

◆ dump()

template<typename String , typename Translator >

std::string boost::property_tree::string_path< String, Translator >::dump ( ) const

inline

Definition at line 128 of file string_path.hpp.

◆ empty()

template<typename String , typename Translator >

bool boost::property_tree::string_path< String, Translator >::empty

inline

Test if the path is empty.

Definition at line 225 of file string_path.hpp.

◆ operator/=()

template<typename String , typename Translator >

string_path& boost::property_tree::string_path< String, Translator >::operator/= ( const string_path< String, Translator > & o )

inline

Append a second path to this one.

Precondition: o's separator is the same as this one's, or o has no separators

Definition at line 134 of file string_path.hpp.

◆ operator=()

template<typename String , typename Translator >

string_path< String, Translator > & boost::property_tree::string_path< String, Translator >::operator= ( const string_path< String, Translator > & o )

inline

Definition at line 195 of file string_path.hpp.

◆ reduce()

template<typename String , typename Translator >

Translator::external_type boost::property_tree::string_path< String, Translator >::reduce

Take a single element off the path at the front and return it.

Definition at line 206 of file string_path.hpp.

◆ separator()

template<typename String , typename Translator >

char_type boost::property_tree::string_path< String, Translator >::separator ( ) const

inline

Get the separator used by this path.

Definition at line 126 of file string_path.hpp.

◆ single()

template<typename String , typename Translator >

bool boost::property_tree::string_path< String, Translator >::single

inline

Test if the path contains a single element, i.e. no separators.

Definition at line 231 of file string_path.hpp.

Member Data Documentation

◆ m_separator

template<typename String , typename Translator >

char_type boost::property_tree::string_path< String, Translator >::m_separator

private

Definition at line 158 of file string_path.hpp.

◆ m_start

template<typename String , typename Translator >

s_iter boost::property_tree::string_path< String, Translator >::m_start

private

Definition at line 160 of file string_path.hpp.

◆ m_tr

template<typename String , typename Translator >

Translator boost::property_tree::string_path< String, Translator >::m_tr

private

Definition at line 159 of file string_path.hpp.

◆ m_value

template<typename String , typename Translator >

String boost::property_tree::string_path< String, Translator >::m_value

private

Definition at line 157 of file string_path.hpp.

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

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

template<typename String, typename Translator> class boost::property_tree::string_path< String, Translator >

Member Typedef Documentation

◆ char_type

◆ key_type

◆ s_c_iter

◆ s_iter

Constructor & Destructor Documentation

◆ string_path() [1/4]

◆ string_path() [2/4]

◆ string_path() [3/4]

◆ string_path() [4/4]

Member Function Documentation

◆ BOOST_STATIC_ASSERT()

◆ cstart()

◆ dump()

◆ empty()

◆ operator/=()

◆ operator=()

◆ reduce()

◆ separator()

◆ single()

Member Data Documentation

◆ m_separator

◆ m_start

◆ m_tr

◆ m_value

template<typename String, typename Translator>
class boost::property_tree::string_path< String, Translator >