XT Document

User Tools

Site Tools

Trace: • xanalysis • xh5io
class:kernel:xh5io

XH5IO

Inherited from NULL

Inherited by NULL

Friend class NULL

Description

XH5IO是一个封装了HDF5库函数的工具类，用来将数据转存为HDF5格式或者从HDF5格式中读取数据。HDF5(Hierarchical Data Format) 格式是一种常见的跨平台数据储存文件，可以存储不同类型的图像和数码数据，并且可以在不同类型的机器上传输，它按照Group树组织数据，每个Group节点可以包含若干属性和若干数据集（Dataset），Group树按照目录树的形式管理，因此可以很高效的随机访问数据。
HDF5处理数据时需要指定数据的保存文件中的类型（fType）和读取到内存中的类型（mType），为了方便的处理种类繁多形式各异的数据结构，XT引入了面向HDF5的数据成员定义（HMember数组，按照统一的宏定义即可构建特定数据结构的数据成员定义，根据数据成员定义XH5IO即可获取在HDF5中对应的数据类型，这一设计可以显著的减少开发人员为支持HDF5所要完成的编码工作量。

Members

Public interface

  • XH5IO()
  • ~XH5IO()
  • bool open(const char * fname, bool bWrite, bool bRead)
  • void clear()
  • void clearTempTypes()
  • void addTempType(DataType ** t)
  • void addGroup(const char * gName, bool bChunk = false)
  • H5Object * openGroup(const char * gname, bool bCreate = false)
  • H5Object * openIDGroup(const char * gname, ulong id, bool bCreate = false)
  • void getSubObjects(H5Object * parent, vector<string> * subNames)
  • void getSubGroups(H5Object * parent, vector<string> * subNames)
  • void getSubDatasets(H5Object * parent, vector<string> * subNames)
  • H5Object * openDataset(H5Object * grp, const char * dsname)
  • H5Object * openSubGroup(H5Object * parent, const char * gname)
  • H5Object * openIDGroup(H5Object * parent, const char * gname, ulong * id, XName * str)
  • Attribute * openAttribute(H5Object * parent, const char * dsname)
  • H5Object * createGroup(H5Object * parent, const char * gname)
  • H5Object * createIDGroup(H5Object * parent, const char * gname, ulong id)
  • void deleteGroup(H5Object * parent, const char * gname)
  • Attribute * createAttribute(H5Object * obj, const char * aname, DataType * dtype)
  • H5Object * createDataset(H5Object * grp, const char * dsname, DataType * dtype, size_t dim0, size_t dim1 = 0, int unitSize = 1, bool bChunk = false)
  • H5Object * createIDDataset(H5Object * grp, const char * dsname, int id, DataType * dtype, int unitSize = 1, bool bChunk = false)
  • H5Object * writeArrayDataset(H5Object * grp, const char * dsname, const XArray<float> * arr)
  • H5Object * writeArrayDataset(H5Object * grp, const char * dsname, const XArray<int> * arr)
  • H5Object * writeArrayDataset(H5Object * grp, const char * dsname, const XArray<ulong> * arr)
  • H5Object * writeArrayDataset(H5Object * grp, const char * dsname, const XArray<double> * arr)
  • H5Object * writeArrayDataset(H5Object * grp, const char * dsname, size_t size, const float * arr)
  • H5Object * writeArrayDataset(H5Object * grp, const char * dsname, size_t size, const int * arr)
  • H5Object * readArrayDataset(H5Object * grp, const char * dsname, XArray<float> * arr)
  • H5Object * readArrayDataset(H5Object * grp, const char * dsname, XArray<int> * arr)
  • H5Object * readArrayDataset(H5Object * grp, const char * dsname, XArray<ulong> * arr)
  • H5Object * readArrayDataset(H5Object * grp, const char * dsname, XArray<double> * arr)
  • H5Object * writeFieldDataset(H5Object * grp, const char * dsname, const XDataField * field)
  • H5Object * readFieldDataset(H5Object * grp, const char * dsname, XDataField * field)
  • void deleteDataset(H5Object * grp, const char * dsname)
  • size_t getDataCount(H5Object * dset)
  • size_t getDataTypeSize(DataType * dtype)
  • int getDataTypeOffset(DataType * dtype, const char * name)
  • int getDataMemberCount(DataType * dtype)
  • int getDataArrayCount(DataType * dtype)
  • bool checkDataType(H5Object * dset, vector<HMember> * memberStrings, int structSize)
  • bool readArray(H5Object * dset, float * buf)
  • bool readArray(H5Object * dset, int * buf)
  • bool readArray(H5Object * dset, ulong * buf)
  • bool readArray(H5Object * dset, double * buf)
  • bool readData(H5Object * dset, LabelVarSection * buf, bool bGroupOnSection = false)
  • bool readData(H5Object * grp, LabelVarGroup * buf, bool bGroupOnSection = false)
  • bool readData(H5Object * dset, const DataType * dtype, void * buf)
  • bool readAttribute(H5Object * dset, const char * aname, const DataType * dtype, void * buf)
  • bool readAttribute(H5Object * dset, const char * aname, DBVersion & buf)
  • bool readAttribute(H5Object * dset, const char * aname, ulong & buf)
  • bool readAttribute(H5Object * dset, const char * aname, int & buf)
  • bool readAttribute(H5Object * dset, const char * aname, size_t & buf)
  • bool readAttribute(H5Object * dset, const char * aname, long long & buf)
  • bool readAttribute(H5Object * dset, const char * aname, double & buf)
  • bool readAttribute(Attribute * dset, const DataType * dtype, void * buf)
  • bool readAttribute(H5Object * dset, const char * aname, char * buf)
  • bool readNameAttribute(H5Object * dset, const char * aname, char * buf)
  • bool readTypeAttribute(H5Object * dset, const char * aname, char * buf)
  • bool readPathAttribute(H5Object * dset, const char * aname, char * buf)
  • void writeArray(H5Object * dset, const float * buf)
  • void writeArray(H5Object * dset, const int * buf)
  • void writeArray(H5Object * dset, const ulong * buf)
  • void writeArray(H5Object * dset, const double * buf)
  • void writeData(H5Object * dset, const LabelVarSection * buf, bool bGroupOnSection = false)
  • void writeData(H5Object * grp, const LabelVarGroup * buf, bool bGroupOnSection = false)
  • void writeData(H5Object * dset, const DataType * dtype, const void * buf)
  • void writeExtendData(H5Object * dset, const DataType * dtype, size_t size, const void * buf)
  • void writeAttribute(H5Object * dset, const char * aname, const DataType * dtype, const void * buf)
  • void writeAttribute(H5Object * dset, const char * aname, const ulong & buf)
  • void writeAttribute(H5Object * dset, const char * aname, const int & buf)
  • void writeAttribute(H5Object * dset, const char * aname, const unsigned long long & buf)
  • void writeAttribute(H5Object * dset, const char * aname, const long long & buf)
  • void writeAttribute(H5Object * dset, const char * aname, const double & buf)
  • void writeAttribute(H5Object * dset, const char * aname, const char * buf)
  • void writeAttribute(Attribute * dset, const DataType * dtype, const void * buf)
  • void writeNameAttribute(H5Object * dset, const char * aname, const char * buf)
  • void writeTypeAttribute(H5Object * dset, const char * aname, const char * buf)
  • void writePathAttribute(H5Object * dset, const char * aname, const char * buf)
  • void writeAttribute(H5Object * dset, const char * aname, const DBVersion & buf)
  • DataType * addStructType(size_t tsize, vector<HMember> * memStrs = 0, bool bFileFormat = false)
  • void releaseType(DataType * dtype)
  • DataType * getDatasetType(H5Object * dset)
  • DataType * getStructMemberDataType(DataType * type, const char * name)
  • void getStructMemberValue(H5Object * dset, vector<HMember> * memberStrings, char * outBuf)
  • void closeGroup(H5Object * grp)
  • void closeDataset(H5Object * dset)
  • void closeAttribute(Attribute * atb)
  • void close()
  • bool test()
  • Attribute * createStructAttribute(H5Object * grp, const char * dsname)
  • void writeStructAttribute(Attribute * atb, const T * data)
  • void readStructAttribute(Attribute * dset, T * data)
  • H5Object * createStructDataset(H5Object * grp, const char * dsname, int count = 1)
  • void writeStruct(H5Object * dset, const T * data, bool bAutoClose)
  • int writeStructArray(H5Object * dset, const XArray<T> * darr, bool bAutoClose = false)
  • void readStruct(H5Object * dset, T * data, bool bAutoClose = false)
  • int readStructArray(H5Object * dset, XArray<T> * darr, bool bAutoClose = false)
  • int readStructArray(H5Object * dset, vector<T> * darr, bool bAutoClose = false)
  • void registerItemDataType(TypeID itemType, DataType * dataType)
  • void readStructMember(char * buf, DataType * type, vector<HMember> * members, const char * name, char * vbuf, int size)
  • void readStructMember(char * buf, DataType * type, vector<HMember> * members, const char * name, T * v)
  • const DBVersion & getVersion()

