A simpler (and slightly faster) version of a QVariant, added for interfaces that do not use Qt. More...

#include <variant.h>

Classes
class	VUserType
	This is a helper class, designed to make it possible to allow user-defined types to be encoded in a Variant. . More...

class	VUserType< void * >
	Template specialization for void pointers; this should probably never be used, except to determine the size of VUserType for type_selector. More...

Public Types
enum	Type { ByteType =1, UByteType, ShortType, UShortType, IntType, UIntType, LongType, ULongType, FloatType, DoubleType, VoidType, BoolType, IVect2Type, DVect2Type, IVect3Type, DVect3Type, RawDataType, StringType =100, UserType }
	Indicates the type of the variant. 18 types are predefined. More...

Public Member Functions
BASE_EXPORT	Variant (const Variant &mv)
	Copy constructor.

BASE_EXPORT	Variant (const Int &v=0)

BASE_EXPORT	Variant (const bool &v)

BASE_EXPORT	Variant (const Byte &v)

BASE_EXPORT	Variant (const UByte &v)

BASE_EXPORT	Variant (const Short &v)

BASE_EXPORT	Variant (const UShort &v)

BASE_EXPORT	Variant (const UInt &v)

BASE_EXPORT	Variant (const Long &v)

BASE_EXPORT	Variant (const ULong &v)

BASE_EXPORT	Variant (const Float &v)

BASE_EXPORT	Variant (const Double &v)

BASE_EXPORT	Variant (void *v)

BASE_EXPORT	Variant (const void *v)

BASE_EXPORT	Variant (const IVect2 &v)

BASE_EXPORT	Variant (const DVect2 &v)

BASE_EXPORT	Variant (const IVect3 &v)

BASE_EXPORT	Variant (const DVect3 &v)

BASE_EXPORT	Variant (const String &v)

BASE_EXPORT	Variant (const Char *v)

BASE_EXPORT	~Variant ()
	Destructor.

BASE_EXPORT const Variant &	operator= (const Variant &mv)
	Equality operator.

BASE_EXPORT Type	getType () const
	The type of the Variant. Note that this may be a user-defined value.

BASE_EXPORT String	getTypeName () const
	A string indicating the Variant type.

BASE_EXPORT bool	toBool (bool *success=0) const

BASE_EXPORT Byte	toByte (bool *success=0) const

BASE_EXPORT UByte	toUByte (bool *success=0) const

BASE_EXPORT Short	toShort (bool *success=0) const

BASE_EXPORT UShort	toUShort (bool *success=0) const

BASE_EXPORT Int	toInt (bool *success=0) const

BASE_EXPORT UInt	toUInt (bool *success=0) const

BASE_EXPORT Long	toLong (bool *success=0) const

BASE_EXPORT ULong	toULong (bool *success=0) const

BASE_EXPORT Float	toFloat (bool *success=0) const

BASE_EXPORT Double	toDouble (bool *success=0) const

BASE_EXPORT String	toString (bool *success=0) const

BASE_EXPORT void *	toVoid (bool *success=0) const

BASE_EXPORT IVect2	toIVect2 (bool *success=0) const

BASE_EXPORT DVect2	toDVect2 (bool *success=0) const

BASE_EXPORT IVect3	toIVect3 (bool *success=0) const

BASE_EXPORT DVect3	toDVect3 (bool *success=0) const

BASE_EXPORT const Int &	fastToInt () const

BASE_EXPORT const bool &	fastToBool () const

BASE_EXPORT const Long &	fastToLong () const

BASE_EXPORT const Double &	fastToDouble () const

BASE_EXPORT const DVect2 &	fastToDVect2 () const

BASE_EXPORT const DVect3 &	fastToDVect3 () const

BASE_EXPORT const String &	fastToString () const

const Variant &	operator= (const bool &v)
	Assignment operator for a specific type, converts the Variant to the same type and value.

const Variant &	operator= (const Byte &v)

const Variant &	operator= (const UByte &v)

const Variant &	operator= (const Short &v)

const Variant &	operator= (const UShort &v)

const Variant &	operator= (const Int &v)

const Variant &	operator= (const UInt &v)

const Variant &	operator= (const Long &v)

const Variant &	operator= (const ULong &v)

const Variant &	operator= (const Float &v)

const Variant &	operator= (const Double &v)

const Variant &	operator= (void *v)

const Variant &	operator= (const void *v)

const Variant &	operator= (const IVect2 &v)

const Variant &	operator= (const DVect2 &v)

const Variant &	operator= (const DAVect2 &v)

const Variant &	operator= (const IVect3 &v)

const Variant &	operator= (const DVect3 &v)

BASE_EXPORT const Variant &	operator= (const String &v)

const Variant &	operator= (const Char *v)

BASE_EXPORT void	setToRawData ()

char *	getRawData ()

const char *	getRawData () const

template<class T >
void	setToUserType (const T &t)

template<class T >
void	moveToUserType (T &&t)

template<class T >
T &	convertToUserType ()

template<class T >
T	toUserType () const

template<class T >
T &	fastToUserType ()

template<class T >
const T &	fastToUserType () const

template<class T >
bool	isUserType () const

Static Public Member Functions
static BASE_EXPORT String	getTypeName (Type type)
	Returns the name associated with a given type value, of "UnKnown" if the type is not valid.

static BASE_EXPORT int	getRawDataSize ()

static BASE_EXPORT bool	getUserTypeClaimed (int type)

template<class T >
static bool	registerType (int type, const String &name)
	This method allows user-defined types to be encoded in a variant. More...

Friends
template<class T >
class	VUserType

BASE_EXPORT QDataStream &	operator<< (QDataStream &, const Variant &)
	Allows writing a Variant to a QDataStream. More...

Detailed Description

A simpler (and slightly faster) version of a QVariant, added for interfaces that do not use Qt.

This class implements a variant. Used when parameters need to be passed or returned but the type could vary.
These types could be integral, floating-point, strings, 2D or 3D vectors, etc.
This type is used in the property interface for constitutive models, and by FISH.
If QT is active, it is preferred you use the Qt QVariant class.
QVariant is more general, but this version should perform better at runtime.

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

C:/Source/itasca-suite/common/base/src/variant.h
C:/Source/itasca-suite/common/base/src/variant.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description