Seismic Drive Client API
Public Member Functions | Public Attributes | List of all members
seismicdrive::SDHierarchicalMetaData Class Reference

This class represents the metadata of a hierarchical dataset. More...

#include <SDHierarchicalDatasetAccessor.h>

Public Member Functions

 SDHierarchicalMetaData (const std::string &name="", uint64_t nobjects=0, uint64_t size=0)
 
bool operator== (const SDHierarchicalMetaData &rhs)
 Equals operator. More...
 

Public Attributes

std::string _name
 Name of the node. More...
 
uint64_t _nobjects
 Number of objects in the node. More...
 
uint64_t _size
 Total size in byte of the object in the node. More...
 

Detailed Description

This class represents the metadata of a hierarchical dataset.

This class is a struct to store and manage the Hierarchical Dataset Metadata.

Constructor & Destructor Documentation

◆ SDHierarchicalMetaData()

seismicdrive::SDHierarchicalMetaData::SDHierarchicalMetaData ( const std::string &  name = "",
uint64_t  nobjects = 0,
uint64_t  size = 0 
)
inline

Constructor.

Parameters
nameis the name of a node of the hierarchical structure.
nobjectsis the number of objects of the node.
sizeis the total size of objects of the node.

Member Function Documentation

◆ operator==()

bool seismicdrive::SDHierarchicalMetaData::operator== ( const SDHierarchicalMetaData rhs)
inline

Equals operator.

Compares two SDHierarchicalMetaData objects

Returns
true if the two objects are equal

Member Data Documentation

◆ _name

std::string seismicdrive::SDHierarchicalMetaData::_name

Name of the node.

◆ _nobjects

uint64_t seismicdrive::SDHierarchicalMetaData::_nobjects

Number of objects in the node.

◆ _size

uint64_t seismicdrive::SDHierarchicalMetaData::_size

Total size in byte of the object in the node.


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