XdmfArrayReference.hpp 6.07 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
/*****************************************************************************/
/*                                    XDMF                                   */
/*                       eXtensible Data Model and Format                    */
/*                                                                           */
/*  Id : XdmfArrayReference.hpp                                              */
/*                                                                           */
/*  Author:                                                                  */
/*     Andrew Burns                                                          */
/*     andrew.j.burns2@us.army.mil                                           */
/*     US Army Research Laboratory                                           */
/*     Aberdeen Proving Ground, MD                                           */
/*                                                                           */
/*     Copyright @ 2013 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 XDMFARRAYREFERENCE_HPP_
#define XDMFARRAYREFERENCE_HPP_

// Includes
#include "XdmfCore.hpp"
#include "XdmfArray.hpp"

class XdmfArray;

/**
 * @brief Serves as a link between an array and one or more arrays containing data it pulls from.
 *
 * The Array Reference class provides the basic framework for the writing and
 * reading of the Function and Subset classes by allowing properties and tags
 * to be migrated to them.
 */
class XDMFCORE_EXPORT XdmfArrayReference : public XdmfItem {

public:

  virtual ~XdmfArrayReference();

46
  LOKI_DEFINE_VISITABLE(XdmfArrayReference, XdmfItem)
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

  /**
   * Gets the properties of the array that the reference will generate when read from file.
   *
   * Example of use:
   *
   * C++
   * 
   * @dontinclude ExampleXdmfFunction.cpp
   * @skipline //#initexpression
   * @until //#initexpression
   * @skipline //#setConstructedProperties
   * @until //#setConstructedProperties
   * @skipline //#getConstructedProperties
   * @until //#getConstructedProperties
   *
   * Python
   *
   * @dontinclude XdmfExampleFunction.py
   * @skipline #//initexpression
   * @until #//initexpression
   * @skipline #//setConstructedProperties
   * @until #//setConstructedProperties
   * @skipline #//getConstructedProperties
   * @until #//getConstructedProperties
   *
   * @return    The properties of the array to be generated
   */
  std::map<std::string, std::string> getConstructedProperties();

  /**
   * Gets the type of array that the reference will generate when read from file.
   *
   * Example of use:
   *
   * C++
   * 
   * @dontinclude ExampleXdmfFunction.cpp
   * @skipline //#initexpression
   * @until //#initexpression
   * @skipline //#setConstructedType
   * @until //#setConstructedType
   * @skipline //#getConstructedType
   * @until //#getConstructedType
   *
   * Python
   *
   * @dontinclude XdmfExampleFunction.py
   * @skipline #//initexpression
   * @until #//initexpression
   * @skipline #//setConstructedType
   * @until #//setConstructedType
   * @skipline #//getConstructedType
   * @until #//getConstructedType
   *
   * @return    The tag of the type to be generated
   */
104
  std::string getConstructedType() const;
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

  /**
   * Parses the reference and generates an array containing the values that
   * the reference produces.
   *
   * Example of use:
   *
   * C++
   * 
   * @dontinclude ExampleXdmfFunction.cpp
   * @skipline //#initexpression
   * @until //#initexpression
   * @skipline //#read
   * @until //#read
   *
   * Python
   *
   * @dontinclude XdmfExampleFunction.py
   * @skipline #//initexpression
   * @until #//initexpression
   * @skipline #//read
   * @until #//read
   *
   * @return    The array generated by the reference
   */
130
  virtual shared_ptr<XdmfArray> read() const = 0;
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

  /**
   * Sets the properties of array that the reference will generate when read from file.
   *
   * Example of use:
   *
   * C++
   * 
   * @dontinclude ExampleXdmfFunction.cpp
   * @skipline //#initexpression
   * @until //#initexpression
   * @skipline //#setConstructedProperties
   * @until //#setConstructedProperties
   *
   * Python
   *
   * @dontinclude XdmfExampleFunction.py
   * @skipline #//initexpression
   * @until #//initexpression
   * @skipline #//setConstructedProperties
   * @until #//setConstructedProperties
   *
   * @param     newProperties   The properties of the array to be generated
   */
  void
  setConstructedProperties(std::map<std::string, std::string> newProperties);

  /**
   * Sets the type of array that the reference will generate when read from file.
   *
   * Example of use:
   *
   * C++
   * 
   * @dontinclude ExampleXdmfFunction.cpp
   * @skipline //#initexpression
   * @until //#initexpression
   * @skipline //#setConstructedType
   * @until //#setConstructedType
   *
   * Python
   *
   * @dontinclude XdmfExampleFunction.py
   * @skipline #//initexpression
   * @until #//initexpression
   * @skipline #//setConstructedType
   * @until #//setConstructedType
   *
   * @param     newType         The tag of the type to be generated
   */
  void setConstructedType(std::string newType);

protected:

  XdmfArrayReference();

  std::string mConstructedType;
  std::map<std::string, std::string> mConstructedProperties;

private:

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

#endif /* XDMFARRAYREFERENCE_HPP_ */