H5File * m_pFile

HDF5文件句柄

vector<DataType **> * m_pTempDTypes

临时对象类型指针数组，用于临时存放各种数据结构对应的mType和fType，在文件处理完成之后统一关闭。

XPath m_strPath

待处理的文件路径

TypeID m_iMode

HDF5文件的打开模式

DBVersion m_Version

文件的版本号

XH5IO()

  • function: 构造函数
  • parameters: NULL
  • return value: 无

~XH5IO()

  • function: 析构函数
  • parameters: NULL
  • return value: 无

bool open(const char * fname, bool bWrite, bool bRead)

  • function: 打开HDF5文件
  • parameters:
    1. [i]const char * fname: 文件路径
    2. [i] bool bWrite: 可写为true，只读为false
    3. [i] bool bRead: 可读为true，只写为false
  • return value: 打开成功返回true，否则返回false

void clear()

  • function: 通过删除文件清空文件内容
  • parameters: NULL
  • return value: 无

void clearTempTypes()

  • function: 清空临时对象类型
  • parameters: NULL
  • return value: 无

void addTempType(DataType ** t)

  • function: 添加临时的数据类型对象指针
  • parameters:
    1. [i]DataType ** t: 临时的数据类型对象指针
  • return value: 无

void addGroup(const char * gName, bool bChunk = false)

  • function: 添加Group节点
  • parameters:
    1. [i]const char * gName: 节点名称
    2. [i] bool bChunk = false: 是否分块设置
  • return value: 无

