Fawkes API  Fawkes Development Version
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions
fawkes::UniquenessConstraint< ResourceType > Class Template Reference

Uniqueness constraint. More...

#include <>>

Inheritance diagram for fawkes::UniquenessConstraint< ResourceType >:
Inheritance graph
[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 63 of file unique.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 80 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:
rresource object to add
Exceptions:
UniquenessViolationExceptionthrown, if a second resource is added

Definition at line 93 of file unique.h.

Referenced by fawkes::TimeSourceAspectIniFin::init(), and fawkes::MainLoopAspectIniFin::init().

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

Remove resource.

Parameters:
rresource object to remove

Definition at line 108 of file unique.h.

Referenced by fawkes::TimeSourceAspectIniFin::finalize(), and fawkes::MainLoopAspectIniFin::finalize().

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

Get resource.

Returns:
resource if set, NULL otherwise

Definition at line 118 of file unique.h.

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