ADTF  3.18.2
Variant

Container type, able to store any primitive data type (and arrays thereof) More...

Public Member Functions

 Variant ()
 CTOR: VT_Empty.
 
 Variant (bool value)
 CTOR: VT_Bool. More...
 
 Variant (std::int8_t value)
 CTOR: VT_Int8. More...
 
 Variant (std::uint8_t value)
 CTOR: VT_UInt8. More...
 
 Variant (std::int16_t value)
 CTOR: VT_Int16. More...
 
 Variant (std::uint16_t value)
 CTOR: VT_UInt16. More...
 
 Variant (std::int32_t value)
 CTOR: VT_Int32. More...
 
 Variant (std::uint32_t value)
 CTOR: VT_UInt32. More...
 
 Variant (std::int64_t value)
 CTOR: VT_Int64. More...
 
 Variant (std::uint64_t value)
 CTOR: VT_UInt64. More...
 
 Variant (float value)
 CTOR: VT_Float32. More...
 
 Variant (double value)
 CTOR: VT_Float64. More...
 
 Variant (const char *value)
 CTOR: VT_String. More...
 
 Variant (const Variant &other)
 Copy CTOR. More...
 
Variantoperator= (const Variant &other)
 Assignment operator. More...
 
 ~Variant ()
 Non-virtual DTOR.
 
 Variant (Variant &&other) noexcept
 Move CTOR. More...
 
Variantoperator= (Variant &&other) noexcept
 Move assignment. More...
 
VariantType getType () const
 Returns the current underlying data type of the instance.
 
std::size_t getArraySize () const
 Get the current array size of the instance. More...
 
bool isArray () const
 Returns whether the instance stores an array of any kind.
 
bool isEmpty () const
 Returns whether the instance is in the empty state (VT_Empty)
 
void reset ()
 Resets the instance to VT_Empty.
 
void reset (bool value)
 Resets the instance to VT_Bool. More...
 
void reset (std::int8_t value)
 Resets the instance to VT_Int8. More...
 
void reset (std::uint8_t value)
 Resets the instance to VT_UInt8. More...
 
void reset (std::int16_t value)
 Resets the instance to VT_Int16. More...
 
void reset (std::uint16_t value)
 Resets the instance to VT_UInt16. More...
 
void reset (std::int32_t value)
 Resets the instance to VT_Int32. More...
 
void reset (std::uint32_t value)
 Resets the instance to VT_UInt32. More...
 
void reset (std::int64_t value)
 Resets the instance to VT_Int64. More...
 
void reset (std::uint64_t value)
 Resets the instance to VT_UInt64. More...
 
void reset (float value)
 Resets the instance to VT_Float. More...
 
void reset (double value)
 Resets the instance to VT_Double. More...
 
void reset (const char *value)
 Resets the instance to VT_String. More...
 
void reset (const bool *array_storage, std::size_t array_size)
 Resets the instance to an array of VT_Bool. More...
 
void reset (const std::int8_t *array_storage, std::size_t array_size)
 Resets the instance to an array of VT_Int8. More...
 
void reset (const std::uint8_t *array_storage, std::size_t array_size)
 Resets the instance to an array of VT_UInt8. More...
 
void reset (const std::int16_t *array_storage, std::size_t array_size)
 Resets the instance to an array of VT_Int16. More...
 
void reset (const std::uint16_t *array_storage, std::size_t array_size)
 Resets the instance to an array of VT_UInt16. More...
 
void reset (const std::int32_t *array_storage, std::size_t array_size)
 Resets the instance to an array of VT_Int32. More...
 
void reset (const std::uint32_t *array_storage, std::size_t array_size)
 Resets the instance to an array of VT_UInt32. More...
 
void reset (const std::int64_t *array_storage, std::size_t array_size)
 Resets the instance to an array of VT_Int64. More...
 
void reset (const std::uint64_t *array_storage, std::size_t array_size)
 Resets the instance to an array of VT_UInt64. More...
 
void reset (const float *array_storage, std::size_t array_size)
 Resets the instance to an array of VT_Float. More...
 
