---

ADF::Node Class Reference

#include <adf++.h>

List of all members.

Public Types
typedef iterator< Node >	Child_iterator_t
Public Methods
	Node (Node const &rhs)
virtual	~Node ()
Node	createChild (std::string const &iChildName, std::string const &iChildLabel="")
void	deleteChild (std::string const &)
void	deleteChild (Node &iChildNode)
void	deleteChildren ()
int	getNumChildren () const
Node	getChild (std::string const &iChildName) const
Child_iterator_t	beginChild () const
Child_iterator_t	endChild () const
bool	hasChild (std::string const &iChildName) const
bool	hasChild (Node const &iChildNode) const
bool	hasChild (double iChildId) const
std::string	getName () const
void	renameChild (std::string const &iOldName, std::string const &iName)
void	renameChild (Node &iChildNode, std::string const &iName)
void	reparentChild (std::string const &iChildName, Node &iNewParent)
void	reparentChild (Node const &iChildNode, Node &iNewParent)
Node	createLink (std::string const &iChildName, std::string const &iLinkedToName)
Node	createLink (std::string const &iChildName, Node const &iLinkedToNode)
Node	createLink (std::string const &iChildName, std::string const &iLinkedToName, std::string const &iLinkedToFile)
bool	isLink () const
std::string	getLinkFile () const
std::string	getLinkPath () const
Node	getRootNode () const
std::string	getLabel () const
void	setLabel (std::string const &iLabel)
DataType	getDataType () const
std::string	getDataTypeString () const
void	setDataType (DataType iType)
void	setDataType (std::string const &iType)
int	getNumDimensions () const
int	getDimension (int iNth) const
void	setNumDimensions (int iNumDim)
void	setDimension (int iNth, int iSize)
void	setDimensions (int iNumDimensions, int const *iDimensions)
void	setDimensions (int iSize)
void	setDimensions (int iSize1, int iSize2)
void	setDimensions (int iSize1, int iSize2, int iSize3)
void	setDataTypeDimensions (DataType iType, int iNumDimensions, int const *iDimensions)
void	setDataTypeDimensions (std::string const &iType, int iNumDimensions, int const *iDimensions)
void	setDataTypeDimensions (std::string const &iType, int iSize)
void	setDataTypeDimensions (DataType iType, int iSize)
void	setDataTypeDimensions (DataType iType, int iSize1, int iSize2)
void	setDataTypeDimensions (DataType iType, int iSize1, int iSize2, int iSize3)
void	readData (void *oData) const
void	readData (int *oData) const
void	readData (long long *oData) const
void	readData (unsigned *oData) const
void	readData (unsigned long long *oData) const
void	readData (float *oData) const
void	readData (double *oData) const
void	readData (std::complex< float > *oData) const
void	readData (std::complex< double > *oData) const
void	readData (char *oData) const
void	readData (unsigned char *oData) const
void	readData (std::string *oData) const
void	writeData (void const *iData)
void	writeData (int const *iData)
void	writeData (long long const *iData)
void	writeData (unsigned const *iData)
void	writeData (unsigned long long const *iData)
void	writeData (float const *iData)
void	writeData (double const *iData)
void	writeData (std::complex< float > const *iData)
void	writeData (std::complex< double > const *iData)
void	writeData (char const *iData)
void	writeData (unsigned char const *iData)
void	writeData (std::string const &iData)
void	update ()
void	flush ()
double	getId () const
	Node (double iId)
	Node (Private *iImpl)
Static Public Methods
double	createBareChild (double iParent, std::string const &iName, std::string const &iLabel="")
Protected Methods
double	createBareChild (std::string const &iName, std::string const &iLabel="")
Protected Attributes
refcnt_ptr< Private >	mImpl
Friends
class	File

---

Detailed Description

Represents the bare node in an ADF file

---

Member Typedef Documentation

typedef iterator<Node> Child_iterator_t

---

Constructor & Destructor Documentation

Node (  Node const &    rhs )

Copy constructor

virtual ~Node (    )  [virtual]

Deletes this node handle.

Node (  double    iId )  [explicit]

Creates a solitary node for lookup. This is discouraged and for convenience only. Dismiss as soon as possible.

Node (  Private *    iImpl )

Creates a node from implementation data.

---

Member Function Documentation

Child_iterator_t beginChild (    )  const

Gets an iterator to the first child.

double createBareChild (  std::string const &    iName, std::string const &    iLabel = "" )  [protected]

Creates a new child node in ADF only.

double createBareChild (  double    iParent, std::string const &    iName, std::string const &    iLabel = "" )  [static]

Creates a new child node in ADF only.

Node createChild (  std::string const &    iChildName, std::string const &    iChildLabel = "" )

Create a child node with the given name (and possibly label).

Node createLink (  std::string const &    iChildName, std::string const &    iLinkedToName, std::string const &    iLinkedToFile )

Create a child which is a link in another file

Node createLink (  std::string const &    iChildName, Node const &    iLinkedToNode )

