XdmfGridController.hpp 6.35 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 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 149 150 151 152 153 154 155 156 157 158 159 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 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
/*****************************************************************************/
/*                                    XDMF                                   */
/*                       eXtensible Data Model and Format                    */
/*                                                                           */
/*  Id : XdmfGridController.hpp                                              */
/*                                                                           */
/*  Author:                                                                  */
/*     Andrew Burns                                                          */
/*     andrew.j.burns2@arl.army.mil                                          */
/*     US Army Research Laboratory                                           */
/*     Aberdeen Proving Ground, MD                                           */
/*                                                                           */
/*     Copyright @ 2015 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.                                                 */
/*                                                                           */
/*****************************************************************************/

#ifndef XDMFGRIDCONTROLLER_HPP_
#define XDMFGRIDCONTROLLER_HPP_

// C Compatible Includes
#include "Xdmf.hpp"

#ifdef __cplusplus

// Forward Declarations
class XdmfGrid;

// Includes
#include <string>
#include "XdmfSharedPtr.hpp"

/**
 * @brief Couples an XdmfGrid with a grid on a different XML file.
 *
 * Serves as an method to reduce memory usage by leaving part of
 * the xdmf tree in file.
 */
class XDMF_EXPORT XdmfGridController : public virtual XdmfItem {

public:

  /**
   * Creates a link to an xdmf tree in another file.
   *
   * Example of use:
   *
   * C++
   *
   * @dontinclude ExampleXdmfGrid.cpp
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setGridController
   * @until //#setGridController
   *
   * Python
   *
   * @dontinclude XdmfExampleGrid.py
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setGridController
   * @until #//setGridController
   *
   * @param     filePath        
   * @param     xmlPath         
   *
   * @return    A reference to the external xdmf tree
   */
  static shared_ptr<XdmfGridController>
  New(const std::string & filePath,
      const std::string & xmlPath);

  friend class XdmfWriter;
  friend class XdmfGrid;

  virtual ~XdmfGridController();

  static const std::string ItemTag;

  /**
   * Gets the file path of the grid that this reference reads from.
   *
   * Example of use:
   *
   * C++
   *
   * @dontinclude ExampleXdmfGrid.cpp
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setGridController
   * @until //#setGridController
   * @skipline //#getFilePath
   * @until //#getFilePath
   *
   * Python
   *
   * @dontinclude XdmfExampleGrid.py
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setGridController
   * @until #//setGridController
   * @skipline #//getFilePath
   * @until #//getFilePath
   *
   * @return    The file path.
   */
  std::string getFilePath() const;

  std::map<std::string, std::string> getItemProperties() const;

  virtual std::string getItemTag() const;

  /**
   * Gets the XML path that refers to the base node in the reference file.
   *
   * Example of use:
   *
   * C++
   *
   * @dontinclude ExampleXdmfGrid.cpp
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setGridController
   * @until //#setGridController
   * @skipline //#getXMLPath
   * @until //#getXMLPath
   *
   * Python
   *
   * @dontinclude XdmfExampleGrid.py
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setGridController
   * @until #//setGridController
   * @skipline #//getXMLPath
   * @until #//getXMLPath
   *
   * @return    The XML path.
   */
  std::string getXMLPath() const;

  /**
   * Reads the grid that his controller references.
   *
   * Example of use:
   *
   * C++
   *
   * @dontinclude ExampleXdmfGrid.cpp
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setGridController
   * @until //#setGridController
   * @skipline //#controllerRead
   * @until //#controllerRead
   *
   * Python
   *
   * @dontinclude XdmfExampleGrid.py
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setGridController
   * @until #//setGridController
   * @skipline #//controllerRead
   * @until #//controllerRead
   *
   * @return    The grid read from the controller's stored location
   */
  virtual shared_ptr<XdmfGrid> read();

  XdmfGridController(const XdmfGridController&);

protected:

  XdmfGridController(const std::string & filePath,
                     const std::string & xmlPath);

  const std::string mFilePath;
  const std::string mXMLPath;

private:

//  XdmfGridController(const XdmfGridController&);  // Not implemented.
  void operator=(const XdmfGridController &);  // Not implemented.

};

#endif

#ifdef __cplusplus
extern "C" {
#endif

// C wrappers go here

#ifndef XDMFGRIDCDEFINE
#define XDMFGRIDCDEFINE
struct XDMFGRID; // Simply as a typedef to ensure correct typing
typedef struct XDMFGRID XDMFGRID;
#endif

struct XDMFGRIDCONTROLLER; // Simply as a typedef to ensure correct typing
typedef struct XDMFGRIDCONTROLLER XDMFGRIDCONTROLLER;

XDMF_EXPORT XDMFGRIDCONTROLLER * XdmfGridControllerNew(char * filePath,
                                                       char * xmlPath);

XDMF_EXPORT char * XdmfGridControllerGetFilePath(XDMFGRIDCONTROLLER * controller);

XDMF_EXPORT char * XdmfGridControllerGetXMLPath(XDMFGRIDCONTROLLER * controller);

XDMF_EXPORT XDMFGRID * XdmfGridControllerRead(XDMFGRIDCONTROLLER * controller);

XDMF_ITEM_C_CHILD_DECLARE(XdmfGridController, XDMFGRIDCONTROLLER, XDMF)

#ifdef __cplusplus
}
#endif

#endif /* XDMFGRIDCONTROLLER_HPP_ */