void reset (const double *array_storage, std::size_t array_size)
 Resets the instance to an array of VT_Double. More...
 
bool getBool (std::size_t array_index=0) const
 Get current value or alternatively from an array index of the variants value. More...
 
std::int8_t getInt8 (std::size_t array_index=0) const
 Get current value or alternatively from an array index of the variants value. More...
 
std::uint8_t getUInt8 (std::size_t array_index=0) const
 Get current value or alternatively from an array index of the variants value. More...
 
std::int16_t getInt16 (std::size_t array_index=0) const
 Get current value or alternatively from an array index of the variants value. More...
 
std::uint16_t getUInt16 (std::size_t array_index=0) const
 Get current value or alternatively from an array index of the variants value. More...
 
std::int32_t getInt32 (std::size_t array_index=0) const
 Get current value or alternatively from an array index of the variants value. More...
 
std::uint32_t getUInt32 (std::size_t array_index=0) const
 Get current value or alternatively from an array index of the variants value. More...
 
std::int64_t getInt64 (std::size_t array_index=0) const
 Get current value or alternatively from an array index of the variants value. More...
 
std::uint64_t getUInt64 (std::size_t array_index=0) const
 Get current value or alternatively from an array index of the variants value. More...
 
float getFloat (std::size_t array_index=0) const
 Get current value or alternatively from an array index of the variants value. More...
 
double getDouble (std::size_t array_index=0) const
 Get current value or alternatively from an array index of the variants value. More...
 
float getFloat32 (std::size_t array_index=0) const
 Get current value or alternatively from an array index of the variants value. More...
 
double getFloat64 (std::size_t array_index=0) const
 Get current value or alternatively from an array index of the variants value. More...
 
const char * getString () const
 Get current string value. More...
 
bool asBool () const
 Convert the value of the variant. More...
 
std::int8_t asInt8 () const
 Convert the value of the variant. More...
 
std::uint8_t asUInt8 () const
 Convert the value of the variant. More...
 
std::int16_t asInt16 () const
 Convert the value of the variant. More...
 
std::uint16_t asUInt16 () const
 Convert the value of the variant. More...
 
std::int32_t asInt32 () const
 Convert the value of the variant. More...
 
std::uint32_t asUInt32 () const
 Convert the value of the variant. More...
 
std::int64_t asInt64 () const
 Convert the value of the variant. More...
 
std::uint64_t asUInt64 () const
 Convert the value of the variant. More...
 
float asFloat () const
 Convert the value of the variant. More...
 
double asDouble () const
 Convert the value of the variant. More...
 
std::string asString () const
 Convert the value of the variant. More...
 
 operator bool () const
 Explicit conversion of the value of the variant to VT_Bool. More...
 
 operator std::int8_t () const
 Explicit conversion of the value of the variant to VT_Int8. More...
 
 operator std::uint8_t () const
 Explicit conversion of the value of the variant to VT_UInt8. More...
 
 operator std::int16_t () const
 Explicit conversion of the value of the variant to VT_Int16. More...
 
 operator std::uint16_t () const
 Explicit conversion of the value of the variant to VT_UInt16. More...
 
 operator std::int32_t () const
 Explicit conversion of the value of the variant to VT_Int32. More...
 
 operator std::uint32_t () const
 Explicit conversion of the value of the variant to VT_UInt32. More...
 
 operator std::int64_t () const
 Explicit conversion of the value of the variant to VT_Int64. More...
 
 operator std::uint64_t () const
 Explicit conversion of the value of the variant to VT_UInt64. More...
 
 operator float () const
 Explicit conversion of the value of the variant to VT_Float. More...
 
 operator double () const
 Explicit conversion of the value of the variant to VT_Double. More...
 
 operator std::string () const
 Explicit conversion of the value of the variant to VT_String. More...
 
Variantoperator= (bool value)
 Assignment operator for implicit type conversion to VT_Bool. More...
 
Variantoperator= (std::int8_t value)
 Assignment operator for implicit type conversion to VT_Int8. More...
 
