stromx::runtime::VariantHandle Class Reference

#include <VariantHandle.h>

Inheritance diagram for stromx::runtime::VariantHandle:

Public Member Functions
	VariantHandle (VariantInterface *const variant)
virtual unsigned int	id () const
virtual const std::string &	package () const
virtual const std::string	title () const
virtual bool	isVariant (const VariantInterface &variant) const
virtual CompositeType	compositeType () const
virtual const VariantHandle	lhs () const
virtual const VariantHandle	rhs () const
bool	isValid () const

Additional Inherited Members
Public Types inherited from stromx::runtime::VariantInterface
enum	CompositeType { NO_COMPOSITE, AND_COMPOSITE, OR_COMPOSITE }

Detailed Description

Handle for VariantInterface objects which can be passed by value.

Constructor & Destructor Documentation

VariantHandle()

stromx::runtime::VariantHandle::VariantHandle ( VariantInterface *const  variant )

inline

Creates a variant handle for variant. The handle gains ownership of variant.

Exceptions

WrongArgument

If variant is null.

Member Function Documentation

compositeType()

VariantInterface::CompositeType stromx::runtime::VariantHandle::compositeType ( ) const

virtual

The composite type if this variant is a logical composition of two other variants.

Reimplemented from stromx::runtime::VariantInterface.

id()

unsigned int stromx::runtime::VariantHandle::id ( ) const

virtual

Returns the integer ID of this data variant.

Implements stromx::runtime::VariantInterface.

isValid()

bool stromx::runtime::VariantHandle::isValid ( ) const

inline

Returns whether the handle holds a reference to an actual variant.

isVariant()

bool stromx::runtime::VariantHandle::isVariant ( const VariantInterface &  variant ) const

virtual

Returns true if this is a subtype of type. E.g. INT_16.isVariant(INT) == true.

Implements stromx::runtime::VariantInterface.

lhs()

const VariantHandle stromx::runtime::VariantHandle::lhs ( ) const

virtual

The left hand side of the composition.

Reimplemented from stromx::runtime::VariantInterface.

package()

const std::string & stromx::runtime::VariantHandle::package ( ) const

virtual

Returns the package this data variant belongs to.

Implements stromx::runtime::VariantInterface.

rhs()

const VariantHandle stromx::runtime::VariantHandle::rhs ( ) const

virtual

The right hand side of the composition.

Reimplemented from stromx::runtime::VariantInterface.

title()

const std::string stromx::runtime::VariantHandle::title ( ) const

virtual

Returns the title of the data variant.

Implements stromx::runtime::VariantInterface.

---

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

• stromx/runtime/VariantHandle.h
• stromx/runtime/VariantHandle.cpp