VTK
vtkVariantExtract.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkVariantExtract.h
5 
6 -------------------------------------------------------------------------
7  Copyright 2008 Sandia Corporation.
8  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9  the U.S. Government retains certain rights in this software.
10 -------------------------------------------------------------------------
11 
12  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
13  All rights reserved.
14  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
15 
16  This software is distributed WITHOUT ANY WARRANTY; without even
17  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
18  PURPOSE. See the above copyright notice for more information.
19 
20 =========================================================================*/
21 
35 #ifndef vtkVariantExtract_h
36 #define vtkVariantExtract_h
37 
38 #include <typeinfo> // for typeid
39 
40 template<typename T>
41 T vtkVariantExtract(const vtkVariant& value, bool& valid)
42 {
43  vtkGenericWarningMacro(
44  << "Cannot convert vtkVariant containing [" << value.GetTypeAsString() << "] "
45  << "to unsupported type [" << typeid(T).name() << "]. "
46  << "Create a vtkVariantExtract<> specialization to eliminate this warning."
47  );
48 
49  valid = false;
50 
51  static T dummy;
52  return dummy;
53 }
54 
55 template<>
56 inline char vtkVariantExtract<char>(const vtkVariant& value, bool& valid)
57 {
58  valid = value.IsChar();
59  return valid ? value.ToChar() : 0;
60 }
61 
62 template<>
63 inline unsigned char vtkVariantExtract<unsigned char>(const vtkVariant& value, bool& valid)
64 {
65  valid = value.IsUnsignedChar();
66  return valid ? value.ToUnsignedChar() : 0;
67 }
68 
69 template<>
70 inline short vtkVariantExtract<short>(const vtkVariant& value, bool& valid)
71 {
72  valid = value.IsShort();
73  return valid ? value.ToShort() : 0;
74 }
75 
76 template<>
77 inline unsigned short vtkVariantExtract<unsigned short>(const vtkVariant& value, bool& valid)
78 {
79  valid = value.IsUnsignedShort();
80  return valid ? value.ToUnsignedShort() : 0;
81 }
82 
83 template<>
84 inline int vtkVariantExtract<int>(const vtkVariant& value, bool& valid)
85 {
86  valid = value.IsInt();
87  return valid ? value.ToInt() : 0;
88 }
89 
90 template<>
91 inline unsigned int vtkVariantExtract<unsigned int>(const vtkVariant& value, bool& valid)
92 {
93  valid = value.IsUnsignedInt();
94  return valid ? value.ToUnsignedInt() : 0;
95 }
96 
97 template<>
98 inline long vtkVariantExtract<long>(const vtkVariant& value, bool& valid)
99 {
100  valid = value.IsLong();
101  return valid ? value.ToLong() : 0;
102 }
103 
104 template<>
105 inline unsigned long vtkVariantExtract<unsigned long>(const vtkVariant& value, bool& valid)
106 {
107  valid = value.IsUnsignedLong();
108  return valid ? value.ToUnsignedLong() : 0;
109 }
110 
111 template<>
112 inline long long vtkVariantExtract<long long>(const vtkVariant& value, bool& valid)
113 {
114  valid = value.IsLongLong();
115  return valid ? value.ToLongLong() : 0;
116 }
117 
118 template<>
119 inline unsigned long long vtkVariantExtract<unsigned long long>(const vtkVariant& value, bool& valid)
120 {
121  valid = value.IsUnsignedLongLong();
122  return valid ? value.ToUnsignedLongLong() : 0;
123 }
124 
125 template<>
126 inline float vtkVariantExtract<float>(const vtkVariant& value, bool& valid)
127 {
128  valid = value.IsFloat();
129  return valid ? value.ToFloat() : 0.0f;
130 }
131 
132 template<>
133 inline double vtkVariantExtract<double>(const vtkVariant& value, bool& valid)
134 {
135  valid = value.IsDouble();
136  return valid ? value.ToDouble() : 0.0;
137 }
138 
139 template<>
141 {
142  valid = value.IsString();
143  return valid ? value.ToString() : vtkStdString();
144 }
145 
146 template<>
148 {
149  valid = value.IsUnicodeString();
150  return valid ? value.ToUnicodeString() : vtkUnicodeString();
151 }
152 
153 template<>
155 {
156  valid = true;
157  return value;
158 }
159 
160 #endif
161 
162 // VTK-HeaderTest-Exclude: vtkVariantExtract.h
vtkVariantExtract
T vtkVariantExtract(const vtkVariant &value, bool &valid)
Definition: vtkVariantExtract.h:41
vtkVariantExtract< int >
int vtkVariantExtract< int >(const vtkVariant &value, bool &valid)
Definition: vtkVariantExtract.h:84
vtkX3D::value
Definition: vtkX3D.h:220
vtkVariantExtract< unsigned short >
unsigned short vtkVariantExtract< unsigned short >(const vtkVariant &value, bool &valid)
Definition: vtkVariantExtract.h:77
vtkVariantExtract< char >
char vtkVariantExtract< char >(const vtkVariant &value, bool &valid)
Definition: vtkVariantExtract.h:56
vtkVariantExtract< vtkVariant >
vtkVariant vtkVariantExtract< vtkVariant >(const vtkVariant &value, bool &valid)
Definition: vtkVariantExtract.h:154
vtkVariantExtract< vtkUnicodeString >
vtkUnicodeString vtkVariantExtract< vtkUnicodeString >(const vtkVariant &value, bool &valid)
Definition: vtkVariantExtract.h:147
vtkVariantExtract< double >
double vtkVariantExtract< double >(const vtkVariant &value, bool &valid)
Definition: vtkVariantExtract.h:133
vtkVariantExtract< long >
long vtkVariantExtract< long >(const vtkVariant &value, bool &valid)
Definition: vtkVariantExtract.h:98
vtkUnicodeString
String class that stores Unicode text.
Definition: vtkUnicodeString.h:69
vtkVariant
A atomic type representing the union of many types.
Definition: vtkVariant.h:65
vtkVariantExtract< vtkStdString >
vtkStdString vtkVariantExtract< vtkStdString >(const vtkVariant &value, bool &valid)
Definition: vtkVariantExtract.h:140
vtkX3D::name
Definition: vtkX3D.h:219
vtkVariantExtract< unsigned long long >
unsigned long long vtkVariantExtract< unsigned long long >(const vtkVariant &value, bool &valid)
Definition: vtkVariantExtract.h:119
vtkVariantExtract< unsigned char >
unsigned char vtkVariantExtract< unsigned char >(const vtkVariant &value, bool &valid)
Definition: vtkVariantExtract.h:63
vtkVariantExtract< short >
short vtkVariantExtract< short >(const vtkVariant &value, bool &valid)
Definition: vtkVariantExtract.h:70
vtkVariantExtract< unsigned int >
unsigned int vtkVariantExtract< unsigned int >(const vtkVariant &value, bool &valid)
Definition: vtkVariantExtract.h:91
vtkVariantExtract< long long >
long long vtkVariantExtract< long long >(const vtkVariant &value, bool &valid)
Definition: vtkVariantExtract.h:112
vtkVariantExtract< unsigned long >
unsigned long vtkVariantExtract< unsigned long >(const vtkVariant &value, bool &valid)
Definition: vtkVariantExtract.h:105
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:34
vtkVariantExtract< float >
float vtkVariantExtract< float >(const vtkVariant &value, bool &valid)
Definition: vtkVariantExtract.h:126