VTK
9.4.20241214
|
A type representing the union of many types. More...
#include <vtkVariant.h>
Public Types | |
enum | StringFormatting { DEFAULT_FORMATTING = 0 , FIXED_FORMATTING = 1 , SCIENTIFIC_FORMATTING = 2 } |
Public Member Functions | |
vtkVariant () | |
Create an invalid variant. | |
~vtkVariant () | |
Destruct the variant. | |
vtkVariant (const vtkVariant &other) | |
Copy constructor. | |
vtkVariant (bool value) | |
Create a bool variant. | |
vtkVariant (char value) | |
Create a char variant. | |
vtkVariant (unsigned char value) | |
Create an unsigned char variant. | |
vtkVariant (signed char value) | |
Create a signed char variant. | |
vtkVariant (short value) | |
Create a short variant. | |
vtkVariant (unsigned short value) | |
Create an unsigned short variant. | |
vtkVariant (int value) | |
Create an integer variant. | |
vtkVariant (unsigned int value) | |
Create an unsigned integer variant. | |
vtkVariant (long value) | |
Create an long variant. | |
vtkVariant (unsigned long value) | |
Create an unsigned long variant. | |
vtkVariant (long long value) | |
Create a long long variant. | |
vtkVariant (unsigned long long value) | |
Create an unsigned long long variant. | |
vtkVariant (float value) | |
Create a float variant. | |
vtkVariant (double value) | |
Create a double variant. | |
vtkVariant (const char *value) | |
Create a string variant from a const char*. | |
vtkVariant (vtkStdString value) | |
Create a string variant from a std string. | |
vtkVariant (vtkObjectBase *value) | |
Create a vtkObjectBase variant. | |
vtkVariant (const vtkVariant &other, unsigned int type) | |
Create a new variant by copying the given variant but converting it to the given type. | |
vtkVariant & | operator= (const vtkVariant &other) |
Copy the value of one variant into another. | |
bool | IsValid () const |
Get whether the variant value is valid. | |
bool | IsString () const |
Get whether the variant is a string. | |
bool | IsNumeric () const |
Get whether the variant is any numeric type. | |
bool | IsFloat () const |
Get whether the variant is a float. | |
bool | IsDouble () const |
Get whether the variant is a double. | |
bool | IsChar () const |
Get whether the variant is an char. | |
bool | IsUnsignedChar () const |
Get whether the variant is an unsigned char. | |
bool | IsSignedChar () const |
Get whether the variant is an signed char. | |
bool | IsShort () const |
Get whether the variant is an short. | |
bool | IsUnsignedShort () const |
Get whether the variant is an unsigned short. | |
bool | IsInt () const |
Get whether the variant is an int. | |
bool | IsUnsignedInt () const |
Get whether the variant is an unsigned int. | |
bool | IsLong () const |
Get whether the variant is an long. | |
bool | IsUnsignedLong () const |
Get whether the variant is an unsigned long. | |
bool | IsLongLong () const |
Get whether the variant is long long. | |
bool | IsUnsignedLongLong () const |
Get whether the variant is unsigned long long. | |
bool | IsVTKObject () const |
Get whether the variant is a VTK object pointer (i.e. | |
bool | IsArray () const |
Get whether the variant is a VTK array (i.e. | |
unsigned int | GetType () const |
Get the type of the variant. | |
const char * | GetTypeAsString () const |
Get the type of the variant as a string. | |
vtkStdString | ToString (int formatting=DEFAULT_FORMATTING, int precision=6) const |
Convert the variant to a string. | |
vtkObjectBase * | ToVTKObject () const |
Return the VTK object, or nullptr if not of that type. | |
vtkAbstractArray * | ToArray () const |
Return the array, or nullptr if not of that type. | |
bool | IsEqual (const vtkVariant &other) const |
Determines whether two variants have the same value. | |
float | ToFloat (bool *valid) const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
float | ToFloat () const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
double | ToDouble (bool *valid) const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
double | ToDouble () const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
char | ToChar (bool *valid) const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
char | ToChar () const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
unsigned char | ToUnsignedChar (bool *valid) const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
unsigned char | ToUnsignedChar () const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
signed char | ToSignedChar (bool *valid) const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
signed char | ToSignedChar () const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
short | ToShort (bool *valid) const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
short | ToShort () const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
unsigned short | ToUnsignedShort (bool *valid) const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
unsigned short | ToUnsignedShort () const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
int | ToInt (bool *valid) const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
int | ToInt () const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
unsigned int | ToUnsignedInt (bool *valid) const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
unsigned int | ToUnsignedInt () const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
long | ToLong (bool *valid) const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
long | ToLong () const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
unsigned long | ToUnsignedLong (bool *valid) const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
unsigned long | ToUnsignedLong () const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
long long | ToLongLong (bool *valid) const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
long long | ToLongLong () const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
unsigned long long | ToUnsignedLongLong (bool *valid) const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
unsigned long long | ToUnsignedLongLong () const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
vtkTypeInt64 | ToTypeInt64 (bool *valid) const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
vtkTypeInt64 | ToTypeInt64 () const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
vtkTypeUInt64 | ToTypeUInt64 (bool *valid) const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
vtkTypeUInt64 | ToTypeUInt64 () const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type. | |
bool | operator== (const vtkVariant &other) const |
Compare two variants for equality, greater than, and less than. | |
bool | operator!= (const vtkVariant &other) const |
Compare two variants for equality, greater than, and less than. | |
bool | operator< (const vtkVariant &other) const |
Compare two variants for equality, greater than, and less than. | |
bool | operator> (const vtkVariant &other) const |
Compare two variants for equality, greater than, and less than. | |
bool | operator<= (const vtkVariant &other) const |
Compare two variants for equality, greater than, and less than. | |
bool | operator>= (const vtkVariant &other) const |
Compare two variants for equality, greater than, and less than. | |
Friends | |
struct | vtkVariantLessThan |
struct | vtkVariantEqual |
struct | vtkVariantStrictWeakOrder |
struct | vtkVariantStrictEquality |
VTKCOMMONCORE_EXPORT ostream & | operator<< (ostream &os, const vtkVariant &val) |
A type representing the union of many types.
Definition at line 161 of file vtkVariant.h.
Enumerator | |
---|---|
DEFAULT_FORMATTING | |
FIXED_FORMATTING | |
SCIENTIFIC_FORMATTING |
Definition at line 391 of file vtkVariant.h.
vtkVariant::vtkVariant | ( | ) |
Create an invalid variant.
The type will be VTK_VOID and IsValid will return false.
vtkVariant::~vtkVariant | ( | ) |
Destruct the variant.
For the VTK_STRING case, invokes delete on the string. For the VTK_OBJECT case, invokes Delete() on the object.
vtkVariant::vtkVariant | ( | const vtkVariant & | other | ) |
Copy constructor.
vtkVariant::vtkVariant | ( | bool | value | ) |
Create a bool variant.
Internally store it as char. The type will be VTK_CHAR and IsValid will return true.
vtkVariant::vtkVariant | ( | char | value | ) |
Create a char variant.
The type will be VTK_CHAR and IsValid will return true.
vtkVariant::vtkVariant | ( | unsigned char | value | ) |
Create an unsigned char variant.
The type will be VTK_UNSIGNED_CHAR and IsValid will return true.
vtkVariant::vtkVariant | ( | signed char | value | ) |
Create a signed char variant.
The type will be VTK_SIGNED_CHAR and IsValid will return true.
vtkVariant::vtkVariant | ( | short | value | ) |
Create a short variant.
The type will be VTK_SHORT and IsValid will return true.
vtkVariant::vtkVariant | ( | unsigned short | value | ) |
Create an unsigned short variant.
The type will be VTK_UNSIGNED_SHORT and IsValid will return true.
vtkVariant::vtkVariant | ( | int | value | ) |
Create an integer variant.
The type will be VTK_INT and IsValid will return true.
vtkVariant::vtkVariant | ( | unsigned int | value | ) |
Create an unsigned integer variant.
The type will be VTK_UNSIGNED_INT and IsValid will return true.
vtkVariant::vtkVariant | ( | long | value | ) |
Create an long variant.
The type will be VTK_LONG and IsValid will return true.
vtkVariant::vtkVariant | ( | unsigned long | value | ) |
Create an unsigned long variant.
The type will be VTK_UNSIGNED_LONG and IsValid will return true.
vtkVariant::vtkVariant | ( | long long | value | ) |
Create a long long variant.
The type will be VTK_LONG_LONG and IsValid will return true.
vtkVariant::vtkVariant | ( | unsigned long long | value | ) |
Create an unsigned long long variant.
The type will be VTK_UNSIGNED_LONG_LONG and IsValid will return true.
vtkVariant::vtkVariant | ( | float | value | ) |
Create a float variant.
The type will be VTK_FLOAT and IsValid will return true.
vtkVariant::vtkVariant | ( | double | value | ) |
Create a double variant.
The type will be VTK_DOUBLE and IsValid will return true.
vtkVariant::vtkVariant | ( | const char * | value | ) |
Create a string variant from a const char*.
If nullptr is passed, the type will be VTK_VOID and IsValid will return false; else the type will be VTK_STRING and IsValid will return true.
vtkVariant::vtkVariant | ( | vtkStdString | value | ) |
Create a string variant from a std string.
The type will be VTK_STRING and IsValid will return true.
vtkVariant::vtkVariant | ( | vtkObjectBase * | value | ) |
Create a vtkObjectBase variant.
If nullptr is passed, the type will be VTK_VOID and IsValid will return false; else the type will be VTK_OBJECT and IsValid will return true.
vtkVariant::vtkVariant | ( | const vtkVariant & | other, |
unsigned int | type | ||
) |
Create a new variant by copying the given variant but converting it to the given type.
type
must be one of: VTK_STRING, VTK_OBJECT, VTK_CHAR, VTK_SIGNED_CHAR, VTK_UNSIGNED_CHAR, VTK_SHORT, VTK_UNSIGNED_SHORT, VTK_INT, VTK_UNSIGNED_INT, VTK_LONG, VTK_UNSIGNED_LONG, VTK_LONG_LONG, VTK_UNSIGNED_LONG_LONG, VTK_FLOAT, VTK_DOUBLE.
vtkVariant & vtkVariant::operator= | ( | const vtkVariant & | other | ) |
Copy the value of one variant into another.
bool vtkVariant::IsValid | ( | ) | const |
Get whether the variant value is valid.
Simple scalar types are always considered valid. Strings and pointers are considered valid only if non-nullptr.
bool vtkVariant::IsString | ( | ) | const |
Get whether the variant is a string.
bool vtkVariant::IsNumeric | ( | ) | const |
Get whether the variant is any numeric type.
bool vtkVariant::IsFloat | ( | ) | const |
Get whether the variant is a float.
bool vtkVariant::IsDouble | ( | ) | const |
Get whether the variant is a double.
bool vtkVariant::IsChar | ( | ) | const |
Get whether the variant is an char.
bool vtkVariant::IsUnsignedChar | ( | ) | const |
Get whether the variant is an unsigned char.
bool vtkVariant::IsSignedChar | ( | ) | const |
Get whether the variant is an signed char.
bool vtkVariant::IsShort | ( | ) | const |
Get whether the variant is an short.
bool vtkVariant::IsUnsignedShort | ( | ) | const |
Get whether the variant is an unsigned short.
bool vtkVariant::IsInt | ( | ) | const |
Get whether the variant is an int.
bool vtkVariant::IsUnsignedInt | ( | ) | const |
Get whether the variant is an unsigned int.
bool vtkVariant::IsLong | ( | ) | const |
Get whether the variant is an long.
bool vtkVariant::IsUnsignedLong | ( | ) | const |
Get whether the variant is an unsigned long.
bool vtkVariant::IsLongLong | ( | ) | const |
Get whether the variant is long long.
bool vtkVariant::IsUnsignedLongLong | ( | ) | const |
Get whether the variant is unsigned long long.
bool vtkVariant::IsVTKObject | ( | ) | const |
Get whether the variant is a VTK object pointer (i.e.
vtkObjectBase or a subclass thereof).
bool vtkVariant::IsArray | ( | ) | const |
Get whether the variant is a VTK array (i.e.
vtkAbstractArray or a subclass thereof).
unsigned int vtkVariant::GetType | ( | ) | const |
Get the type of the variant.
const char * vtkVariant::GetTypeAsString | ( | ) | const |
Get the type of the variant as a string.
vtkStdString vtkVariant::ToString | ( | int | formatting = DEFAULT_FORMATTING , |
int | precision = 6 |
||
) | const |
Convert the variant to a string.
Set the formatting argument to either DEFAULT_FORMATTING, FIXED_FORMATTING, SCIENTIFIC_FORMATTING to control the formatting. Set the precision argument to control the precision of the output. These two parameters have no effect when the variant is not a floating-point value or an array of floating-point values. See the std doc for more information.
float vtkVariant::ToFloat | ( | bool * | valid | ) | const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
|
inline |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
Definition at line 419 of file vtkVariant.h.
double vtkVariant::ToDouble | ( | bool * | valid | ) | const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
|
inline |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
Definition at line 421 of file vtkVariant.h.
char vtkVariant::ToChar | ( | bool * | valid | ) | const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
|
inline |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
Definition at line 423 of file vtkVariant.h.
unsigned char vtkVariant::ToUnsignedChar | ( | bool * | valid | ) | const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
|
inline |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
Definition at line 425 of file vtkVariant.h.
signed char vtkVariant::ToSignedChar | ( | bool * | valid | ) | const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
|
inline |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
Definition at line 427 of file vtkVariant.h.
short vtkVariant::ToShort | ( | bool * | valid | ) | const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
|
inline |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
Definition at line 429 of file vtkVariant.h.
unsigned short vtkVariant::ToUnsignedShort | ( | bool * | valid | ) | const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
|
inline |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
Definition at line 431 of file vtkVariant.h.
int vtkVariant::ToInt | ( | bool * | valid | ) | const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
|
inline |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
Definition at line 433 of file vtkVariant.h.
unsigned int vtkVariant::ToUnsignedInt | ( | bool * | valid | ) | const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
|
inline |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
Definition at line 435 of file vtkVariant.h.
long vtkVariant::ToLong | ( | bool * | valid | ) | const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
|
inline |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
Definition at line 437 of file vtkVariant.h.
unsigned long vtkVariant::ToUnsignedLong | ( | bool * | valid | ) | const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
|
inline |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
Definition at line 439 of file vtkVariant.h.
long long vtkVariant::ToLongLong | ( | bool * | valid | ) | const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
|
inline |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
Definition at line 441 of file vtkVariant.h.
unsigned long long vtkVariant::ToUnsignedLongLong | ( | bool * | valid | ) | const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
|
inline |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
Definition at line 443 of file vtkVariant.h.
vtkTypeInt64 vtkVariant::ToTypeInt64 | ( | bool * | valid | ) | const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
|
inline |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
Definition at line 445 of file vtkVariant.h.
vtkTypeUInt64 vtkVariant::ToTypeUInt64 | ( | bool * | valid | ) | const |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
|
inline |
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type.
If it holds a string, attempt to convert the string to the appropriate type; set the valid flag to false when the conversion fails. If it holds an array type, cast the first value of the array to the appropriate type. Fail if it holds a VTK object which is not an array.
Definition at line 447 of file vtkVariant.h.
vtkObjectBase * vtkVariant::ToVTKObject | ( | ) | const |
Return the VTK object, or nullptr if not of that type.
vtkAbstractArray * vtkVariant::ToArray | ( | ) | const |
Return the array, or nullptr if not of that type.
bool vtkVariant::IsEqual | ( | const vtkVariant & | other | ) | const |
Determines whether two variants have the same value.
They do not need to be storing exactly the same type to have the same value. In practice you don't need to use this method: just use operator== instead. If you want precise equality down to the bit level use the following idiom:
vtkVariantStrictEquality comparator; bool variantsEqual = comparator(firstVariant, secondVariant);
|
inline |
Compare two variants for equality, greater than, and less than.
These operators use the value represented by the variant instead of the particular type/bit pattern used to represent it. This behavior is similar to the default behavior in C and C++, including type promotion, with the following caveats:
This approach follows the principle of least surprise at the expense of speed. Casting integers to floating-point values is relatively slow. Casting numeric types to strings is very slow. If you prefer speed at the expense of counterintuitive behavior – for example, when using vtkVariants as keys in STL containers – you can use the functors described at the bottom of this file.
The actual definitions of these operators are in vtkVariantInlineOperators.cxx.
Definition at line 94 of file vtkVariantInlineOperators.h.
|
inline |
Compare two variants for equality, greater than, and less than.
These operators use the value represented by the variant instead of the particular type/bit pattern used to represent it. This behavior is similar to the default behavior in C and C++, including type promotion, with the following caveats:
This approach follows the principle of least surprise at the expense of speed. Casting integers to floating-point values is relatively slow. Casting numeric types to strings is very slow. If you prefer speed at the expense of counterintuitive behavior – for example, when using vtkVariants as keys in STL containers – you can use the functors described at the bottom of this file.
The actual definitions of these operators are in vtkVariantInlineOperators.cxx.
Definition at line 238 of file vtkVariantInlineOperators.h.
|
inline |
Compare two variants for equality, greater than, and less than.
These operators use the value represented by the variant instead of the particular type/bit pattern used to represent it. This behavior is similar to the default behavior in C and C++, including type promotion, with the following caveats:
This approach follows the principle of least surprise at the expense of speed. Casting integers to floating-point values is relatively slow. Casting numeric types to strings is very slow. If you prefer speed at the expense of counterintuitive behavior – for example, when using vtkVariants as keys in STL containers – you can use the functors described at the bottom of this file.
The actual definitions of these operators are in vtkVariantInlineOperators.cxx.
Definition at line 162 of file vtkVariantInlineOperators.h.
|
inline |
Compare two variants for equality, greater than, and less than.
These operators use the value represented by the variant instead of the particular type/bit pattern used to represent it. This behavior is similar to the default behavior in C and C++, including type promotion, with the following caveats:
This approach follows the principle of least surprise at the expense of speed. Casting integers to floating-point values is relatively slow. Casting numeric types to strings is very slow. If you prefer speed at the expense of counterintuitive behavior – for example, when using vtkVariants as keys in STL containers – you can use the functors described at the bottom of this file.
The actual definitions of these operators are in vtkVariantInlineOperators.cxx.
Definition at line 243 of file vtkVariantInlineOperators.h.
|
inline |
Compare two variants for equality, greater than, and less than.
These operators use the value represented by the variant instead of the particular type/bit pattern used to represent it. This behavior is similar to the default behavior in C and C++, including type promotion, with the following caveats:
This approach follows the principle of least surprise at the expense of speed. Casting integers to floating-point values is relatively slow. Casting numeric types to strings is very slow. If you prefer speed at the expense of counterintuitive behavior – for example, when using vtkVariants as keys in STL containers – you can use the functors described at the bottom of this file.
The actual definitions of these operators are in vtkVariantInlineOperators.cxx.
Definition at line 248 of file vtkVariantInlineOperators.h.
|
inline |
Compare two variants for equality, greater than, and less than.
These operators use the value represented by the variant instead of the particular type/bit pattern used to represent it. This behavior is similar to the default behavior in C and C++, including type promotion, with the following caveats:
This approach follows the principle of least surprise at the expense of speed. Casting integers to floating-point values is relatively slow. Casting numeric types to strings is very slow. If you prefer speed at the expense of counterintuitive behavior – for example, when using vtkVariants as keys in STL containers – you can use the functors described at the bottom of this file.
The actual definitions of these operators are in vtkVariantInlineOperators.cxx.
Definition at line 253 of file vtkVariantInlineOperators.h.
|
friend |
Definition at line 539 of file vtkVariant.h.
|
friend |
Definition at line 540 of file vtkVariant.h.
|
friend |
Definition at line 541 of file vtkVariant.h.
|
friend |
Definition at line 542 of file vtkVariant.h.
|
friend |
vtkStdString* vtkVariant::String |
Definition at line 519 of file vtkVariant.h.
float vtkVariant::Float |
Definition at line 520 of file vtkVariant.h.
double vtkVariant::Double |
Definition at line 521 of file vtkVariant.h.
char vtkVariant::Char |
Definition at line 522 of file vtkVariant.h.
unsigned char vtkVariant::UnsignedChar |
Definition at line 523 of file vtkVariant.h.
signed char vtkVariant::SignedChar |
Definition at line 524 of file vtkVariant.h.
short vtkVariant::Short |
Definition at line 525 of file vtkVariant.h.
unsigned short vtkVariant::UnsignedShort |
Definition at line 526 of file vtkVariant.h.
int vtkVariant::Int |
Definition at line 527 of file vtkVariant.h.
unsigned int vtkVariant::UnsignedInt |
Definition at line 528 of file vtkVariant.h.
long vtkVariant::Long |
Definition at line 529 of file vtkVariant.h.
unsigned long vtkVariant::UnsignedLong |
Definition at line 530 of file vtkVariant.h.
long long vtkVariant::LongLong |
Definition at line 531 of file vtkVariant.h.
unsigned long long vtkVariant::UnsignedLongLong |
Definition at line 532 of file vtkVariant.h.
vtkObjectBase* vtkVariant::VTKObject |
Definition at line 533 of file vtkVariant.h.