XdmfAttributeType.hpp 5.08 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 : XdmfAttributeType.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 XDMFATTRIBUTETYPE_HPP_
#define XDMFATTRIBUTETYPE_HPP_

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

#ifdef __cplusplus

32
#include "XdmfItemProperty.hpp"
33

34
/**
35 36
 * @brief Property describing the type of values an XdmfAttribute
 * contains.
37
 *
38 39 40 41
 * XdmfAttributeType is a property used by XdmfAttribute to specify
 * what type of values the XdmfAttribute contains. A specific
 * XdmfAttributeType can be created by calling one of the static
 * methods in the class, i.e. XdmfAttributeType::Scalar().
42
 *
43 44
 * Example of use:
 *
45 46 47
 * C++
 *
 * @dontinclude ExampleXdmfAttribute.cpp
48 49 50 51 52 53
 * @skipline //#initialization
 * @until //#initialization
 * @skipline //#setType
 * @until //#setType
 * @skipline //#getType
 * @until //#getType
54 55 56 57
 *
 * Python
 *
 * @dontinclude XdmfExampleAttribute.py
58 59 60 61 62 63
 * @skipline #//initialization
 * @until #//initialization
 * @skipline #//setType
 * @until #//setType
 * @skipline #//getType
 * @until #//getType
64
 *
65
 * Xdmf supports the following attribute types:
66 67 68 69 70 71 72
 *   NoAttributeType
 *   Scalar
 *   Vector
 *   Tensor
 *   Matrix
 *   Tensor6
 *   GlobalId
73
 */
74
class XDMF_EXPORT XdmfAttributeType : public XdmfItemProperty {
75

76
public:
77

78
  virtual ~XdmfAttributeType();
79

80
  friend class XdmfAttribute;
81

82
  // Supported Xdmf Attribute Types
83 84 85 86 87 88 89
  static shared_ptr<const XdmfAttributeType> NoAttributeType();
  static shared_ptr<const XdmfAttributeType> Scalar();
  static shared_ptr<const XdmfAttributeType> Vector();
  static shared_ptr<const XdmfAttributeType> Tensor();
  static shared_ptr<const XdmfAttributeType> Matrix();
  static shared_ptr<const XdmfAttributeType> Tensor6();
  static shared_ptr<const XdmfAttributeType> GlobalId();
90

91 92
  void
  getProperties(std::map<std::string, std::string> & collectedProperties) const;
93

94
protected:
95

96 97 98 99 100 101
  /**
   * Protected constructor for XdmfAttributeType.  The constructor is
   * protected because all attribute types supported by Xdmf should be
   * accessed through more specific static methods that construct
   * XdmfAttributeTypes - i.e. XdmfAttributeType::Scalar().
   *
102
   * @param     name    The name of the XdmfAttributeType to construct.
103 104
   */
  XdmfAttributeType(const std::string & name);
105

106 107 108 109
  static std::map<std::string, shared_ptr<const XdmfAttributeType>(*)()> mAttributeDefinitions;

  static void InitTypes();

110
private:
111

112 113
  XdmfAttributeType(const XdmfAttributeType &); // Not implemented.
  void operator=(const XdmfAttributeType &); // Not implemented.
114

115
  static shared_ptr<const XdmfAttributeType>
116
  New(const std::map<std::string, std::string> & itemProperties);
117

118
  std::string mName;
119 120
};

121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
#endif

#ifdef __cplusplus
extern "C" {
#endif

// C wrappers go here

#define XDMF_ATTRIBUTE_TYPE_SCALAR                       200
#define XDMF_ATTRIBUTE_TYPE_VECTOR                       201
#define XDMF_ATTRIBUTE_TYPE_TENSOR                       202
#define XDMF_ATTRIBUTE_TYPE_MATRIX                       203
#define XDMF_ATTRIBUTE_TYPE_TENSOR6                      204
#define XDMF_ATTRIBUTE_TYPE_GLOBALID                     205
#define XDMF_ATTRIBUTE_TYPE_NOTYPE                       206

XDMF_EXPORT int XdmfAttributeTypeScalar();
XDMF_EXPORT int XdmfAttributeTypeVector();
XDMF_EXPORT int XdmfAttributeTypeTensor();
XDMF_EXPORT int XdmfAttributeTypeMatrix();
XDMF_EXPORT int XdmfAttributeTypeTensor6();
XDMF_EXPORT int XdmfAttributeTypeGlobalId();
XDMF_EXPORT int XdmfAttributeTypeNoAttributeType();

#ifdef __cplusplus
}
#endif

149
#endif /* XDMFATTRIBUTETYPE_HPP_ */