XdmfGeometryType.hpp 1.82 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
/*
 * XdmfGeometryType.hpp
 *
 *  Created on: Jan 25, 2010
 *      Author: kleiter
 */

#ifndef XDMFGEOMETRYTYPE_HPP_
#define XDMFGEOMETRYTYPE_HPP_

#include <string>

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.
	 *
	 * @param an XdmfGeometryType to compare equality to.
	 * @return true iff the XdmfGeometryTypes are equal.
	 */
	bool operator==(const XdmfGeometryType& geometryType) const;

	/**
	 * Compare two XdmfGeometry types for inequality.
	 *
	 * @param XdmfGeometryType to compare inequality to.
	 * @return true iff the XdmfGeometryTypes are not equal.
	 */
	bool operator!=(const XdmfGeometryType& geometryType) const;

	XdmfGeometryType(const XdmfGeometryType& geometryType);
	XdmfGeometryType& operator=(const XdmfGeometryType& geometryType);

protected:

	/**
	 * Protected constructor for XdmfGeometryType.  The constructor is protected because all geometry types supported
	 * by Xdmf should be accessed through more specific static methods that construct XdmfGeometryTypes - i.e. XdmfGeometryType::XYZ().
	 */
	XdmfGeometryType(const std::string& name, const int& dimensions);

private:

	int mDimensions;
	std::string mName;
};

#endif /* XDMFATTRIBUTETYPE_HPP_ */