Variantoperator= (std::uint8_t value)
 Assignment operator for implicit type conversion to VT_UInt8. More...
 
Variantoperator= (std::int16_t value)
 Assignment operator for implicit type conversion to VT_Int16. More...
 
Variantoperator= (std::uint16_t value)
 Assignment operator for implicit type conversion to VT_UInt16. More...
 
Variantoperator= (std::int32_t value)
 Assignment operator for implicit type conversion to VT_Int32. More...
 
Variantoperator= (std::uint32_t value)
 Assignment operator for implicit type conversion to VT_UInt32. More...
 
Variantoperator= (std::int64_t value)
 Assignment operator for implicit type conversion to VT_Int64. More...
 
Variantoperator= (std::uint64_t value)
 Assignment operator for implicit type conversion to VT_UInt64. More...
 
Variantoperator= (float value)
 Assignment operator for implicit type conversion to VT_Float. More...
 
Variantoperator= (double value)
 Assignment operator for implicit type conversion to VT_Double. More...
 
Variantoperator= (const char *value)
 Assignment operator for implicit type conversion to VT_String. More...
 

Private Attributes

std::unique_ptr< Implementation > _impl
 

Detailed Description

Container type, able to store any primitive data type (and arrays thereof)

Definition at line 46 of file workspace/conan/dev_essential/1.3.3/dw/stable/package/37682420cd166e229516a41c8d6a139a0b13e1e1/include/a_util/variant/variant.h.

Constructor & Destructor Documentation

◆ Variant() [1/14]

Variant ( bool  value)

CTOR: VT_Bool.

Parameters
[in]valueValue of the variant

◆ Variant() [2/14]

Variant ( std::int8_t  value)

CTOR: VT_Int8.

Parameters
[in]valueValue of the variant

◆ Variant() [3/14]

Variant ( std::uint8_t  value)

CTOR: VT_UInt8.

Parameters
[in]valueValue of the variant

◆ Variant() [4/14]

Variant ( std::int16_t  value)

CTOR: VT_Int16.

Parameters
[in]valueValue of the variant

◆ Variant() [5/14]

Variant ( std::uint16_t  value)

CTOR: VT_UInt16.

Parameters
[in]valueValue of the variant

◆ Variant() [6/14]

Variant ( std::int32_t  value)

CTOR: VT_Int32.

Parameters
[in]valueValue of the variant

◆ Variant() [7/14]

Variant ( std::uint32_t  value)

CTOR: VT_UInt32.

Parameters
[in]valueValue of the variant

◆ Variant() [8/14]

Variant ( std::int64_t  value)

CTOR: VT_Int64.

Parameters
[in]valueValue of the variant

◆ Variant() [9/14]

Variant ( std::uint64_t  value)

CTOR: VT_UInt64.

Parameters
[in]valueValue of the variant

◆ Variant() [10/14]

Variant ( float  value)

CTOR: VT_Float32.

Parameters
[in]valueValue of the variant

◆ Variant() [11/14]

Variant ( double  value)

CTOR: VT_Float64.

Parameters
[in]valueValue of the variant

◆ Variant() [12/14]

Variant ( const char *  value)

CTOR: VT_String.

Parameters
[in]valueValue of the variant

◆ Variant() [13/14]

Variant ( const Variant other)

Copy CTOR.

Parameters
[in]otherOther variant object to copy construct *this from

◆ Variant() [14/14]

Variant ( Variant &&  other)
noexcept

Move CTOR.

Parameters
[in,out]otherMoved-from object *this is constructed from. Left in a valid but unspecified state. Should not be used after this move ctor returns

Member Function Documentation

◆ asBool()

bool asBool ( ) const

Convert the value of the variant.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ asDouble()

double asDouble ( ) const

Convert the value of the variant.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ asFloat()

float asFloat ( ) const

Convert the value of the variant.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ asInt16()

std::int16_t asInt16 ( ) const

Convert the value of the variant.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ asInt32()

std::int32_t asInt32 ( ) const

Convert the value of the variant.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ asInt64()

std::int64_t asInt64 ( ) const