H5Object * openGroup(const char * gname, bool bCreate = false)

  • function: 打开Group节点，成功打开的对象需要调用closeGroup关闭
  • parameters:
    1. [i]const char * gname: 节点名称
    2. [i] bool bCreate = false: 如节点不存在，自动创建节点为true，否则为false，默认不创建
  • return value: 节点对象指针

H5Object * openIDGroup(const char * gname, ulong id, bool bCreate = false)

  • function: 打开包含ID信息的Group节点，Group节点名格式为ID[NAME],其中ID为数字,NAME为节点名称。成功打开的对象需要调用closeGroup关闭
  • parameters:
    1. [i]const char * gname: 节点名称
    2. [i] ulong id: 数字ID
    3. [i] bool bCreate = false: 如节点不存在，自动创建节点为true，否则为false，默认不创建
  • return value: 节点对象指针

void getSubObjects(H5Object * parent, vector<string> * subNames)

  • function: 获取H5对象的子对象名称数组（包含Group和Dataset）
  • parameters:
    1. [i]H5Object * parent: H5对象指针
    2. [i] vector<string> * subNames: 子对象名称数组
  • return value: 无

void getSubGroups(H5Object * parent, vector<string> * subNames)

  • function: 获取H5对象的子Group名称数组
  • parameters:
    1. [i]H5Object * parent: H5对象指针
    2. [i] vector<string> * subNames: 子Group名称数组
  • return value: 无

void getSubDatasets(H5Object * parent, vector<string> * subNames)

  • function: 获取H5对象的子Dataset名称数组
  • parameters:
    1. [i]H5Object * parent: H5对象指针
    2. [i] vector<string> * subNames: 子Dataset名称数组
  • return value: 无

H5Object * openDataset(H5Object * grp, const char * dsname)

  • function: 打开数据集节点,成功打开的数据集对象需要调用closeDataset关闭
  • parameters:
    1. [i]H5Object * grp: 数据集所在的Group节点对象指针
    2. [i] const char * dsname: 数据集名称
  • return value: 数据集对象指针

H5Object * openSubGroup(H5Object * parent, const char * gname)

  • function: 打开子group节点，成功打开的对象需要调用closeGroup关闭
  • parameters:
    1. [i]H5Object * parent: 父group节点
    2. [i] const char * gname: 子group名字
  • return value: 子Group对象指针

H5Object * openIDGroup(H5Object * parent, const char * gname, ulong * id, XName * str)

  • function: 打开parent中包含ID信息的子Group节点，Group节点名格式为ID[NAME],其中ID为数字,NAME为节点名称。成功打开的对象需要调用closeGroup关闭
  • parameters:
    1. [i]H5Object * parent: 父group对象指针
    2. [i] const char * gname: 子group名称
    3. [o] ulong * id: 用来保存数字ID
    4. [o] XName * str: 用来保存NAME字符串
  • return value: 子Group对象指针

Attribute * openAttribute(H5Object * parent, const char * dsname)

  • function: 打开parent中的属性，成功打开的属性需要调用closeAttribute关闭
  • parameters:
    1. [i]H5Object * parent: 父对象（Group对象或者Dataset对象）
    2. [i] const char * dsname: 属性名
  • return value: 属性对象指针

H5Object * createGroup(H5Object * parent, const char * gname)

  • function: 在parent对象中创建名称为gname的子Group，成功创建的Group对象需要调用closeGroup关闭
  • parameters:
    1. [i]H5Object * parent: 父Group对象指针
    2. [i] const char * gname: 子Group名称
  • return value: 子Group对象指针

H5Object * createIDGroup(H5Object * parent, const char * gname, ulong id)

  • function: 在parent中创建包含ID信息的子Group节点，Group节点名格式为ID[NAME],其中ID为数字,NAME为节点名称。成功打开的对象需要调用closeGroup关闭
  • parameters:
    1. [i]H5Object * parent: 父Group节点对象指针
    2. [i] const char * gname: 指定NAME字符串
    3. [i] ulong id: 指定ID
  • return value: 子group对象指针

void deleteGroup(H5Object * parent, const char * gname)

  • function: 在parent中删除group
  • parameters:
    1. [i]H5Object * parent: 父Group对象指针
    2. [i] const char * gname: 删除的Group对象名字
  • return value: 无

Attribute * createAttribute(H5Object * obj, const char * aname, DataType * dtype)

  • function: 给obj对象创建指定数据类型的属性，创建成功的属性对象需要调用closeAttribute关闭。
  • parameters:
    1. [i]H5Object * obj: HDF5对象（Group或者Dataset对象）
    2. [i] const char * aname: 属性名字
    3. [i] DataType * dtype: 属性的数据类型
  • return value: 属性对象指针

H5Object * createDataset(H5Object * grp, const char * dsname, DataType * dtype, size_t dim0, size_t dim1 = 0, int unitSize = 1, bool bChunk = false)

  • function: 在grp对象中创建一个数据集对象，创建成功的数据集对象需要调用closeDataset关闭。
  • parameters:
    1. [i]H5Object * grp: Group对象指针
    2. [i] const char * dsname: 数据集名字
    3. [i] DataType * dtype: 数据集的数据类型
    4. [i] size_t dim0: 数组的一维长度（非零整数）
    5. [i] size_t dim1 = 0: 数组的二维长度（如数据集只处理一维，则该值须为0）
    6. [i] int unitSize = 1: 数据块的大小，当bChunk为true时有效
    7. [i] bool bChunk = false: 是否分块存储
  • return value: 数据集对象指针

