fawkes::UniquenessConstraint< ResourceType > Class Template Reference

Uniqueness constraint. More...

#include <utils/constraints/unique.h>

Inheritance diagram for fawkes::UniquenessConstraint< ResourceType >:

[legend]
List of all members.

Public Member Functions

 UniquenessConstraint ()
 Constructor.
void add (ResourceType *r)
 Add resource.
void remove (ResourceType *p)
 Remove resource.
ResourceType * resource ()
 Get resource.

Detailed Description

template<class ResourceType>
class fawkes::UniquenessConstraint< ResourceType >

Uniqueness constraint.

This constraint keeps track of a resource that may exist at most once.

The resource can only be added if no resource has been added and not been removed before. A resource can always be removed.

Author:
Tim Niemueller

Definition at line 62 of file unique.h.


Constructor & Destructor Documentation

template<class ResourceType>
fawkes::UniquenessConstraint< ResourceType >::UniquenessConstraint (  ) 

Constructor.

Definition at line 79 of file unique.h.


Member Function Documentation

template<class ResourceType>
void fawkes::UniquenessConstraint< ResourceType >::add ( ResourceType *  r  ) 

Add resource.

This will add the resources or throw an exception if there is already a resource.

Parameters:
r resource object to add
Exceptions:
UniquenessViolationException thrown, if a second resource is added

Definition at line 92 of file unique.h.

template<class ResourceType>
void fawkes::UniquenessConstraint< ResourceType >::remove ( ResourceType *  r  ) 

Remove resource.

Parameters:
r resource object to remove

Definition at line 107 of file unique.h.

template<class ResourceType>
ResourceType * fawkes::UniquenessConstraint< ResourceType >::resource (  ) 

Get resource.

Returns:
resource if set, NULL otherwise

Definition at line 117 of file unique.h.


The documentation for this class was generated from the following file:
Generated on Tue Feb 22 13:32:53 2011 for Fawkes API by  doxygen 1.4.7