Convert the value of the variant.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ asInt8()

std::int8_t asInt8 ( ) const

Convert the value of the variant.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ asString()

std::string asString ( ) const

Convert the value of the variant.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

Referenced by ddl::access_element::getValueAsString().

◆ asUInt16()

std::uint16_t asUInt16 ( ) const

Convert the value of the variant.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ asUInt32()

std::uint32_t asUInt32 ( ) const

Convert the value of the variant.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ asUInt64()

std::uint64_t asUInt64 ( ) const

Convert the value of the variant.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ asUInt8()

std::uint8_t asUInt8 ( ) const

Convert the value of the variant.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ getArraySize()

std::size_t getArraySize ( ) const

Get the current array size of the instance.

Note
For VT_String the array size is always 0

◆ getBool()

bool getBool ( std::size_t  array_index = 0) const

Get current value or alternatively from an array index of the variants value.

Parameters
[in]array_indexIndex of the value to retrieve from the array (default: 0). Must be zero, if variant is not an array.
Returns
The value
Exceptions
std::runtime_errorIf variant type is different to the requested type
std::out_of_rangeIf array_index is out of range or the variant is not an array

◆ getDouble()

double getDouble ( std::size_t  array_index = 0) const

Get current value or alternatively from an array index of the variants value.

Parameters
[in]array_indexIndex of the value to retrieve from the array (default: 0). Must be zero, if variant is not an array.
Returns
The value
Exceptions
std::runtime_errorIf variant type is different to the requested type
std::out_of_rangeIf array_index is out of range or the variant is not an array

◆ getFloat()

float getFloat ( std::size_t  array_index = 0) const

Get current value or alternatively from an array index of the variants value.

Parameters
[in]array_indexIndex of the value to retrieve from the array (default: 0). Must be zero, if variant is not an array.
Returns
The value
Exceptions
std::runtime_errorIf variant type is different to the requested type
std::out_of_rangeIf array_index is out of range or the variant is not an array

◆ getFloat32()

float getFloat32 ( std::size_t  array_index = 0) const

Get current value or alternatively from an array index of the variants value.

Parameters
[in]array_indexIndex of the value to retrieve from the array (default: 0). Must be zero, if variant is not an array.
Returns
The value
Exceptions
std::runtime_errorIf variant type is different to the requested type
std::out_of_rangeIf array_index is out of range or the variant is not an array

◆ getFloat64()

double getFloat64 ( std::size_t  array_index = 0) const

Get current value or alternatively from an array index of the variants value.

Parameters
[in]array_indexIndex of the value to retrieve from the array (default: 0). Must be zero, if variant is not an array.
Returns
The value
Exceptions
std::runtime_errorIf variant type is different to the requested type
std::out_of_rangeIf array_index is out of range or the variant is not an array

◆ getInt16()

std::int16_t getInt16 ( std::size_t  array_index = 0) const

Get current value or alternatively from an array index of the variants value.

Parameters
[in]array_indexIndex of the value to retrieve from the array (default: 0). Must be zero, if variant is not an array.
Returns
The value
Exceptions
std::runtime_errorIf variant type is different to the requested type
std::out_of_rangeIf array_index is out of range or the variant is not an array

◆ getInt32()

std::int32_t getInt32 ( std::size_t  array_index = 0) const

Get current value or alternatively from an array index of the variants value.

Parameters
[in]array_indexIndex of the value to retrieve from the array (default: 0). Must be zero, if variant is not an array.
Returns
The value
Exceptions
std::runtime_errorIf variant type is different to the requested type
std::out_of_rangeIf array_index is out of range or the variant is not an array

◆ getInt64()

std::int64_t getInt64 ( std::size_t  array_index = 0) const

Get current value or alternatively from an array index of the variants value.

Parameters
[in]array_indexIndex of the value to retrieve from the array (default: 0). Must be zero, if variant is not an array.
Returns
The value
Exceptions
std::runtime_errorIf variant type is different to the requested type
std::out_of_rangeIf array_index is out of range or the variant is not an array

◆ getInt8()

