XdmfGridCollectionType.hpp 4.5 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 : XdmfGridCollectionType.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 XDMFGRIDCOLLECTIONTYPE_HPP_
#define XDMFGRIDCOLLECTIONTYPE_HPP_

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

#ifdef __cplusplus

// Includes
33 34 35 36 37
#include "XdmfItemProperty.hpp"

/**
 * @brief Property describing the type of an XdmfGridCollection.
 *
38 39 40 41 42
 * XdmfGridCollectionType is a property used by XdmfGridCollection to
 * specify what type of collection the XdmfGridCollection contains. A
 * specific XdmfGridCollectionType can be created by calling one of
 * the static methods in the class,
 * i.e. XdmfGridCollectionType::Temporal().
43
 *
44 45
 * Example of use:
 *
46 47 48
 * C++
 *
 * @dontinclude ExampleXdmfGridCollection.cpp
49 50 51 52
 * @skipline //#initalization
 * @until //#initalization
 * @skipline //#getType
 * @until //#getType
53 54 55 56
 *
 * Python
 *
 * @dontinclude XdmfExampleGridCollection.py
57 58 59 60
 * @skipline #//initalization
 * @until #//initalization
 * @skipline #//getType
 * @until #//getType
61
 *
62
 * Xdmf supports the following collection types:
63 64 65
 *   NoCollectionType
 *   Spatial
 *   Temporal
66
 */
67
class XDMF_EXPORT XdmfGridCollectionType : public XdmfItemProperty {
68

69
public:
70

71
  virtual ~XdmfGridCollectionType();
72

73
  friend class XdmfGridCollection;
74
  friend class XdmfGridTemplate;
75

76
  // Supported XdmfGridCollectionTypes
77 78 79
  static shared_ptr<const XdmfGridCollectionType> NoCollectionType();
  static shared_ptr<const XdmfGridCollectionType> Spatial();
  static shared_ptr<const XdmfGridCollectionType> Temporal();
80

81 82
  void
  getProperties(std::map<std::string, std::string> & collectedProperties) const;
83

84
protected:
85

86
  /**
87 88 89 90 91
   * Protected constructor for XdmfGridCollectionType. The constructor
   * is protected because all collection types supported by Xdmf
   * should be accessed through more specific static methods that
   * construct XdmfGridCollectionType -
   * i.e. XdmfGridCollectionType::Temporal().
92 93 94 95
   *
   * @param name the name of the XdmfGridCollectionType to construct.
   */
  XdmfGridCollectionType(const std::string & name);
96

97 98 99 100
  static std::map<std::string, shared_ptr<const XdmfGridCollectionType>(*)()> mGridCollectionDefinitions;

  static void InitTypes();

101
private:
102

103 104
  XdmfGridCollectionType(const XdmfGridCollectionType &); // Not implemented.
  void operator=(const XdmfGridCollectionType &); // Not implemented.
105

106
  static shared_ptr<const XdmfGridCollectionType>
107
  New(const std::map<std::string, std::string> & itemProperties);
108

109
  std::string mName;
110 111
};

112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
#endif

#ifdef __cplusplus
extern "C" {
#endif

// C wrappers go here

#define XDMF_GRID_COLLECTION_TYPE_SPATIAL            400
#define XDMF_GRID_COLLECTION_TYPE_TEMPORAL           401
#define XDMF_GRID_COLLECTION_TYPE_NO_COLLECTION_TYPE 402

XDMF_EXPORT int XdmfGridCollectionTypeNoCollectionType();
XDMF_EXPORT int XdmfGridCollectionTypeSpatial();
XDMF_EXPORT int XdmfGridCollectionTypeTemporal();

#ifdef __cplusplus
}
#endif


133
#endif /* XDMFGRIDCOLLECTIONTYPE_HPP_ */