Public Member Functions

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 ()
VOutputAssignmentContext< Type > operator<< (const RefPtr< ValuePool > &VP) const
VOutput (const WeakPtr< VObject > &Source, const string &initial_name, const Type &InitValue, const RefPtr< VCreationPreferences > &CP=NullPtr())
Constructor:
VOutput (const VObject::Deferred &)
Default constructor - allows to create VOutputs with deferred construction, eventually dynamically, instead of during construction.

Detailed Description

Output properties of an object.

Given a type Alpha, the output object must declare a member

   VOutput<Alpha>  myAlpha;

whereas the child object must declare a usual typed slots, such as

   TypedSlot<Alpha>  myAlphaInput;

The associated global value can be accessed via the function call operator:

   VOutput<Alpha>  myAlpha;
   Alpha&a        = myAlpha();

Examples:: ClippingPlane.cpp, and InteractivePoint.cpp.

Constructor & Destructor Documentation

Wizt::VOutput::VOutput	(	const WeakPtr< VObject > &	Source,
		const string &	initial_name,
		const Type &	InitValue,
		const RefPtr< VCreationPreferences > &	CP = `NullPtr()`
	)		`[inline]`

Constructor:

Parameters:

Source The VObject providing this output parameter

Wizt::VOutput::VOutput ( const VObject::Deferred & ) [inline]

Default constructor - allows to create VOutputs with deferred construction, eventually dynamically, instead of during construction.

           class        MyObject : VObject
           {
                VOutput<double> MaybeOutput;

                MyObject()
                : MaybeOutput( Deferred() )
                {
                        MaybeOutput = VOutput<double>(self(), "myparam", 0.5);
                }
           };

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

ocean/plankton/VObject.hpp