stromx::runtime::VariantComposite Class Reference

A composite expression of two variants. More...

#include <VariantComposite.h>

Inheritance diagram for stromx::runtime::VariantComposite:

Public Member Functions
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

Friends
STROMX_RUNTIME_API friend const VariantHandle	operator && (const VariantHandle &lhs, const VariantHandle &rhs)
STROMX_RUNTIME_API friend const VariantHandle	operator|| (const VariantHandle &lhs, const VariantHandle &rhs)

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

Detailed Description

A composite expression of two variants.

Member Function Documentation

compositeType()

virtual CompositeType stromx::runtime::VariantComposite::compositeType ( ) const

inlinevirtual

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

Reimplemented from stromx::runtime::VariantInterface.

id()

virtual unsigned int stromx::runtime::VariantComposite::id ( ) const

inlinevirtual

Returns the integer ID of this data variant.

Implements stromx::runtime::VariantInterface.

isVariant()

bool stromx::runtime::VariantComposite::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()

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

inlinevirtual

The left hand side of the composition.

Reimplemented from stromx::runtime::VariantInterface.

package()

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

virtual

Returns the package this data variant belongs to.

Implements stromx::runtime::VariantInterface.

rhs()

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

inlinevirtual

The right hand side of the composition.

Reimplemented from stromx::runtime::VariantInterface.

title()

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

virtual

Returns the title of the data variant.

Implements stromx::runtime::VariantInterface.

Friends And Related Function Documentation

operator &&

STROMX_RUNTIME_API friend const VariantHandle operator&& ( const VariantHandle &  lhs, const VariantHandle &  rhs  )

friend

Constructs a variant which is a valid super-type of both subtypes lhs and rhs.

Exceptions

WrongArgument

If lhs and rhs is not valid.

operator||

STROMX_RUNTIME_API friend const VariantHandle operator|| ( const VariantHandle &  lhs, const VariantHandle &  rhs  )

friend

Constructs a variant which is a valid super-type of subtypes either lhs or rhs.

Exceptions

WrongArgument

If lhs or rhs is not valid.

---

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

• stromx/runtime/VariantComposite.h
• stromx/runtime/VariantComposite.cpp