XdmfAttributeType.hpp 3.68 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
// Includes
28
#include "Xdmf.hpp"
29
#include "XdmfItemProperty.hpp"
30

31
/**
32 33
 * @brief Property describing the type of values an XdmfAttribute
 * contains.
34
 *
35 36 37 38
 * 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().
39 40
 *
 * Xdmf supports the following attribute types:
41 42 43 44 45 46 47
 *   NoAttributeType
 *   Scalar
 *   Vector
 *   Tensor
 *   Matrix
 *   Tensor6
 *   GlobalId
48
 */
49
class XDMF_EXPORT XdmfAttributeType : public XdmfItemProperty {
50

51
public:
52

53
  virtual ~XdmfAttributeType();
54

55
  friend class XdmfAttribute;
56

57
  // Supported Xdmf Attribute Types
58 59 60 61 62 63 64
  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();
65

66 67
  void
  getProperties(std::map<std::string, std::string> & collectedProperties) const;
68

69
protected:
70

71 72 73 74 75 76 77 78 79
  /**
   * 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().
   *
   * @param name the name of the XdmfAttributeType to construct.
   */
  XdmfAttributeType(const std::string & name);
80

81
private:
82

83 84
  XdmfAttributeType(const XdmfAttributeType &); // Not implemented.
  void operator=(const XdmfAttributeType &); // Not implemented.
85

86
  static shared_ptr<const XdmfAttributeType>
87
  New(const std::map<std::string, std::string> & itemProperties);
88

89
  std::string mName;
90 91 92
};

#endif /* XDMFATTRIBUTETYPE_HPP_ */