NeXusDataFormat
1
NeXusCAPI
|
Functions | |
NXstatus | NXopenpath (NXhandle handle, CONSTCHAR *path) |
Open the NeXus object with the path specified. | |
NXstatus | NXopengrouppath (NXhandle handle, CONSTCHAR *path) |
Opens the group in which the NeXus object with the specified path exists. | |
NXstatus | NXgetpath (NXhandle handle, char *path, int pathlen) |
Retrieve the current path in the NeXus file. | |
NXstatus | NXopensourcegroup (NXhandle handle) |
Open the source group of a linked group or dataset. | |
NXstatus | NXgetnextentry (NXhandle handle, NXname name, NXname nxclass, int *datatype) |
Get the next entry in the currently open group. | |
NXstatus | NXinitgroupdir (NXhandle handle) |
Resets a pending group search to the start again. | |
NXstatus | NXinitattrdir (NXhandle handle) |
Resets a pending attribute search to the start again. |
NXstatus NXgetnextentry | ( | NXhandle | handle, |
NXname | name, | ||
NXname | nxclass, | ||
int * | datatype | ||
) |
Get the next entry in the currently open group.
This is for retrieving infromation about the content of a NeXus group. In order to search a group NXgetnextentry is called in a loop until NXgetnextentry returns NX_EOD which indicates that there are no further items in the group. Reset search using NXinitgroupdir
handle | A NeXus file handle as initialized by NXopen. |
name | The name of the object |
nxclass | The NeXus class name for a group or the string SDS for a dataset. |
datatype | The NeXus data type if the item is a SDS. |
NXstatus NXgetpath | ( | NXhandle | handle, |
char * | path, | ||
int | pathlen | ||
) |
Retrieve the current path in the NeXus file.
handle | a NeXus file handle |
path | A buffer to copy the path too |
pathlen | The maximum number of characters to copy into path |
NXstatus NXinitattrdir | ( | NXhandle | handle | ) |
Resets a pending attribute search to the start again.
To be called in a NXgetnextattr loop when an attribute search has to be restarted.
handle | A NeXus file handle as initialized by NXopen. |
NXstatus NXinitgroupdir | ( | NXhandle | handle | ) |
Resets a pending group search to the start again.
To be called in a NXgetnextentry loop when a group search has to be restarted.
handle | A NeXus file handle as initialized by NXopen. |
NXstatus NXopengrouppath | ( | NXhandle | handle, |
CONSTCHAR * | path | ||
) |
Opens the group in which the NeXus object with the specified path exists.
handle | A NeXus file handle as initialized by NXopen. |
path | A unix like path string to a NeXus group or dataset. The path string is a list of group names and SDS names separated with / (slash). Example: /entry1/sample/name |
NXstatus NXopenpath | ( | NXhandle | handle, |
CONSTCHAR * | path | ||
) |
Open the NeXus object with the path specified.
handle | A NeXus file handle as returned from NXopen. |
path | A unix like path string to a NeXus group or dataset. The path string is a list of group names and SDS names separated with / (slash). Example: /entry1/sample/name |
NXstatus NXopensourcegroup | ( | NXhandle | handle | ) |
Open the source group of a linked group or dataset.
Returns an error when the item is not a linked item.
handle | A NeXus file handle as initialized by NXopen. |