H5Object * createIDDataset(H5Object * grp, const char * dsname, int id, DataType * dtype)

  • function: 在grp对象中创建一个数据集对象，数据集名字格式为ID[NAME],其中ID为数字,NAME为数据集名称，创建成功的数据集对象需要调用closeDataset关闭。
  • parameters:
    1. [i]H5Object * grp: Group对象指针
    2. [i] const char * dsname: 指定NAME数据集名
    3. [i] int id: 指定ID
    4. [i] DataType * dtype: 数据集的数据类型
  • return value: 数据集对象指针

H5Object * writeArrayDataset(H5Object * grp, const char * dsname, const XArray<float> * arr)

  • function: 将float数组以数据集的形式写入到grp节点中，写入成功的数据集对象需要调用closeDataset关闭。
  • parameters:
    1. [i]H5Object * grp: Group节点对象指针
    2. [i] const char * dsname: 数据集名字
    3. [i] const XArray<float> * arr: 写入的float数组
  • return value: 数据集对象指针

H5Object * writeArrayDataset(H5Object * grp, const char * dsname, const XArray<int> * arr)

  • function: 将int数组以数据集的形式写入到grp节点中，写入成功的数据集对象需要调用closeDataset关闭。
  • parameters:
    1. [i]H5Object * grp: Group节点对象指针
    2. [i] const char * dsname: 数据集名字
    3. [i] const XArray<int> * arr: 写入的int数组
  • return value: 数据集对象指针

H5Object * writeArrayDataset(H5Object * grp, const char * dsname, const XArray<ulong> * arr)

  • function: 将float数组以数据集的形式写入到grp节点中，写入成功的数据集对象需要调用closeDataset关闭。
  • parameters:
    1. [i]H5Object * grp: Group节点对象指针
    2. [i] const char * dsname: 数据集名字
    3. [i] const XArray<ulong> * arr: 写入的ulong数组
  • return value: 数据集对象指针

H5Object * writeArrayDataset(H5Object * grp, const char * dsname, const XArray<double> * arr)

  • function: 将float数组以数据集的形式写入到grp节点中，写入成功的数据集对象需要调用closeDataset关闭。
  • parameters:
    1. [i]H5Object * grp: Group节点对象指针
    2. [i] const char * dsname: 数据集名字
    3. [i] const XArray<double> * arr: 写入的double数组
  • return value: 数据集对象指针

H5Object * writeArrayDataset(H5Object * grp, const char * dsname, size_t size, const float * arr)

  • function: 将float数组以数据集的形式写入到grp节点中，写入成功的数据集对象需要调用closeDataset关闭。
  • parameters:
    1. [i]H5Object * grp: Group节点对象指针
    2. [i] const char * dsname: 数据集名字
    3. [i] size_t size: float数组的长度
    4. [i] const float * arr: 写入的float数组
  • return value: 数据集对象指针

H5Object * writeArrayDataset(H5Object * grp, const char * dsname, size_t size, const int * arr)

  • function: 将float数组以数据集的形式写入到grp节点中，写入成功的数据集对象需要调用closeDataset关闭。
  • parameters:
    1. [i]H5Object * grp: Group节点对象指针
    2. [i] const char * dsname: 数据集名字
    3. [i] size_t size: int数组的长度
    4. [i] const int * arr: 写入的int数组
  • return value: 数据集对象指针

H5Object * readArrayDataset(H5Object * grp, const char * dsname, XArray<float> * arr)

  • function: 从grp节点下的名字为dsname的数据集中读取数据到float数组中，读入成功的数据集对象需要调用closeDataset关闭。
  • parameters:
    1. [i]H5Object * grp: Group节点对象指针
    2. [i] const char * dsname: 数据集名字
    3. [i] XArray<float> * arr: 数据读入到该数组对象中
  • return value: 数据集对象指针

H5Object * readArrayDataset(H5Object * grp, const char * dsname, XArray<int> * arr)

  • function: 从grp节点下的名字为dsname的数据集中读取数据到float数组中，读入成功的数据集对象需要调用closeDataset关闭。
  • parameters:
    1. [i]H5Object * grp: Group节点对象指针
    2. [i] const char * dsname: 数据集名字
    3. [i] XArray<int> * arr: 数据读入到该数组对象中
  • return value: 数据集对象指针

H5Object * readArrayDataset(H5Object * grp, const char * dsname, XArray<ulong> * arr)

  • function: 从grp节点下的名字为dsname的数据集中读取数据到float数组中，读入成功的数据集对象需要调用closeDataset关闭。
  • parameters:
    1. [i]H5Object * grp: Group节点对象指针
    2. [i] const char * dsname: 数据集名字
    3. [i] XArray<ulong> * arr: 数据读入到该数组对象中
  • return value: 数据集对象指针

H5Object * readArrayDataset(H5Object * grp, const char * dsname, XArray<double> * arr)

  • function: 从grp节点下的名字为dsname的数据集中读取数据到float数组中，读入成功的数据集对象需要调用closeDataset关闭。
  • parameters:
    1. [i]H5Object * grp: Group节点对象指针
    2. [i] const char * dsname: 数据集名字
    3. [i] XArray<double> * arr: 数据读入到该数组对象中
  • return value: 数据集对象指针

