PolicyStatement Class Reference

A policy statement is a collection of terms. More...

#include <policy_statement.hh>

Inheritance diagram for PolicyStatement:

List of all members.

Classes
class	PolicyStatementErr
	Exception thrown on error such as when no term is found. More...
Public Types
typedef ConfigNodeIdMap< Term * >	TermContainer
Public Member Functions
	PolicyStatement (const string &name, SetMap &smap, PolicyMap &pmap)
void	add_term (const ConfigNodeId &order, Term *term)
	Append a term at the end of the policy.
Term &	find_term (const string &name) const
	Throws exception if no term is found.
bool	term_exists (const string &name) const
	Checks if a term already exists.
bool	delete_term (const string &name)
	Attempts to delete a term.
void	set_policy_end ()
	Perform operations at the end of the policy.
const string &	name () const
bool	accept (Visitor &v)
	Visitor implementation.
TermContainer &	terms ()
void	set_dependency (const DEPS &sets, const DEPS &policies)
	Replace the set dependencies.
Private Types
typedef list< pair < ConfigNodeId, Term * > >	OOL
Private Member Functions
void	del_dependencies ()
	Delete all set dependencies of this policy.
TermContainer::iterator	get_term_iter (const string &name)
	Get the iterator for a specific term.
TermContainer::const_iterator	get_term_iter (const string &name) const
OOL::iterator	find_out_of_order_term (const ConfigNodeId &order)
	Get the iterator for a term that is out of order.
OOL::iterator	find_out_of_order_term (const string &name)
	Get the iterator for a term that is out of order.
OOL::const_iterator	find_out_of_order_term (const string &name) const
Private Attributes
string	_name
TermContainer	_terms
list< pair< ConfigNodeId, Term * > >	_out_of_order_terms
DEPS	_sets
DEPS	_policies
SetMap &	_smap
PolicyMap &	_pmap

---

Detailed Description

A policy statement is a collection of terms.

---

Constructor & Destructor Documentation

PolicyStatement::PolicyStatement	(	const string &	name,
		SetMap &	smap,
		PolicyMap &	pmap
	)

Parameters:

name	the name of the policy.
smap	the SetMap. Used for dependency tracking.
pmap	the PolicyMap. Used for dependency tracking.

---

Member Function Documentation

bool PolicyStatement::accept

(

Visitor &

v

)

Visitor implementation.

Parameters:

v	visitor to visit policy.

void PolicyStatement::add_term	(	const ConfigNodeId &	order,
		Term *	term
	)

Append a term at the end of the policy.

Caller must not delete / modify pointer.

Parameters:

order	node ID with position of term.
term	term to append to policy.

bool PolicyStatement::delete_term

(

const string &

name

)

Attempts to delete a term.

Returns:

true on successful delete, false otherwise.

Parameters:

name	name of term to delete.

list< pair< ConfigNodeId, Term * > >::iterator PolicyStatement::find_out_of_order_term

(

const ConfigNodeId &

order

)

[private]

Get the iterator for a term that is out of order.

Parameters:

order

the order for the term.

Returns:

iterator for term.

list< pair< ConfigNodeId, Term * > >::iterator PolicyStatement::find_out_of_order_term

(

const string &

name

)

[private]

Get the iterator for a term that is out of order.

Parameters:

name	the name for the term.

Returns:

iterator for term.

Term & PolicyStatement::find_term

(

const string &

name

)

const

Throws exception if no term is found.

Returns:

term requested.

Parameters:

name	name of term to find.

PolicyStatement::TermContainer::iterator PolicyStatement::get_term_iter

(

const string &

name

)

[private]

Get the iterator for a specific term.

Returns:

iterator for term.

Parameters:

name	name of the term.

const string & PolicyStatement::name

(

)

const

Returns:

name of policy.

void PolicyStatement::set_dependency	(	const DEPS &	sets,
		const DEPS &	policies
	)

Replace the set dependencies.

Parameters:

sets	the new sets this policy is dependent on.

bool PolicyStatement::term_exists

(

const string &

name

)

const

Checks if a term already exists.

Returns:

true if term exists, false otherwise.

Parameters:

name	term name.

PolicyStatement::TermContainer & PolicyStatement::terms

(

)

Returns:

terms of this policy

---

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

• /home/greearb/git/xorp.ct.github/xorp/policy/policy_statement.hh
• /home/greearb/git/xorp.ct.github/xorp/policy/policy_statement.cc