JC::SConfig::PairHandler Class Reference

Class that wraps a Pair class for easy and secure access. More...

#include <sconfig.hpp>

Collaboration diagram for JC::SConfig::PairHandler:

[legend]

List of all members.

Public Member Functions
	~PairHandler ()
PairHandler	NextSibling ()
	Gets the next Pair sibling and wraps it with a PairHandler.
PairHandler	NextSibling (const string &name)
	Gets the next Pair sibling with a specific name and wraps it with a PairHandler.
PairHandler	PreviousSibling ()
	Gets the previous Pair sibling and wraps it with a PairHandler.
PairHandler	PreviousSibling (const string &name)
	Gets the previous Pair sibling with a specific name and wraps it with a PairHandler.
const Pair *	Get ()
	Gets the actual Pair pointer, if it exists.
Private Member Functions
	PairHandler (const Pair *pair)
	Default constructor. Private.
	PairHandler (const PairHandler &handler)
	Copy constructor. Private.
PairHandler &	operator= (const PairHandler &old)
Private Attributes
const Pair *	m_Pair
Friends
class	Handler

---

Detailed Description

Class that wraps a Pair class for easy and secure access.

This class should not be instantiated directly by the client.

---

Constructor & Destructor Documentation

PairHandler::PairHandler

(

const Pair *

pair

)

[private]

Default constructor. Private.

Parameters:

pair

Pointer to the Pair to be wrapped.

PairHandler::PairHandler

(

const PairHandler &

handler

)

[private]

Copy constructor. Private.

PairHandler::~PairHandler

(

)

---

Member Function Documentation

PairHandler & PairHandler::operator=

(

const PairHandler &

old

)

[private]

PairHandler PairHandler::NextSibling

(

)

Gets the next Pair sibling and wraps it with a PairHandler.

Returns:

A PairHandler object wrapping the next sibling.

PairHandler PairHandler::NextSibling

(

const string &

name

)

Gets the next Pair sibling with a specific name and wraps it with a PairHandler.

Parameters:

name

the Pair's name to search for.

Returns:

A PairHandler object wrapping the next sibling with the specified name.

PairHandler PairHandler::PreviousSibling

(

)

Gets the previous Pair sibling and wraps it with a PairHandler.

Returns:

A PairHandler object wrapping the previous sibling.

PairHandler PairHandler::PreviousSibling

(

const string &

name

)

Gets the previous Pair sibling with a specific name and wraps it with a PairHandler.

Parameters:

name

the Pair's name to search for.

Returns:

A PairHandler object wrapping the previous sibling with the specified name.

const Pair * PairHandler::Get

(

)

Gets the actual Pair pointer, if it exists.

Returns:

A pointer to the actual Pair, NULL is returned if Pair doesn't exist.

---

Friends And Related Function Documentation

friend class Handler [friend]

---

Member Data Documentation

const Pair* JC::SConfig::PairHandler::m_Pair [private]

---

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

• src/sconfig.hpp
• src/sconfig.cpp