XdmfGeometryType.hpp 5.81 KB
Newer Older
Kenneth Leiter's avatar
Kenneth Leiter committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/*****************************************************************************/
/*                                    XDMF                                   */
/*                       eXtensible Data Model and Format                    */
/*                                                                           */
/*  Id : XdmfGeometryType.hpp                                                */
/*                                                                           */
/*  Author:                                                                  */
/*     Kenneth Leiter                                                        */
/*     kenneth.leiter@arl.army.mil                                           */
/*     US Army Research Laboratory                                           */
/*     Aberdeen Proving Ground, MD                                           */
/*                                                                           */
/*     Copyright @ 2011 US Army Research Laboratory                          */
/*     All Rights Reserved                                                   */
/*     See Copyright.txt for details                                         */
/*                                                                           */
/*     This software is distributed WITHOUT ANY WARRANTY; without            */
/*     even the implied warranty of MERCHANTABILITY or FITNESS               */
/*     FOR A PARTICULAR PURPOSE.  See the above copyright notice             */
/*     for more information.                                                 */
/*                                                                           */
/*****************************************************************************/

24 25 26
#ifndef XDMFGEOMETRYTYPE_HPP_
#define XDMFGEOMETRYTYPE_HPP_

27
// C Compatible Includes
28
#include "Xdmf.hpp"
29 30 31 32

#ifdef __cplusplus

// Includes
33
#include "XdmfItemProperty.hpp"
34
#include <map>
35

36
/**
37 38
 * @brief Property describing the types of coordinate values stored in
 * an XdmfGeometry.
39
 *
40 41 42 43
 * XdmfGeometryType is a property used by XdmfGeometry to specify the
 * type of coordinate values stored in the XdmfGeometry. A specific
 * XdmfGeometryType can be created by calling one of the static
 * methods in the class, i.e.  XdmfAttributeType::XYZ().
44
 *
45 46
 * Example of use:
 *
47 48 49
 * C++
 *
 * @dontinclude ExampleXdmfGeometryType.cpp
50 51 52 53
 * @skipline //#initialization
 * @until //#initialization
 * @skipline //#getType
 * @until //#getType
54 55 56 57
 *
 * Python
 *
 * @dontinclude XdmfExampleGeometryType.py
58 59
 * @skipline #//getType
 * @until #//getType
60
 *
61
 * Xdmf supports the following geometry types:
62 63 64
 *   NoGeometryType
 *   XYZ
 *   XY
65 66 67 68 69 70 71
 *   Polar
 *   Spherical
 *
 * The Polar and Spherical types consist of a series of coordinates.
 * These coordinates are in order of: radius, polar, azimuthal. 
 * In accordance with the ISO standard.
 *
72
 */
73
class XDMF_EXPORT XdmfGeometryType : public XdmfItemProperty {
74

75
public:
76

77
  virtual ~XdmfGeometryType();
78

79
  friend class XdmfGeometry;
80

81
  // Supported Xdmf Geometry Types
82 83 84
  static shared_ptr<const XdmfGeometryType> NoGeometryType();
  static shared_ptr<const XdmfGeometryType> XYZ();
  static shared_ptr<const XdmfGeometryType> XY();
85 86
  static shared_ptr<const XdmfGeometryType> Polar();
  static shared_ptr<const XdmfGeometryType> Spherical();
87

88 89 90
  /**
   * Get the dimensions of this geometry type - i.e. XYZ = 3.
   *
91
   * Example of use:
92 93
   * 
   * C++
94
   *
95
   * @dontinclude ExampleXdmfGeometryType.cpp
96 97
   * @skipline //#getDimensions
   * @until //#getDimensions
98 99 100
   *
   * Python
   *
101
   * @dontinclude XdmfExampleGeometryType.py
102 103
   * @skipline #//getDimensions
   * @until #//getDimensions
104
   *
105
   * @return    An int containing number of dimensions.
106 107
   */
  virtual unsigned int getDimensions() const;
108

109 110 111
  /**
   * Get the name of this geometry type.
   *
112 113
   * Example of use:
   *
114 115
   * C++
   *
116
   * @dontinclude ExampleXdmfGeometryType.cpp
117 118
   * @skipline //#getName
   * @until //#getName
119 120 121
   *
   * Python
   *
122
   * @dontinclude XdmfExampleGeometryType.py
123 124
   * @skipline #//getName
   * @until #//getName
125
   *
126
   * @return    The name of this geometry type.
127 128
   */
  std::string getName() const;
129

130 131
  virtual void
  getProperties(std::map<std::string, std::string> & collectedProperties) const;
132

133
protected:
134

135
  /**
136 137 138 139
   * Protected constructor for XdmfGeometryType.  The constructor is
   * protected because all geometry types supported by Xdmf should be
   * accessed through more specific static methods that construct
   * XdmfGeometryTypes - i.e.  XdmfGeometryType::XYZ().
140 141 142 143 144
   *
   * @param name a std::string containing the name of the geometry type..
   * @param dimensions an int containing the dimensions of the geometry type.
   */
  XdmfGeometryType(const std::string & name, const int & dimensions);
145

146 147 148 149
  static std::map<std::string, shared_ptr<const XdmfGeometryType>(*)()> mGeometryDefinitions;

  static void InitTypes();

150
private:
151

152 153
  XdmfGeometryType(const XdmfGeometryType &); // Not implemented.
  void operator=(const XdmfGeometryType &); // Not implemented.
154

155
  static shared_ptr<const XdmfGeometryType>
156
  New(const std::map<std::string, std::string> & itemProperties);
157

158 159
  unsigned int mDimensions;
  std::string mName;
160 161
};

162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
#endif

#ifdef __cplusplus
extern "C" {
#endif

// C wrappers go here

#define XDMF_GEOMETRY_TYPE_NO_GEOMETRY_TYPE 300
#define XDMF_GEOMETRY_TYPE_XYZ              301
#define XDMF_GEOMETRY_TYPE_XY               302
#define XDMF_GEOMETRY_TYPE_POLAR            303
#define XDMF_GEOMETRY_TYPE_SPHERICAL        304

XDMF_EXPORT int XdmfGeometryTypeNoGeometryType();
XDMF_EXPORT int XdmfGeometryTypeXYZ();
XDMF_EXPORT int XdmfGeometryTypeXY();
XDMF_EXPORT int XdmfGeometryTypePolar();
XDMF_EXPORT int XdmfGeometryTypeSpherical();

XDMF_EXPORT unsigned int XdmfGeometryTypeGetDimensions(int type, int * status);

XDMF_EXPORT char * XdmfGeometryTypeGetName(int type);

#ifdef __cplusplus
}
#endif

190
#endif /* XDMFGEOMETRYTYPE_HPP_ */