std::int8_t getInt8 ( std::size_t  array_index = 0) const

Get current value or alternatively from an array index of the variants value.

Parameters
[in]array_indexIndex of the value to retrieve from the array (default: 0). Must be zero, if variant is not an array.
Returns
The value
Exceptions
std::runtime_errorIf variant type is different to the requested type
std::out_of_rangeIf array_index is out of range or the variant is not an array

◆ getString()

const char* getString ( ) const

Get current string value.

Returns
The value
Exceptions
std::runtime_errorIf variant type is different to the requested type

◆ getUInt16()

std::uint16_t getUInt16 ( std::size_t  array_index = 0) const

Get current value or alternatively from an array index of the variants value.

Parameters
[in]array_indexIndex of the value to retrieve from the array (default: 0). Must be zero, if variant is not an array.
Returns
The value
Exceptions
std::runtime_errorIf variant type is different to the requested type
std::out_of_rangeIf array_index is out of range or the variant is not an array

◆ getUInt32()

std::uint32_t getUInt32 ( std::size_t  array_index = 0) const

Get current value or alternatively from an array index of the variants value.

Parameters
[in]array_indexIndex of the value to retrieve from the array (default: 0). Must be zero, if variant is not an array.
Returns
The value
Exceptions
std::runtime_errorIf variant type is different to the requested type
std::out_of_rangeIf array_index is out of range or the variant is not an array

◆ getUInt64()

std::uint64_t getUInt64 ( std::size_t  array_index = 0) const

Get current value or alternatively from an array index of the variants value.

Parameters
[in]array_indexIndex of the value to retrieve from the array (default: 0). Must be zero, if variant is not an array.
Returns
The value
Exceptions
std::runtime_errorIf variant type is different to the requested type
std::out_of_rangeIf array_index is out of range or the variant is not an array

◆ getUInt8()

std::uint8_t getUInt8 ( std::size_t  array_index = 0) const

Get current value or alternatively from an array index of the variants value.

Parameters
[in]array_indexIndex of the value to retrieve from the array (default: 0). Must be zero, if variant is not an array.
Returns
The value
Exceptions
std::runtime_errorIf variant type is different to the requested type
std::out_of_rangeIf array_index is out of range or the variant is not an array

◆ operator bool()

operator bool ( ) const

Explicit conversion of the value of the variant to VT_Bool.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ operator double()

operator double ( ) const

Explicit conversion of the value of the variant to VT_Double.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ operator float()

operator float ( ) const

Explicit conversion of the value of the variant to VT_Float.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ operator std::int16_t()

operator std::int16_t ( ) const

Explicit conversion of the value of the variant to VT_Int16.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ operator std::int32_t()

operator std::int32_t ( ) const

Explicit conversion of the value of the variant to VT_Int32.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ operator std::int64_t()

operator std::int64_t ( ) const

Explicit conversion of the value of the variant to VT_Int64.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ operator std::int8_t()

operator std::int8_t ( ) const

Explicit conversion of the value of the variant to VT_Int8.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ operator std::string()

operator std::string ( ) const

Explicit conversion of the value of the variant to VT_String.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ operator std::uint16_t()

operator std::uint16_t ( ) const

Explicit conversion of the value of the variant to VT_UInt16.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ operator std::uint32_t()

operator std::uint32_t ( ) const

Explicit conversion of the value of the variant to VT_UInt32.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ operator std::uint64_t()

operator std::uint64_t ( ) const

Explicit conversion of the value of the variant to VT_UInt64.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ operator std::uint8_t()

operator std::uint8_t ( ) const

Explicit conversion of the value of the variant to VT_UInt8.

Returns
The value after conversion to the new type
Exceptions
std::runtime_errorIf variant is either VT_Empty or the type is unknown

◆ operator=() [1/14]

Variant& operator= ( bool  value)

Assignment operator for implicit type conversion to VT_Bool.

Parameters
[in]valueOther value to assign *this from
Returns
*this

◆ operator=() [2/14]

Variant& operator= ( const char *  value)

Assignment operator for implicit type conversion to VT_String.

