Wizt::VComponentValue Class Reference

Think hard whether tha VComponentValue shouldn't rather refer to VValueType<> instead of an VValue<Type>, because then we can described structures recursively as components of each other More...

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

List of all members.

Public Member Functions

• Ageable & age ()

  Return the age of this value.
  

• const Ageable & age () const

  Return the age of this value, constant version.
  

• void alterComponent (ComponentType Type::*ValueMember)
• override RefPtr< VValueBase > copy () const

  Create a copy of the respective value.
  

• override const type_info & getType () const

  Implement the virtual function to query the type ID of this value.
  

• override bool getValue (ComponentType &Variable) const

  Implement the virtual function to get the current value.
  

• override WeakPtr< VValueCreator > getValueCreator () const

  no value creator here
  

• override bool getValueFrom (const WeakPtr< VValueBase > &V)
• operator ComponentType & ()

  Implicit type conversion allows modification of the associated value.
  

• operator const Type & () const

  Read-only retrieval of the associated value.
  

• override bool request (const VRequest &request, double precision)

  Ask to fullfill a request in a certain precision.
  

• override bool setContainerValue (const WeakPtr< VValueBase > &V)
• override bool setValue (const ComponentType &Variable)

  Implement the assignment of the current value.
  

• bool setValueFromText (const string &s)
• override RefPtr< VManagedObject > source ()

  In case this object is memory-managed, return its container.
  

• string Text () const
• VComponentValue (const WeakPtr< ValueType > &V, ComponentType Type::*ValueMember)

  Construct a value from a given value instance.
  

• VComponentValue (const VComponentValue &V)

  Copy constructor: copies just the value, all reference pointing stuff is not duplicated.
  

---

Detailed Description

Think hard whether tha VComponentValue shouldn't rather refer to VValueType<> instead of an VValue<Type>, because then we can described structures recursively as components of each other

---

Constructor & Destructor Documentation

Wizt::VComponentValue::VComponentValue

(

const VComponentValue &

V

)

[inline]

Copy constructor: copies just the value, all reference pointing stuff is not duplicated.

Also, the age of the new object is recent.

---

Member Function Documentation

override const type_info& Wizt::VComponentValue::getType

(

)

const [inline]

Implement the virtual function to query the type ID of this value.

For this value, the type is fixed throughout its lifetime and corresponds to the type of the template argument.

Reimplemented from Wizt::VTypedValueBase< ComponentType >.

override bool Wizt::VComponentValue::getValue

(

ComponentType &

Variable

)

const [inline]

Implement the virtual function to get the current value.

Returns:

True on successfull retrieval, which is always the case in the default implementation of a stored value. However, derived values which implement a procedural value might return false here as well.

Parameters:

Variable

The external storage space where to assign this value.

override bool Wizt::VComponentValue::request	(	const VRequest &	request,
		double	precision
	)		[inline]

Ask to fullfill a request in a certain precision.

By default, this function does nothing, since the value to be computed is already stored here. However, since the function is virtual, a derived class might perform some actions here to compute the requested value.

Parameters:

precision

A quality parameter in the range [0,1]. Lower values indicate that this function should return as fast as possible, while higher values indicate that accuracy is more important than execution time. With a value of 0.0, the function should return immediately, at 1.0 it should take as long as required to perform the requested operation as accurate as possible.

override bool Wizt::VComponentValue::setValue

(

const ComponentType &

Variable

)

[inline]

Implement the assignment of the current value.

Parameters:

Variable

The external storage space from where to assign this value.

---

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

• ocean/plankton/VValue.hpp