isc::dhcp::ClientClasses Class Reference

Container for storing client class names. More...

#include <classify.h>

Public Types
typedef ClientClassContainer::const_iterator	const_iterator
	Type of iterators.
typedef ClientClassContainer::iterator	iterator

Public Member Functions
	ClientClasses ()
	Default constructor.
	ClientClasses (const std::string &class_names)
	Constructor from comma separated values.
void	clear ()
	Clears containers.
bool	contains (const ClientClass &x) const
	returns if class x belongs to the defined classes
bool	empty () const
	Check if classes is empty.
void	erase (const ClientClass &class_name)
	Erase element by name.
void	insert (const ClientClass &class_name)
	Insert an element.
size_t	size () const
	Returns the number of classes.
isc::data::ElementPtr	toElement () const
	Returns all class names as an ElementPtr of type ListElement.
std::string	toText (const std::string &separator=", ") const
	Returns all class names as text.
const_iterator	cbegin () const
	Iterators to the first element.
const_iterator	begin () const
iterator	begin ()
const_iterator	cend () const
	Iterators to the past the end element.
const_iterator	end () const
iterator	end ()

Detailed Description

Container for storing client class names.

Both a list to iterate on it in insert order and unordered set of names for existence.

Definition at line 108 of file classify.h.

Member Typedef Documentation

const_iterator

typedef ClientClassContainer::const_iterator isc::dhcp::ClientClasses::const_iterator

Type of iterators.

Definition at line 112 of file classify.h.

iterator

typedef ClientClassContainer::iterator isc::dhcp::ClientClasses::iterator

Definition at line 113 of file classify.h.

Constructor & Destructor Documentation

ClientClasses() [1/2]

isc::dhcp::ClientClasses::ClientClasses ( )

inline

Default constructor.

Definition at line 116 of file classify.h.

ClientClasses() [2/2]

isc::dhcp::ClientClasses::ClientClasses

(

const std::string &

class_names

)

Constructor from comma separated values.

Parameters

class_names

A string containing a client classes separated with commas. The class names are trimmed before insertion to the set.

Definition at line 25 of file classify.cc.

References insert(), and isc::util::str::trim().

Here is the call graph for this function:

Member Function Documentation

begin() [1/2]

iterator isc::dhcp::ClientClasses::begin ( )

inline

Definition at line 158 of file classify.h.

begin() [2/2]

const_iterator isc::dhcp::ClientClasses::begin ( ) const

inline

Definition at line 155 of file classify.h.

cbegin()

const_iterator isc::dhcp::ClientClasses::cbegin ( ) const

inline

Iterators to the first element.

Definition at line 152 of file classify.h.

cend()

const_iterator isc::dhcp::ClientClasses::cend ( ) const

inline

Iterators to the past the end element.

Definition at line 165 of file classify.h.

clear()

void isc::dhcp::ClientClasses::clear ( )

inline

Clears containers.

Definition at line 183 of file classify.h.

contains()

bool isc::dhcp::ClientClasses::contains

(

const ClientClass &

x

)

const

returns if class x belongs to the defined classes

Parameters

x	client class to be checked

Returns

true if x belongs to the classes

Definition at line 49 of file classify.cc.

Referenced by isc::dhcp::Pkt::addSubClass(), isc::dhcp::Pkt::inClass(), isc::dhcp::Pool::requireClientClass(), and isc::dhcp::Network::requireClientClass().

empty()

bool isc::dhcp::ClientClasses::empty ( ) const

inline

Check if classes is empty.

Definition at line 138 of file classify.h.

end() [1/2]

iterator isc::dhcp::ClientClasses::end ( )

inline

Definition at line 171 of file classify.h.

end() [2/2]

const_iterator isc::dhcp::ClientClasses::end ( ) const

inline

Definition at line 168 of file classify.h.

erase()

void isc::dhcp::ClientClasses::erase

(

const ClientClass &

class_name

)

Erase element by name.

Parameters

class_name

The name of the class to erase.

Definition at line 40 of file classify.cc.

insert()

void isc::dhcp::ClientClasses::insert ( const ClientClass & class_name )

inline

Insert an element.

Parameters

class_name

The name of the class to insert

Definition at line 128 of file classify.h.

Referenced by ClientClasses(), isc::dhcp::Pkt::addClass(), isc::dhcp::Pkt::addSubClass(), isc::dhcp::Pool::requireClientClass(), isc::dhcp::Network::requireClientClass(), isc::dhcp::Dhcpv6Srv::requiredClassify(), and isc::dhcp::Dhcpv4Srv::requiredClassify().

size()

size_t isc::dhcp::ClientClasses::size ( ) const

inline

Returns the number of classes.

Note

; in C++ 11 list size complexity is constant so there is no advantage to use the set part.

Definition at line 146 of file classify.h.

toElement()

ElementPtr isc::dhcp::ClientClasses::toElement

(

)

const

Returns all class names as an ElementPtr of type ListElement.

Returns

the list

Definition at line 70 of file classify.cc.

References isc::data::Element::create(), and isc::data::Element::createList().

Here is the call graph for this function:

toText()

std::string isc::dhcp::ClientClasses::toText

(

const std::string &

separator = ", "

)

const

Returns all class names as text.

Parameters

separator

Separator to be used between class names. The default separator comprises comma sign followed by space character.

Returns

the string representation of all classes

Definition at line 55 of file classify.cc.

---

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

• classify.h
• classify.cc