H5Object * writeFieldDataset(H5Object * grp, const char * dsname, const XDataField * field)

  • function: 将数据场以二维数据集的形式写入到grp节点中，写入成功的数据集对象需要调用closeDataset关闭。
  • parameters:
    1. [i]H5Object * grp: Group节点对象指针
    2. [i] const char * dsname: 数据集名字
    3. [i] const XDataField * field: 数据场对象
  • return value: 数据集对象指针

H5Object * readFieldDataset(H5Object * grp, const char * dsname, XDataField * field)

  • function: 从grp节点下的名字为dsname的数据集中读取数据到数据场对象中，读入成功的数据集对象需要调用closeDataset关闭。
  • parameters:
    1. [i]H5Object * grp: Group节点对象指针
    2. [i] const char * dsname: 数据集名字
    3. [i] XDataField * field: 数据场对象
  • return value: 数据集对象指针

void deleteDataset(H5Object * grp, const char * dsname)

  • function: 从grp节点中删除数据集
  • parameters:
    1. [i]H5Object * grp: Group节点对象指针
    2. [i] const char * dsname: 数据集名字
  • return value: 无

size_t getDataCount(H5Object * dset)

  • function: 获取数据集中的数据个数
  • parameters:
    1. [i]H5Object * dset: 数据集对象指针
  • return value: 数据个数

size_t getDataTypeSize(DataType * dtype)

  • function: 获取数据类型所占空间大小
  • parameters:
    1. [i]DataType * dtype: HDF5数据类型
  • return value: 数据类型所占空间大小

int getDataTypeOffset(DataType * dtype, const char * name)

  • function: 获取复合数据某个成员变量的位置偏移量
  • parameters:
    1. [i]DataType * dtype: HDF5数据类型
    2. [i] const char * name: 成员变量名字
  • return value: 成员变量的位置偏移量

int getDataMemberCount(DataType * dtype)

  • function: 获取复合数据类型的成员个数
  • parameters:
    1. [i]DataType * dtype: 复合数据类型
  • return value: 复合数据类型的成员个数

int getDataArrayCount(DataType * dtype)

  • function: 获取数组类型数据的个数
  • parameters:
    1. [i]DataType * dtype: 数组类型
  • return value: 数组类型数据的个数

bool checkDataType(H5Object * dset, vector<HMember> * memberStrings, int structSize)

  • function: 校验数据集是否匹配数据成员定义
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] vector<HMember> * memberStrings: 数据成员定义数组
    3. [i] int structSize: 结构体大小
  • return value: 如匹配返回true，否则返回false

bool readArray(H5Object * dset, float * buf)

  • function: 从数据集中读取float数据到预先分配好空间的数组buf中
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] float * buf: float数组
  • return value: 成功读取返回true，否则返回false

bool readArray(H5Object * dset, int * buf)

  • function: 从数据集中读取int数据到预先分配好空间的数组buf中
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] int * buf: int数组
  • return value: 成功读取返回true，否则返回false

bool readArray(H5Object * dset, ulong * buf)

  • function: 从数据集中读取ulong数据到预先分配好空间的数组buf中
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] ulong * buf: ulong数组
  • return value: 成功读取返回true，否则返回false

bool readArray(H5Object * dset, double * buf)

  • function: 从数据集中读取double数据到预先分配好空间的数组buf中
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] double * buf: double数组
  • return value: 成功读取返回true，否则返回false

bool readData(H5Object * obj, LabelVarSection * buf, bool bGroupOnSection = false)

  • function: 从对象obj中读取属性到带标签的变量块中，obj对象可能为Group（bGroupOnSection为true），也可能为Dataset（bGroupOnSection为false）
  • parameters:
    1. [i]H5Object * obj: H5对象
    2. [i] LabelVarSection * buf: 带标签的变量块
    3. [i] bool bGroupOnSection = false: 为true时obj对象为Group对象，否则为Dataset对象
  • return value: 成功读取返回true，否则返回false

bool readData(H5Object * grp, LabelVarGroup * buf, bool bGroupOnSection = false)

  • function: 从对象obj中读取属性到带标签的变量组中，当bGroupOnSection为true时不同子Group读入到不同的LabelVarSection 中，否则按照obj所有的数据集Dataset读入到不同的LabelVarSection中
  • parameters:
    1. [i]H5Object * grp: Group数据对象
    2. [i] LabelVarGroup * buf: 带标签的变量组（下面包含若干带标签的变量块）
    3. [i] bool bGroupOnSection = false: 当bGroupOnSection为true时不同子Group读入到不同的LabelVarSection 中，否则按照obj所有的数据集Dataset读入到不同的LabelVarSection中
  • return value: 成功读取返回true，否则返回false

bool readData(H5Object * dset, const DataType * dtype, void * buf)

  • function: 从数据集中读取数据到预先分配好内存的内存空间中
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const DataType * dtype: 数据集的数据类型
    3. [i] void * buf: 内存空间
  • return value: 成功读取返回true，否则返回false

bool readAttribute(H5Object * dset, const char * aname, const DataType * dtype, void * buf)

  • function: 从数据集对象中读取属性值到预先分配好的内存空间中
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 属性名
    3. [i] const DataType * dtype: 属性的内存数据类型
    4. [i] void * buf: 内存空间
  • return value: 成功读取返回true，否则返回false

