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

4
// Includes
5
#include "XdmfItemProperty.hpp"
6

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
class XdmfGeometryType : public XdmfItemProperty {
26 27 28

public:

29 30
	friend class XdmfGeometry;

31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
	// 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.
	 */
47
	unsigned int getDimensions() const;
48

49 50
	void getProperties(std::map<std::string, std::string> & collectedProperties) const;

51
	/*
52
	 * Compare two XdmfGeometryTypes for equality.
53
	 *
54 55
	 * @param geometryType a XdmfGeometryType to compare equality to.
	 * @return true if the XdmfGeometryTypes are equal.
56
	 */
57
	bool operator==(const XdmfGeometryType & geometryType) const;
58 59

	/**
60
	 * Compare two XdmfGeometryTypes for inequality.
61
	 *
62 63
	 * @param geometryType a XdmfGeometryType to compare inequality to.
	 * @return true if the XdmfGeometryTypes are not equal.
64
	 */
65
	bool operator!=(const XdmfGeometryType & geometryType) const;
66

67
	XdmfGeometryType(const XdmfGeometryType & geometryType);
68
	XdmfGeometryType & operator=(const XdmfGeometryType & geometryType);
69 70 71 72 73

protected:

	/**
	 * Protected constructor for XdmfGeometryType.  The constructor is protected because all geometry types supported
74 75 76 77 78
	 * 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.
79
	 */
80
	XdmfGeometryType(const std::string & name, const int & dimensions);
81 82 83

private:

84 85
	static XdmfGeometryType New(const std::map<std::string, std::string> & itemProperties);

86
	unsigned int mDimensions;
87 88 89
	std::string mName;
};

90
#endif /* XDMFGEOMETRYTYPE_HPP_ */