---

CGNS::GridCoordinates Class Reference

#include <cgns++.h>

Inherits CGNS::Gridded.

Inheritance diagram for CGNS::GridCoordinates:

[legend]List of all members.

Public Types
typedef iterator< DataArray >	Coordinate_iterator_t
enum	CoordinateType {   NULL_COORDINATE = DataArray::NULL_DATA, COORDINATE_X = DataArray::COORDINATE_X, COORDINATE_Y = DataArray::COORDINATE_Y, COORDINATE_Z = DataArray::COORDINATE_Z,   COORDINATE_R = DataArray::COORDINATE_R, COORDINATE_THETA = DataArray::COORDINATE_THETA, COORDINATE_PHI = DataArray::COORDINATE_PHI, COORDINATE_NORMAL = DataArray::COORDINATE_NORMAL,   COORDINATE_TANGENTIAL = DataArray::COORDINATE_TANGENTIAL, COORDINATE_XI = DataArray::COORDINATE_XI, COORDINATE_ETA = DataArray::COORDINATE_ETA, COORDINATE_ZETA = DataArray::COORDINATE_ZETA,   USER_COORDINATE }
Public Methods
int	getNumCoordinate () const
bool	hasCoordinate (std::string const &iName) const
DataArray	getCoordinate (std::string const &iName) const
Coordinate_iterator_t	beginCoordinate () const
Coordinate_iterator_t	endCoordinate () const
void	deleteCoordinate (std::string const &iName)
bool	hasCoordinate (CoordinateType iCoordinate) const
DataArray	getCoordinate (CoordinateType iCoordinate) const
void	readData (CoordinateType iCoordinate, double *oCoordinates) const
void	readData (CoordinateType iCoordinate, float *oCoordinates) const
void	writeData (CoordinateType iCoordinate, double const *iCoordinates)
void	writeData (CoordinateType iCoordinate, float const *iCoordinates)
DataArray	writeCoordinate (CoordinateType iCoordinate, DataArray::DataType iType=DataArray::DOUBLE)
	GridCoordinates (Private::GridCoordinates *iImpl)

---

Detailed Description

Represents a SIDS node holding a GridCoordinates_t.

---

Member Typedef Documentation

typedef iterator< DataArray > Coordinate_iterator_t

---

Member Enumeration Documentation

enum CoordinateType

The possible coordinate types. Enumeration values: NULL_COORDINATE  COORDINATE_X  COORDINATE_Y  COORDINATE_Z  COORDINATE_R  COORDINATE_THETA  COORDINATE_PHI  COORDINATE_NORMAL  COORDINATE_TANGENTIAL  COORDINATE_XI  COORDINATE_ETA  COORDINATE_ZETA  USER_COORDINATE

---

Constructor & Destructor Documentation

GridCoordinates (  Private::GridCoordinates *    iImpl )

Creates these grid coordinates from implementation data.

---

Member Function Documentation

Coordinate_iterator_t beginCoordinate (    )  const

void deleteCoordinate (  std::string const &    iName )

Coordinate_iterator_t endCoordinate (    )  const

DataArray getCoordinate (  CoordinateType    iCoordinate )  const

Gets the corresponding DataArray_t subnode.

DataArray getCoordinate (  std::string const &    iName )  const

int getNumCoordinate (    )  const

bool hasCoordinate (  CoordinateType    iCoordinate )  const

Asks if there is a subnode for the given CoordinateType.

bool hasCoordinate (  std::string const &    iName )  const

void readData (  CoordinateType    iCoordinate, float *    oCoordinates )  const

void readData (  CoordinateType    iCoordinate, double *    oCoordinates )  const

Does the actual read of the coordinate entry.

DataArray writeCoordinate (  CoordinateType    iCoordinate, DataArray::DataType    iType = DataArray::DOUBLE )

Adds the named coordinate entry to this node and returns it.

void writeData (  CoordinateType    iCoordinate, float const *    iCoordinates )

void writeData (  CoordinateType    iCoordinate, double const *    iCoordinates )

Does the actual write of the coordinate data.

---