bool readAttribute(H5Object * dset, const char * aname, DBVersion & buf)

  • function: 从数据集对象中读取版本属性值
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 属性名
    3. [o] DBVersion & buf: 版本数据对象
  • return value: 成功读取返回true，否则返回false

bool readAttribute(H5Object * dset, const char * aname, ulong & buf)

  • function: 从数据集对象中读取无符号整型值
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 属性名
    3. [o] ulong & buf: ulong变量的引用
  • return value: 成功读取返回true，否则返回false

bool readAttribute(H5Object * dset, const char * aname, int & buf)

  • function: 从数据集对象中读取整型值
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 属性名
    3. [o] int & buf: int变量的引用
  • return value: 成功读取返回true，否则返回false

bool readAttribute(H5Object * dset, const char * aname, size_t & buf)

  • function: 从数据集对象中读取size_t值
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 属性名
    3. [o] size_t & buf: size_t变量的引用
  • return value: 成功读取返回true，否则返回false

bool readAttribute(H5Object * dset, const char * aname, long long & buf)

  • function: 从数据集对象中读取long long值
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 属性名
    3. [o] long long & buf: long long变量的引用
  • return value: 成功读取返回true，否则返回false

bool readAttribute(H5Object * dset, const char * aname, double & buf)

  • function: 从数据集对象中读取double值
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 属性名
    3. [o] double & buf: double变量的引用
  • return value: 成功读取返回true，否则返回false

bool readAttribute(Attribute * dset, const DataType * dtype, void * buf)

  • function: 从属性对象中读取数据到预先分配好的内存空间中
  • parameters:
    1. [i]Attribute * dset: 属性对象
    2. [i] const DataType * dtype: 属性对象的内存数据类型
    3. [o] void * buf: 分配好的内存空间
  • return value: 成功读取返回true，否则返回false

bool readAttribute(H5Object * dset, const char * aname, char * buf)

  • function: 从数据集对象中读取字符串
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 字符串属性名
    3. [o] char * buf: 预先分配好的字符串内存空间
  • return value: 成功读取返回true，否则返回false

