OpenStudio:utilities
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages

#include "Variant.hpp"

Public Member Functions

bool valueAsBoolean () const
double valueAsDouble () const
int valueAsInteger () const
std::string valueAsString () const
 Variant ()
 Variant (bool value)
 Variant (double value)
 Variant (int value)
 Variant (const char *value)
 Variant (const std::string &value)
VariantType variantType () const

Related Functions

typedef boost::optional< VariantOptionalVariant
typedef std::vector< VariantVariantVector

Detailed Description

A Variant is a flexible type that can hold several types of values.

Constructor & Destructor Documentation

openstudio::Variant::Variant ( )
explicit

constructors

openstudio::Variant::Variant ( bool  value)
explicit
openstudio::Variant::Variant ( double  value)
explicit
openstudio::Variant::Variant ( int  value)
explicit
openstudio::Variant::Variant ( const char *  value)
explicit
openstudio::Variant::Variant ( const std::string &  value)
explicit

Member Function Documentation

bool openstudio::Variant::valueAsBoolean ( ) const

get value as a bool

double openstudio::Variant::valueAsDouble ( ) const

get value as double

int openstudio::Variant::valueAsInteger ( ) const

get value as int

std::string openstudio::Variant::valueAsString ( ) const

get value as string

VariantType openstudio::Variant::variantType ( ) const

get the variant value type

Friends And Related Function Documentation

typedef boost::optional<Variant> OptionalVariant
related
typedef std::vector<Variant> VariantVector
related