HDF4_GROUP Class Reference

#include <mi32/hdf4.h>

Inheritance diagram for HDF4_GROUP:

[legend]

List of all members.

Public Member Functions
	HDF4_GROUP ()
virtual	~HDF4_GROUP ()
void	Close ()
virtual int	FindAttrib (const char *name) const
int	FindObject (HDF4_OBJTYPE type, const char *path) const
int	FindObjectByClass (HDF4_OBJTYPE type, const char *classname) const
virtual ERRVALUE	GetAttrib (int index, HDF4_ATTRIB &attrib) const
ERRVALUE	GetClass (HDF4_NAME &classname) const
virtual ERRVALUE	GetName (HDF4_NAME &name) const
virtual int	GetNumAttribs () const
ERRVALUE	GetObjIdxs (HDF4_OBJTYPE objtype, SIMPLE_ARRAY< INT32 > &objidxs) const
ERRVALUE	Open (const HDF4_FILE &file, int index)
ERRVALUE	OpenRoot (const HDF4_FILE &file)

---

Constructor & Destructor Documentation

HDF4_GROUP::HDF4_GROUP

(

)

Default constructor.

virtual HDF4_GROUP::~HDF4_GROUP

(

)

[virtual]

Destructor.

---

Member Function Documentation

void HDF4_GROUP::Close

(

)

Close group.

virtual int HDF4_GROUP::FindAttrib

(

const char *

name

)

const [virtual]

Find attribute index by name.

Returns:

Attribute index, -1 if not found, < -1 if error.

Parameters:

name

Attribute name to search for

Implements HDF4_OBJECT.

int HDF4_GROUP::FindObject	(	HDF4_OBJTYPE	type,
		const char *	path
	)			const

Find object by type and path.

Items in the path are separated by '/' with the last item being the object name.

Returns:

Index if found, -1 if not found, < -1 if error.

Parameters:

	type	HDF object type
	path	Path to search

int HDF4_GROUP::FindObjectByClass	(	HDF4_OBJTYPE	type,
		const char *	classname
	)			const

Find first object having specified 'class' name.

Items in the path are separated by '/' with the last item being the 'class' name.

Parameters:

	type	HDF object type (Group, Table only)
	classname	Object 'class' name

virtual ERRVALUE HDF4_GROUP::GetAttrib	(	int	index,
		HDF4_ATTRIB &	attrib
	)			const [virtual]

Get specific attribute.

Parameters:

	index	Attribute index within group
	attrib	Attribute instance returned

Implements HDF4_OBJECT.

ERRVALUE HDF4_GROUP::GetClass

(

HDF4_NAME &

classname

)

const

Get 'class' name.

Parameters:

classname

Class name returned

virtual ERRVALUE HDF4_GROUP::GetName

(

HDF4_NAME &

name

)

const [virtual]

Get object name.

Parameters:

name

Name returned

Implements HDF4_OBJECT.

virtual int HDF4_GROUP::GetNumAttribs

(

)

const [virtual]

Get number of attributes in this object.

Implements HDF4_OBJECT.

ERRVALUE HDF4_GROUP::GetObjIdxs	(	HDF4_OBJTYPE	objtype,
		SIMPLE_ARRAY< INT32 > &	objidxs
	)			const

Get array of object indices for group.

Note that a specific object can be contained in multiple groups.

Parameters:

	objtype	Object type
	objidxs	Object index array returned

ERRVALUE HDF4_GROUP::Open	(	const HDF4_FILE &	file,
		int	index
	)

Open group.

Parameters:

	file	Open HDF4 file
	index	Group index (reference number)

ERRVALUE HDF4_GROUP::OpenRoot

(

const HDF4_FILE &

file

)

Open root group for file.

---

The documentation for this class was generated from the following file:

• mi32/hdf4.h