Wizt::ValuePool Class Reference

A ValuePool is the home of local values of certain input objects. More...

#include </home/werner/origo/vish/ocean/plankton/ValuePool.hpp>

List of all members.

Classes

• struct iterator

  An iterator to traverse the existing value pools. More...
  

• struct VarMap_t

Public Types

• typedef WeakPtr
  < ValueNotifierList > Key_t

Public Member Functions

• void activate (const RefPtr< ValuePool > &OldPool, const WeakPtr< ValueNotifier > &who=NullPtr(), const ValueMap *VP=0) const

  Activate this set of variables, which induces sending a notification request (i.e.
  

• const string & Name () const

  Return the name, a textual identifier, for this ValuePool.
  

• VObjectAge & ObjectAgePool ()

  A pool of object ages.
  

• bool setName (const string &name)

  Rename a vale pool.
  

• ValuePool ()

  Constructor, should set identifier name later since the default name is somewith unique, but weird.
  

• ValuePool (const string &name)

  Constructor with name (may be changed later, too)
  

• ~ValuePool ()

  Destructor.
  

Interface for Named Variables

• WeakPtr< VValueBase > retrieveValue (const string &name) const

  If a certain variable is stored under a certain name, retrieve it now.
  

• bool registerValue (const string &name, const WeakPtr< VValueBase > &val)

  Allow to store a certain variable under the specified name.
  

• bool removeValue (const string &name)

  Remove the association of a local variable with a name.
  

Interface for Keyed Variables

• RefPtr< VValueBase > findVariable (const Key_t &Key) const

  Find the value of an variable that is associated with the specified key, if present.
  

• void createVariable (const Key_t &Key, const RefPtr< VValueBase > &v)

  Create the shadow of a variable in this pool, using the specified value.
  

• void removeVariable (const Key_t &Key)

  Remove a variable's shadow from this pool.
  

Static Public Member Functions

• static WeakPtr< ValuePool,
  ValuePool > getValuePool (const string &name)

  Get a value pool that is associated with a certain name in the global database.
  

• static int iterate (iterator &it)

---

Detailed Description

A ValuePool is the home of local values of certain input objects.

When an input object is queried for its value, a VContext is specified. This VContext may refer to a pool of alternative copies.

The ValuePool provides two interfaces to access stored values:

• via providing a ValueNotifierList (which in practice usually will be a VParameter
• via providing a textual description The usual usuage is via the ValueNotifierList, i.e. given a certain VParameter, one may retrieve its value relative to a ValuePool. If there is no such value, then the VParameter's global value will be used. The VParameter has the option to switch between global and local settings (i.e. shared and exclusive values). If a local setting is switched to a global one, then all local copies in the ValuePool will be destroyed.

However, the ValuePool may also host a local copy of variables which co-exist permanently. They are used by the VParameter only if it set to local, but are not destroyed when switching to global. As such, these local values may well reside as part of multiple VObjects.

Class skeleton (main purpose is to map ValueNotifierLists to VValueBases. It's basic structure is of the type

  class ValuePool : public map<WeakPtr<ValueNotifierList>, RefPtr<VValueBase> >
  {};

whereby a ValuePool provides some additional properties like being an Intercube and a mutex for multithreaded operations. However, it should be avoided to lock an operation on a ValuePool since accessing the ValuePool is a very frequent operation.

Examples:

LocalCompoundInput.cpp.

---

Constructor & Destructor Documentation

Wizt::ValuePool::ValuePool

(

)

Constructor, should set identifier name later since the default name is somewith unique, but weird.

Calling this constructor should be avoided.

---

Member Function Documentation

void Wizt::ValuePool::activate	(	const RefPtr< ValuePool > &	OldPool,
		const WeakPtr< ValueNotifier > &	who = NullPtr(),
		const ValueMap *	VP = 0
	)		const

Activate this set of variables, which induces sending a notification request (i.e.

ValueNotifier::valueChanged() ) for all stored values.

Parameters:

OldPool

The previous pool of variables. It is required to determine which variables are changing at this activate() request and should receive a notify() call. Such circumstances arise when a local variable doesn't exist in this pool, i.e. its global value is used now or a variable is local in the new pool

Broadcast a value change event to all listening notifiers.

void Wizt::ValuePool::createVariable	(	const Key_t &	Key,
		const RefPtr< VValueBase > &	v
	)

Create the shadow of a variable in this pool, using the specified value.

Parameters:

Key	The notifier list, which is used as reference
v	An existing variable, which contains the value.

WeakPtr< ValuePool > Wizt::ValuePool::getValuePool

(

const string &

name

)

[static]

Get a value pool that is associated with a certain name in the global database.

It is not recommended to use this function, value pools should always be passed to calling routines that need them.

bool Wizt::ValuePool::removeValue

(

const string &

name

)

Remove the association of a local variable with a name.

Note that this association is removed anyway on destruction of a local variable since only weak pointers are stored here.

---

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

• ocean/plankton/ValuePool.hpp
• ocean/plankton/ValuePool.cpp