bool readNameAttribute(H5Object * dset, const char * aname, char * buf)

  • function: 从数据集对象中读取字符串到XName所指向的空间
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 字符串属性名
    3. [o] char * buf: XName对象所指向的字符串空间(64个字符大小）
  • return value: 成功读取返回true，否则返回false

bool readTypeAttribute(H5Object * dset, const char * aname, char * buf)

  • function: 从数据集对象中读取字符串到XType变量所指向的空间
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 字符串属性名
    3. [o] char * buf: XType对象所指向的字符串空间(16个字符大小）
  • return value:成功读取返回true，否则返回false

bool readPathAttribute(H5Object * dset, const char * aname, char * buf)

  • function: 从数据集对象中读取字符串到XPath变量所指向的空间
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 字符串属性名
    3. [o] char * buf: XPath对象所指向的字符串空间(256个字符大小）
  • return value: 成功读取返回true，否则返回false

void writeArray(H5Object * dset, const float * buf)

  • function: 将float数组写入到数据集对象中。
  • parameters:
    1. [i]H5Object * dset: 数据集对象指针
    2. [o] const float * buf: 写入的float数组
  • return value: 无

void writeArray(H5Object * dset, const int * buf)

  • function: 将float数组写入到数据集对象中。
  • parameters:
    1. [i]H5Object * dset: 数据集对象指针
    2. [o] const int * buf: 写入的int数组
  • return value: 无

void writeArray(H5Object * dset, const ulong * buf)

  • function: 将float数组写入到数据集对象中。
  • parameters:
    1. [i]H5Object * dset: 数据集对象指针
    2. [o] const ulong * buf: 写入的ulong数组
  • return value: 无

void writeArray(H5Object * dset, const double * buf)

  • function: 将float数组写入到数据集对象中。
  • parameters:
    1. [i]H5Object * dset: 数据集对象指针
    2. [o] const double * buf: 写入的double数组
  • return value: 无

void writeData(H5Object * obj, const LabelVarSection * buf, bool bGroupOnSection = false)

  • function: 带标签的变量块以属性写入到从对象obj中，obj对象可能为Group（bGroupOnSection为true），也可能为Dataset（bGroupOnSection为false）
  • parameters:
    1. [i]H5Object * obj: HDF5对象，当bGroupOnSection为true时为Group对象，否则为Dataset对象
    2. [i] const LabelVarSection * buf: 带标签的变量块
    3. [i] bool bGroupOnSection = false: 当bGroupOnSection为true时obj对象为Group对象，否则为Dataset对象
  • return value: 无

void writeData(H5Object * grp, const LabelVarGroup * buf, bool bGroupOnSection = false)

  • function: 带标签的变量组写入从对象grp中，当bGroupOnSection为true时不同LabelVarSection 写入到不同的子Group中，否则LabelVarSection写入到不同的数据集Dataset中
  • parameters:
    1. [i]H5Object * grp: Group对象指针
    2. [i] const LabelVarGroup * buf: 带标签的变量组
    3. [i] bool bGroupOnSection = false: 当bGroupOnSection为true时不同LabelVarSection 写入到不同的子Group中，否则LabelVarSection写入到不同的数据集Dataset中
  • return value: 无

void writeData(H5Object * dset, const DataType * dtype, const void * buf)

  • function: 将内存中的内容按照数据类型dtype写入到数据集中
  • parameters:
    1. [i]H5Object * dset: 数据集对象（文件数据类型已在创建的时候指定好）
    2. [i] const DataType * dtype: buf的内存数据类型
    3. [i] const void * buf: 内存地址
  • return value: 无

void writeExtendData(H5Object * dset, const DataType * dtype, size_t size, const void * buf)

  • function: 将内存中的数据按照给定数据类型增加到数据集中
  • parameters:
    1. [i]H5Object * dset: 数据集对象（文件数据类型已在创建的时候指定好）
    2. [i] const DataType * dtype: buf的内存数据类型
    3. [i] size_t size: 新增加的数据个数
    4. [i] const void * buf: 内存地址
  • return value: 无

void writeAttribute(H5Object * dset, const char * aname, const DataType * dtype, const void * buf)

  • function: 将内存中的内容按照数据类型dtype以属性写入到数据集中
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 属性名
    3. [i] const DataType * dtype: buf的内存数据类型
    4. [i] const void * buf: 内存地址
  • return value: 无

void writeAttribute(H5Object * dset, const char * aname, const ulong & buf)

  • function: 将ulong变量以属性写入到数据集中
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 属性名
    3. [i] const ulong & buf: ulong变量的引用
  • return value: 无

void writeAttribute(H5Object * dset, const char * aname, const int & buf)

  • function: 将int变量以属性写入到数据集中
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 属性名
    3. [i] const int & buf: int变量的引用
  • return value: 无

void writeAttribute(H5Object * dset, const char * aname, const unsigned long long & buf)

  • function: 将unsigned long long变量以属性写入到数据集中
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 属性名
    3. [i] const unsigned long long & buf: unsigned long long变量的引用
  • return value: 无

void writeAttribute(H5Object * dset, const char * aname, const long long & buf)

  • function: 将long long变量以属性写入到数据集中
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 属性名
    3. [i] const long long & buf: long long变量
  • return value: 无

void writeAttribute(H5Object * dset, const char * aname, const double & buf)

  • function: 将double变量以属性写入到数据集中
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 属性名
    3. [i] const double & buf: double变量
  • return value: 无

void writeAttribute(H5Object * dset, const char * aname, const char * buf)

  • function: 将字符串以属性写入到数据集中
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 属性名
    3. [i] const char * buf: 字符串变量
  • return value: 无

void writeAttribute(Attribute * dset, const DataType * dtype, const void * buf)

  • function: 将内存中的内容按照数据类型dtype写入到属性中
  • parameters:
    1. [i]Attribute * dset: 属性对象
    2. [i] const DataType * dtype: 属性名
    3. [i] const void * buf: 内存地址
  • return value: 无

void writeNameAttribute(H5Object * dset, const char * aname, const char * buf)

  • function: 将XName变量以属性写入到数据集中
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 属性名
    3. [i] const char * buf: XName的字符串地址
  • return value: 无

void writeTypeAttribute(H5Object * dset, const char * aname, const char * buf)

  • function: 将XType变量以属性写入到数据集中
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 属性名
    3. [i] const char * buf: XType对象的字符串地址
  • return value: 无

void writePathAttribute(H5Object * dset, const char * aname, const char * buf)

  • function: 将XPath变量以属性写入到数据集中
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 属性名
    3. [i] const char * buf: XPath对象的字符串地址
  • return value: 无

void writeAttribute(H5Object * dset, const char * aname, const DBVersion & buf)

  • function: 将DBVersion变量以属性写入到数据集中
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const char * aname: 属性名
    3. [i] const DBVersion & buf: DBVersion变量
  • return value: 无

DataType * addStructType(size_t tsize, vector<HMember> * memStrs = 0, bool bFileFormat = false)

  • function: 基于数据成员定义添加struct数据的数据类型
  • parameters:
    1. [i]size_t tsize: 数据类型大小
    2. [i] vector<HMember> * memStrs = 0: 数据成员定义，为空时仅指定数据类型大小
    3. [i] bool bFileFormat = false: 是否文件数据类型
  • return value: 数据类型对象的指针

void releaseType(DataType * dtype)

  • function: 释放数据类型对象
  • parameters:
    1. [i]DataType * dtype: 数据类型对象的指针
  • return value: 无

DataType * getDatasetType(H5Object * dset)

  • function: 获取数据集的数据类型
  • parameters:
    1. [i]H5Object * dset: 数据集对象
  • return value: 数据集的数据类型

DataType * getStructMemberDataType(DataType * type, const char * name)

  • function: 获取复合数据类型的成员的数据类型
  • parameters:
    1. [i]DataType * type: 复合数据类型
    2. [i] const char * name: 成员变量名
  • return value: 成员变量的数据类型

void getStructMemberValue(H5Object * dset, vector<HMember> * memberStrings, char * outBuf)

  • function: 按照数据成员定义获取复合数据的成员变量的值，用于数据结构已经发生修改的场合（此时数据成员定义与数据集中保存的结构并不保证一一对应）
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] vector<HMember> * memberStrings: 数据成员定义
    3. [o] char * outBuf: 内存地址
  • return value: 无

void closeGroup(H5Object * grp)

  • function: 关闭Group对象
  • parameters:
    1. [i]H5Object * grp: Group对象指针
  • return value: 无

void closeDataset(H5Object * dset)

  • function: 关闭数据集对象
  • parameters:
    1. [i]H5Object * dset: 数据集对象
  • return value: 无

void closeAttribute(Attribute * atb)

  • function: 关闭属性对象
  • parameters:
    1. [i]Attribute * atb: 属性对象
  • return value: 无

void close()

  • function: 关闭HDF5句柄
  • parameters: NULL
  • return value: 无

bool test()

  • function: 测试函数
  • parameters: NULL
  • return value: 测试成功返回true，否则返回false

template <typename T> Attribute * createStructAttribute(H5Object * grp, const char * dsname)

  • function: 模板函数，根据类T的数据成员定义表在grp对象中创建属性，创建好的对象需要调用closeAttribute关闭
  • parameters:
    1. [i]H5Object * grp: HDF5数据节点对象
    2. [i] const char * dsname: 属性名
  • return value: 属性对象指针

template <typename T> void writeStructAttribute(Attribute * atb, const T * data)

  • function: 模板函数，根据类T的数据成员定义表将data写入到属性atb中
  • parameters:
    1. [i]Attribute * atb: HDF5属性对象
    2. [i] const T * data: T类型的变量
  • return value: 无

template <typename T> void readStructAttribute(Attribute * dset, T * data)

  • function: 模板函数，根据类T的数据成员定义表从属性中读取值到T对象data中
  • parameters:
    1. [i]Attribute * dset: HDF5属性对象
    2. [i] T * data: T类型的变量
  • return value: 无

template <typename T> H5Object * createStructDataset(H5Object * grp, const char * dsname, int count = 1)

  • function: 模板函数，根据类T的数据成员定义表在grp对象中创建数据集，创建好的对象需要调用closeDataset关闭
  • parameters:
    1. [i]H5Object * grp: Group对象指针
    2. [i] const char * dsname: 数据集名字
    3. [i] int count = 1: 数据的个数
  • return value: 数据集对象

template <typename T> void writeStruct(H5Object * dset, const T * data, bool bAutoClose)

  • function: 模板函数，根据类T的数据成员定义表将data写入到数据集中,如bAutoClose为真，自动关闭数据集对象
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const T * data: T类型变量
    3. [i] bool bAutoClose: 如bAutoClose为真，自动关闭数据集对象
  • return value: 无

template <typename T> int writeStructArray(H5Object * dset, const XArray<T> * darr, bool bAutoClose = false)

  • function: 模板函数，根据类T的数据成员定义表将数组写入到数据集中,如bAutoClose为真，自动关闭数据集对象
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] const XArray<T> * darr: T类型数组
    3. [i] bool bAutoClose = false: 如bAutoClose为真，自动关闭数据集对象
  • return value: 无

template <typename T> void readStruct(H5Object * dset, T * data, bool bAutoClose = false)

  • function: 模板函数，根据类T的数据成员定义表从数据集中读取值到T对象data中,如bAutoClose为真，自动关闭数据集对象
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] T * data: T类型变量
    3. [i] bool bAutoClose = false: 如bAutoClose为真，自动关闭数据集对象
  • return value: 无

