orxonox::Scope< scope > Class Template Reference

A scope for a given template argument is either active or not. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/libraries/core/CorePrereqs.h>

Public Member Functions
	Scope ()
	Constructor: activate the listeners. More...
	~Scope ()
	Destructor: deactivate the listeners. More...
void	deactivateScope ()
	Deactivates the listeners of this scope in case the scope is destroyed or the construction fails. More...

Static Public Member Functions
static bool	isActive ()
	Returns true if the scope is active. More...

Detailed Description

template<ScopeID::Value scope>
class orxonox::Scope< scope >

A scope for a given template argument is either active or not.

Objects inheriting from a ScopeListener are registered in a list (different for each scope). If the scope gets activated or deactivated, all objects in this list are notified.

See also

See this description for details about the interrelationship of Scope, ScopeListener, and ScopeManager.

Constructor & Destructor Documentation

template<ScopeID::Value scope>

orxonox::Scope< scope >::Scope ( )

inline

Constructor: activate the listeners.

template<ScopeID::Value scope>

orxonox::Scope< scope >::~Scope ( )

inline

Destructor: deactivate the listeners.

Member Function Documentation

template<ScopeID::Value scope>

void orxonox::Scope< scope >::deactivateScope ( )

inline

Deactivates the listeners of this scope in case the scope is destroyed or the construction fails.

template<ScopeID::Value scope>

static bool orxonox::Scope< scope >::isActive ( void  )

inlinestatic

Returns true if the scope is active.

---

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

• libraries/core/CorePrereqs.h
• libraries/core/singleton/Scope.h