Parameters
[in]valueOther value to assign *this from
Returns
*this

◆ operator=() [3/14]

Variant& operator= ( const Variant other)

Assignment operator.

Parameters
[in]otherOther object to assign *this from
Returns
*this

◆ operator=() [4/14]

Variant& operator= ( double  value)

Assignment operator for implicit type conversion to VT_Double.

Parameters
[in]valueOther value to assign *this from
Returns
*this

◆ operator=() [5/14]

Variant& operator= ( float  value)

Assignment operator for implicit type conversion to VT_Float.

Parameters
[in]valueOther value to assign *this from
Returns
*this

◆ operator=() [6/14]

Variant& operator= ( std::int16_t  value)

Assignment operator for implicit type conversion to VT_Int16.

Parameters
[in]valueOther value to assign *this from
Returns
*this

◆ operator=() [7/14]

Variant& operator= ( std::int32_t  value)

Assignment operator for implicit type conversion to VT_Int32.

Parameters
[in]valueOther value to assign *this from
Returns
*this

◆ operator=() [8/14]

Variant& operator= ( std::int64_t  value)

Assignment operator for implicit type conversion to VT_Int64.

Parameters
[in]valueOther value to assign *this from
Returns
*this

◆ operator=() [9/14]

Variant& operator= ( std::int8_t  value)

Assignment operator for implicit type conversion to VT_Int8.

Parameters
[in]valueOther value to assign *this from
Returns
*this

◆ operator=() [10/14]

Variant& operator= ( std::uint16_t  value)

Assignment operator for implicit type conversion to VT_UInt16.

Parameters
[in]valueOther value to assign *this from
Returns
*this

◆ operator=() [11/14]

Variant& operator= ( std::uint32_t  value)

Assignment operator for implicit type conversion to VT_UInt32.

Parameters
[in]valueOther value to assign *this from
Returns
*this

◆ operator=() [12/14]

Variant& operator= ( std::uint64_t  value)

Assignment operator for implicit type conversion to VT_UInt64.

Parameters
[in]valueOther value to assign *this from
Returns
*this

◆ operator=() [13/14]

Variant& operator= ( std::uint8_t  value)

Assignment operator for implicit type conversion to VT_UInt8.

Parameters
[in]valueOther value to assign *this from
Returns
*this

◆ operator=() [14/14]

Variant& operator= ( Variant &&  other)
noexcept

Move assignment.

Parameters
[in,out]otherMoved-from object *this is assigned from. Left in a valid but unspecified state. Should not be used after this assignment operator returns.
Return values
*this

◆ reset() [1/23]

void reset ( bool  value)

Resets the instance to VT_Bool.

Parameters
[in]valueValue of the variant

◆ reset() [2/23]

void reset ( const bool *  array_storage,
std::size_t  array_size 
)

Resets the instance to an array of VT_Bool.

Parameters
[in]array_storagePointer to begin of the array
[in]array_sizeSize of the array array_storage points to
Exceptions
std::invalid_argumentif either array_storage is nullptr or array_size is zero

◆ reset() [3/23]

void reset ( const char *  value)

Resets the instance to VT_String.

Parameters
[in]valueValue of the variant

◆ reset() [4/23]

void reset ( const double *  array_storage,
std::size_t  array_size 
)

Resets the instance to an array of VT_Double.

Parameters
[in]array_storagePointer to begin of the array
[in]array_sizeSize of the array array_storage points to
Exceptions
std::invalid_argumentif either array_storage is nullptr or array_size is zero

◆ reset() [5/23]

void reset ( const float *  array_storage,
std::size_t  array_size 
)

Resets the instance to an array of VT_Float.

Parameters
[in]array_storagePointer to begin of the array
[in]array_sizeSize of the array array_storage points to
Exceptions
std::invalid_argumentif either array_storage is nullptr or array_size is zero

◆ reset() [6/23]

void reset ( const std::int16_t *  array_storage,
std::size_t  array_size 
)

Resets the instance to an array of VT_Int16.