Create a child which is a link to another node

Node createLink (  std::string const &    iChildName, std::string const &    iLinkedToName )

Create a child which is a link in this file

void deleteChild (  Node &    iChildNode )

void deleteChild (  std::string const &    )

Delete the given child node.

void deleteChildren (    )

Delete all child nodes.

Child_iterator_t endChild (    )  const

Gets an iterator one past the last child.

void flush (    )

Assure the data is written to disk.

Node getChild (  std::string const &    iChildName )  const

Get the named child node.

DataType getDataType (    )  const

Get the data type of this node.

std::string getDataTypeString (    )  const

Get the string representation of the data type of this node.

int getDimension (  int    iNth )  const

Get the size of the nth dimension.

double getId (    )  const

Get the basic ADF id.

std::string getLabel (    )  const

Get the label of this node.

std::string getLinkFile (    )  const

Get the file name of a link.

std::string getLinkPath (    )  const

Get the path to the linked to node.

std::string getName (    )  const

Get the intrinsic name of this node.

int getNumChildren (    )  const

Get the number of children of this node.

int getNumDimensions (    )  const

Get the number of dimensions.

Node getRootNode (    )  const

Get the root node of the file this node is in.

bool hasChild (  double    iChildId )  const

Ask if the given id is a child node.

bool hasChild (  Node const &    iChildNode )  const

Ask if this is a child node.

bool hasChild (  std::string const &    iChildName )  const

Ask if there is a named child.

bool isLink (    )  const

Check whether this node is in fact a link .

void readData (  std::string *    oData )  const

Convenience function for reading a string

void readData (  unsigned char *    oData )  const

void readData (  char *    oData )  const

void readData (  std::complex< double > *    oData )  const

void readData (  std::complex< float > *    oData )  const

void readData (  double *    oData )  const

void readData (  float *    oData )  const

void readData (  unsigned long long *    oData )  const

void readData (  unsigned *    oData )  const

void readData (  long long *    oData )  const

void readData (  int *    oData )  const

Read the data from disk, possibly with conversion.

void readData (  void *    oData )  const

Read the raw data from disk.

void renameChild (  Node &    iChildNode, std::string const &    iName )

Rename child node.

void renameChild (  std::string const &    iOldName, std::string const &    iName )

Rename child node.

void reparentChild (  Node const &    iChildNode, Node &    iNewParent )

void reparentChild (  std::string const &    iChildName, Node &    iNewParent )

Move child to another parent node

void setDataType (  std::string const &    iType )

Set the data type of this node with string representation. Data is cleared.

void setDataType (  DataType    iType )

Set the data type of this node. Data is cleared.

void setDataTypeDimensions (  DataType    iType, int    iSize1, int    iSize2, int    iSize3 )

Set data type, 3D and the three dimensions.

void setDataTypeDimensions (  DataType    iType, int    iSize1, int    iSize2 )

Set data type, 2D and the two dimensions.

void setDataTypeDimensions (  DataType    iType, int    iSize )

Set data type, 1D and the single one dimension.

void setDataTypeDimensions (  std::string const &    iType, int    iSize )

Set data type and the single one dimension.

void setDataTypeDimensions (  std::string const &    iType, int    iNumDimensions, int const *    iDimensions )

Set data type (as string) and all dimensions at once.

void setDataTypeDimensions (  DataType    iType, int    iNumDimensions, int const *    iDimensions )

Set data type and all dimensions at once.

void setDimension (  int    iNth, int    iSize )

Set the size of the nth dimension. Data is cleared.

void setDimensions (  int    iSize1, int    iSize2, int    iSize3 )

Set to 2D and the size of two dimension. Data is cleared.

void setDimensions (  int    iSize1, int    iSize2 )

Set to 2D and the size of two dimension. Data is cleared.

void setDimensions (  int    iSize )

Set to 1D and the size of the only dimension. Data is cleared.

void setDimensions (  int    iNumDimensions, int const *    iDimensions )

Set all dimensions at once.

void setLabel (  std::string const &    iLabel )

Relabel this node.

void setNumDimensions (  int    iNumDim )

Set the number of dimensions. All dimensions values are set to 1, data is cleared.

void update (    )

Reread the node info again from the CGNS file.

void writeData (  std::string const &    iData )

Convenience function for reading a string

void writeData (  unsigned char const *    iData )

void writeData (  char const *    iData )

void writeData (  std::complex< double > const *    iData )

void writeData (  std::complex< float > const *    iData )

void writeData (  double const *    iData )

void writeData (  float const *    iData )

void writeData (  unsigned long long const *    iData )

void writeData (  unsigned const *    iData )

void writeData (  long long const *    iData )

void writeData (  int const *    iData )

Write the data to disk, possibly with conversion.

void writeData (  void const *    iData )

Write the raw data to disk.

---

Friends And Related Function Documentation

friend class File [friend]

---

Member Data Documentation

refcnt_ptr<Private> mImpl [protected]

---