Main Page   Namespace List   Class Hierarchy   Compound List   Namespace Members   Compound Members   Related Pages  

NodeInterfaceSet Class Reference

A group of unique NodeInterfaces. More...

List of all members.


Public Types

typedef std::set< NodeInterface,
IdLess >::const_iterator 
const_iterator
 An STL const_iterator.


Public Methods

void add (const NodeInterface &nodeInterface) throw (std::invalid_argument, std::bad_alloc)
 Add an interface.

const_iterator begin () const throw ()
 Returns an iterator to the beginning of the NodeInterfaceSet.

const_iterator end () const throw ()
 Returns an iterator to the end of the NodeInterfaceSet.

const_iterator findInterface (const std::string &id) const throw ()
 Find an interface matching interfaceId id.


Private Attributes

std::set< NodeInterface, IdLess > nodeInterfaceSet

Detailed Description

A group of unique NodeInterfaces.

NodeInterfaceSets are used to construct new NodeTypes. NodeType objects also expose their interfaces as a NodeInterfaceSet. The interfaces in a NodeInterfaceSet are guaranteed to be unique and non-conflicting.


Member Typedef Documentation

const_iterator
 

An STL const_iterator.


Member Function Documentation

void add const NodeInterface   nodeInterface throw (std::invalid_argument, std::bad_alloc)
 

Add an interface.

Parameters:
nodeInterface a NodeInterface.
Exceptions:
std::invalid argument if nodeInterface conflicts with an interface already in the NodeInterfaceSet.
std::bad_alloc if memory allocation fails.

NodeInterfaceSet::const_iterator begin   const throw () [inline]
 

Returns an iterator to the beginning of the NodeInterfaceSet.

Returns:
a const_iterator pointing to the first NodeInterface in the set.

NodeInterfaceSet::const_iterator end   const throw () [inline]
 

Returns an iterator to the end of the NodeInterfaceSet.

Returns:
a const_iterator pointing to one increment past the last NodeInterface in the set.

NodeInterfaceSet::const_iterator findInterface const std::string &    id const throw ()
 

Find an interface matching interfaceId id.

If no interface is found with an interfaceId that is an exact match for id, this method will look for set_ and _changed variants.

Parameters:
id the interface id to look for.
Returns:
a const_iterator to the interface, or NodeInterfaceSet::end if no interface is found.