Wizt::VValueParameter Class Reference

Shortcut convenience class for VParameters that refer to a VValue<> storage of the actual parameter. More...

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

List of all members.

Public Member Functions

• override const RefPtr< VParameter > copy () const
• override RefPtr< VValueBase > createLocalVariable (const RefPtr< ValuePool > &GhostValues) const

  Create a variable that is local relative to the specified ValuePool.
  

• override RefPtr< VValueBase > newValue () const

  Create a new value with same value as this global one.
  

• Type & operator() ()

  Allow direct writable access to the stored type via function call operator ()
  

• const Type & operator() () const

  Allow direct read-only access to the stored type via function call operator ()
  

• override bool setGlobalValue (const RefPtr< VValueBase > &newValue, const string &member) const
• VValueParameter (const Type &init, const string &initial_name, const RefPtr< VCreationPreferences > &CP)
• VValueParameter (const RefPtr< VValue< Type > > &V, const string &initial_name, const RefPtr< VCreationPreferences > &CP)

  Create a valued parameter with some reference-counted value.
  

---

Detailed Description

Shortcut convenience class for VParameters that refer to a VValue<> storage of the actual parameter.

It should only be used to initialize a VParameter, but not for checking a VParameter for its type, since it then could never be a VObjectComponentParameter<>.

Examples:

exocoetida.cpp, LocalCompoundInput.cpp, and stockvish.cpp.

---

Constructor & Destructor Documentation

Wizt::VValueParameter::VValueParameter	(	const Type &	init,
		const string &	initial_name,
		const RefPtr< VCreationPreferences > &	CP
	)		[inline]

Parameters:

V	The initialization value
initial_name	The initial name of an associated object, if one needs to be created. If the creation preference induce the creation of an object which does not have a name at all, this parameter is ignored. Its interpretation is duty of the input creator (see class VInputCreator).
CP	Creation preferences, a list of weighted textual descriptions of the desired properties of the preferred input object. The fulfillment of these preferences is not guaranteed and left to the implementation of the input object. The result might even change during the runtime of an application, e.g. when a plugin (shared/dynamic library) is loaded or unloaded.

Wizt::VValueParameter::VValueParameter	(	const RefPtr< VValue< Type > > &	V,
		const string &	initial_name,
		const RefPtr< VCreationPreferences > &	CP
	)		[inline]

Create a valued parameter with some reference-counted value.

A strong reference count will be stored from this parameter to the value.

---

Member Function Documentation

override RefPtr<VValueBase> Wizt::VValueParameter::createLocalVariable

(

const RefPtr< ValuePool > &

GhostValues

)

const [inline, virtual]

Create a variable that is local relative to the specified ValuePool.

The return value is false only if the specified pointer is invalid.

Implements Wizt::VParameter.

---

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

• ocean/plankton/VParameter.hpp