XdmfGeometryType.hpp 2.44 KB
Newer Older
1 2 3
#ifndef XDMFGEOMETRYTYPE_HPP_
#define XDMFGEOMETRYTYPE_HPP_

4
// Includes
5 6
#include <string>

7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/**
 * @brief Property describing the types of coordinate values stored in an XdmfGeometry.
 *
 * XdmfGeometryType is a property used by XdmfGeometry to specify the type of coordinate values
 * stored in the XdmfGeometry.  A specific XdmfGeometryType can be created by calling on of the static methods
 * in the class, i.e. XdmfAttributeType::XYZ().
 *
 * Xdmf supports the following geometry types:
 * 	NoGeometryType
 * 	XYZ
 * 	XY
 * 	X_Y_Z
 * 	X_Y
 * 	VXVYVZ
 * 	Origin_DXDYDZ
 * 	VXVY
 * 	Origin_DXDY
 */
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
class XdmfGeometryType {

public:

	// Supported Xdmf Geometry Types
	static XdmfGeometryType NoGeometryType();
	static XdmfGeometryType XYZ();
	static XdmfGeometryType XY();
	static XdmfGeometryType X_Y_Z();
	static XdmfGeometryType X_Y();
	static XdmfGeometryType VXVYVZ();
	static XdmfGeometryType Origin_DXDYDZ();
	static XdmfGeometryType VXVY();
	static XdmfGeometryType Origin_DXDY();

	/**
	 * Get the dimensions of this geometry type - i.e. XYZ = 3.
	 *
	 * @return an int containing number of dimensions.
	 */
	int getDimensions() const;

	/**
	 * Get the name of this geometry type
	 *
	 * @return a string containing the name.
	 */
	std::string getName() const;

	/*
	 * Compare two XdmfGeometry types for equality.
	 *
57 58
	 * @param geometryType a XdmfGeometryType to compare equality to.
	 * @return true if the XdmfGeometryTypes are equal.
59
	 */
60
	bool operator==(const XdmfGeometryType & geometryType) const;
61 62 63 64

	/**
	 * Compare two XdmfGeometry types for inequality.
	 *
65 66
	 * @param geometryType a XdmfGeometryType to compare inequality to.
	 * @return true if the XdmfGeometryTypes are not equal.
67
	 */
68
	bool operator!=(const XdmfGeometryType & geometryType) const;
69

70 71
	XdmfGeometryType(const XdmfGeometryType & geometryType);
	XdmfGeometryType& operator=(const XdmfGeometryType & geometryType);
72 73 74 75 76

protected:

	/**
	 * Protected constructor for XdmfGeometryType.  The constructor is protected because all geometry types supported
77 78 79 80 81
	 * by Xdmf should be accessed through more specific static methods that construct XdmfGeometryTypes -
	 * i.e. XdmfGeometryType::XYZ().
	 *
	 * @param name a std::string containing the name of the XdmfGeometryType.
	 * @param dimensions an int containing the dimensions of the XdmfGeometryType.
82
	 */
83
	XdmfGeometryType(const std::string & name, const int & dimensions);
84 85 86 87 88 89 90

private:

	int mDimensions;
	std::string mName;
};

91
#endif /* XDMFGEOMETRYTYPE_HPP_ */