Parameters
[in]array_storagePointer to begin of the array
[in]array_sizeSize of the array array_storage points to
Exceptions
std::invalid_argumentif either array_storage is nullptr or array_size is zero

◆ reset() [7/23]

void reset ( const std::int32_t *  array_storage,
std::size_t  array_size 
)

Resets the instance to an array of VT_Int32.

Parameters
[in]array_storagePointer to begin of the array
[in]array_sizeSize of the array array_storage points to
Exceptions
std::invalid_argumentif either array_storage is nullptr or array_size is zero

◆ reset() [8/23]

void reset ( const std::int64_t *  array_storage,
std::size_t  array_size 
)

Resets the instance to an array of VT_Int64.

Parameters
[in]array_storagePointer to begin of the array
[in]array_sizeSize of the array array_storage points to
Exceptions
std::invalid_argumentif either array_storage is nullptr or array_size is zero

◆ reset() [9/23]

void reset ( const std::int8_t *  array_storage,
std::size_t  array_size 
)

Resets the instance to an array of VT_Int8.

Parameters
[in]array_storagePointer to begin of the array
[in]array_sizeSize of the array array_storage points to
Exceptions
std::invalid_argumentif either array_storage is nullptr or array_size is zero

◆ reset() [10/23]

void reset ( const std::uint16_t *  array_storage,
std::size_t  array_size 
)

Resets the instance to an array of VT_UInt16.

Parameters
[in]array_storagePointer to begin of the array
[in]array_sizeSize of the array array_storage points to
Exceptions
std::invalid_argumentif either array_storage is nullptr or array_size is zero

◆ reset() [11/23]

void reset ( const std::uint32_t *  array_storage,
std::size_t  array_size 
)

Resets the instance to an array of VT_UInt32.

Parameters
[in]array_storagePointer to begin of the array
[in]array_sizeSize of the array array_storage points to
Exceptions
std::invalid_argumentif either array_storage is nullptr or array_size is zero

◆ reset() [12/23]

void reset ( const std::uint64_t *  array_storage,
std::size_t  array_size 
)

Resets the instance to an array of VT_UInt64.

Parameters
[in]array_storagePointer to begin of the array
[in]array_sizeSize of the array array_storage points to
Exceptions
std::invalid_argumentif either array_storage is nullptr or array_size is zero

◆ reset() [13/23]

void reset ( const std::uint8_t *  array_storage,
std::size_t  array_size 
)

Resets the instance to an array of VT_UInt8.

Parameters
[in]array_storagePointer to begin of the array
[in]array_sizeSize of the array array_storage points to
Exceptions
std::invalid_argumentif either array_storage is nullptr or array_size is zero

◆ reset() [14/23]

void reset ( double  value)

Resets the instance to VT_Double.

Parameters
[in]valueValue of the variant

◆ reset() [15/23]

void reset ( float  value)

Resets the instance to VT_Float.

Parameters
[in]valueValue of the variant

◆ reset() [16/23]

void reset ( std::int16_t  value)

Resets the instance to VT_Int16.

Parameters
[in]valueValue of the variant

◆ reset() [17/23]

void reset ( std::int32_t  value)

Resets the instance to VT_Int32.

Parameters
[in]valueValue of the variant

◆ reset() [18/23]

void reset ( std::int64_t  value)

Resets the instance to VT_Int64.

Parameters
[in]valueValue of the variant

◆ reset() [19/23]

void reset ( std::int8_t  value)

Resets the instance to VT_Int8.

Parameters
[in]valueValue of the variant

◆ reset() [20/23]

void reset ( std::uint16_t  value)

Resets the instance to VT_UInt16.

Parameters
[in]valueValue of the variant

◆ reset() [21/23]

void reset ( std::uint32_t  value)

Resets the instance to VT_UInt32.

Parameters
[in]valueValue of the variant

◆ reset() [22/23]

void reset ( std::uint64_t  value)

Resets the instance to VT_UInt64.

Parameters
[in]valueValue of the variant

◆ reset() [23/23]

void reset ( std::uint8_t  value)

Resets the instance to VT_UInt8.

Parameters
[in]valueValue of the variant