VariantContainer Class Reference

VariantContainer is the base class of all other Variant container classes. More...

#include <ArmarXCore/observers/variant/VariantContainer.h>

Inheritance diagram for VariantContainer:

Public Member Functions
VariantDataClassPtr	clone (const Ice::Current &c=Ice::emptyCurrent) const override
ContainerTypePtr	getContainerType (const Ice::Current &c=Ice::emptyCurrent) const override
Ice::Int	getType (const Ice::Current &c=Ice::emptyCurrent) const override
std::string	output (const Ice::Current &c=Ice::emptyCurrent) const override
void	setContainerType (const ContainerTypePtr &containerType, const Ice::Current &c=Ice::emptyCurrent) override
bool	validate (const Ice::Current &c=Ice::emptyCurrent) override

Detailed Description

VariantContainer is the base class of all other Variant container classes.

Each VariantContainer can contain values of the types

• VariantContainer or subclasses thereof
• SingleVariant

Since VariantContainer inherits from VariantDataClass it is possible to put a VariantContainer into a Variant to send it via Ice.

See also

StringValueMap

SingleTypeVariantList

// VariantContainer can be replaced with any subclass of it
armarx::VariantContainerPtr variantContainer;
// create variant from VariantContainer
armarx::VariantPtr variant = new armarx::Variant(variantContainer);
// get VariantContainer from Variant
armarx::VariantContainerPtr variantContainer2 = variant->get<armarx::VariantContainer>();
if (variantContainer2)
{
   // work with the container
}
else
{
   // value of the variant was not a VariantContainer
}

Member Function Documentation

clone()

VariantDataClassPtr clone ( const Ice::Current & c = Ice::emptyCurrent ) const

override

getContainerType()

ContainerTypePtr getContainerType ( const Ice::Current & c = Ice::emptyCurrent ) const

override

getType()

Ice::Int getType ( const Ice::Current & c = Ice::emptyCurrent ) const

override

output()

std::string output ( const Ice::Current & c = Ice::emptyCurrent ) const

override

setContainerType()

void setContainerType ( const ContainerTypePtr & containerType, const Ice::Current & c = Ice::emptyCurrent )

override

validate()

bool validate ( const Ice::Current & c = Ice::emptyCurrent )

override

---

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

• ArmarXCore/observers/variant/VariantContainer.h
• ArmarXCore/observers/variant/VariantContainer.cpp