template <typename T> int readStructArray(H5Object * dset, XArray<T> * darr, bool bAutoClose = false)

  • function: 模板函数，根据类T的数据成员定义表从数据集中读取值到T对象数组中,如bAutoClose为真，自动关闭数据集对象
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] XArray<T> * darr: T类型数组
    3. [i] bool bAutoClose = false: 如bAutoClose为真，自动关闭数据集对象
  • return value: 无

template <typename T> int readStructArray(H5Object * dset, vector<T> * darr, bool bAutoClose = false)

  • function: 模板函数，根据类T的数据成员定义表从数据集中读取值到T对象数组中,如bAutoClose为真，自动关闭数据集对象
  • parameters:
    1. [i]H5Object * dset: 数据集对象
    2. [i] vector<T> * darr: T类型数组
    3. [i] bool bAutoClose = false: 如bAutoClose为真，自动关闭数据集对象
  • return value: 无

void readStructMember(char * buf, DataType * type, vector<HMember> * members, const char * name, char * vbuf, int size)

  • function: 基于数据成员定义表从已经读取出来的内存空间中获取某个成员变量的值
  • parameters:
    1. [i]char * buf: 已经读取出来的内存空间地址
    2. [i] DataType * type: buf所对应的内存数据类型
    3. [i] vector<HMember> * members: 数据成员定义表
    4. [i] const char * name: 成员变量名
    5. [i] char * vbuf: 成员变量地址
    6. [i] int size: 成员变量大小
  • return value: 无

template <typename T> void readStructMember(char * buf, DataType * type, vector<HMember> * members, const char * name, T * v)

  • function: 模板函数, 基于数据成员定义表从已经读取出来的内存空间中获取某个成员变量的值
  • parameters:
    1. [i]char * buf: 已经读取出来的内存空间地址
    2. [i] DataType * type: buf所对应的内存数据类型
    3. [i] vector<HMember> * members: 数据成员定义表
    4. [i] const char * name: 成员变量名
    5. [i] T * v: 成员变量地址
  • return value: 无

const DBVersion & getVersion()

  • function: 获取文件的版本号
  • parameters: NULL
  • return value: 文件的版本数据
class/kernel/xh5io.txt · Last modified: 2023/05/06 07:01 (external edit)

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki