FasTensor  1.0.0
Transform Supercomputing for AI
Public Member Functions | List of all members
EndpointPnetCDF Class Reference

#include <src/ft_endpoint_pnetcdf.h>

Inheritance diagram for EndpointPnetCDF:
Endpoint

Public Member Functions

 EndpointPnetCDF (std::string endpoint_info_p)
 Construct a new EndpointHDF5 object. More...
 
 ~EndpointPnetCDF ()
 
int ParseEndpointInfo () override
 parse endpoint_info to my own info More...
 
int ExtractMeta () override
 extracts metadata, possbile endpoint_ranks/endpoint_dim_size/other ep_type dependents ones More...
 
int PrintInfo () override
 print information about the endpoint More...
 
int Create () override
 create the endpoint More...
 
int Open () override
 open the endpoint More...
 
void Map2MyType () override
 call the finalize to close everything (like call Destractor) More...
 
int Read (std::vector< unsigned long long > start, std::vector< unsigned long long > end, void *data) override
 read the data from end-point More...
 
int Write (std::vector< unsigned long long > start, std::vector< unsigned long long > end, void *data) override
 write the data to the end-point More...
 
int Close () override
 close the end-point More...
 
- Public Member Functions inherited from Endpoint
 Endpoint ()
 
virtual ~Endpoint ()
 
std::vector< unsigned long long > GetDimensions ()
 Get the Dimensions of the data. More...
 
void SetDimensions (std::vector< unsigned long long > endpoint_dim_size_p)
 Set the Dimensions. More...
 
void SetDataElementType (AuEndpointDataType data_element_type_p)
 set the type of data element More...
 
AuEndpointDataType GetDataElementType ()
 Get the Type of Data Element. More...
 
int GetDataElementTypeSize ()
 Get the size of the type for the element. More...
 
void SetEndpointType (AuEndpointType endpoint_type_p)
 Set the Endpoint Type object. More...
 
AuEndpointType GetEndpointType ()
 Get the Endpoint Type object. More...
 
bool GetOpenFlag ()
 
void SetOpenFlag (bool open_flag_p)
 
bool GetCreateFlag ()
 
void SetCreateFlag (bool open_flag_p)
 
void SetRwFlag (unsigned read_write_flag_p)
 
unsigned GetRwFlag ()
 
std::vector< AuEndpointDataTypeUnionVoid2Union (void *vp, size_t n_elements)
 convert my data in (void *) type to Union type More...
 
void * Union2Void (std::vector< AuEndpointDataTypeUnion > &data_vector_in_union_type)
 convert data from union to void type More...
 
void SetEndpointInfo (std::string endpoint_info_p)
 set the endpoint_info string More...
 
std::string GetEndpointInfo ()
 Get the endpoint_info string. More...
 
virtual int WriteAttribute (const std::string &name, const void *data, FTDataType data_type_p, const size_t &data_length_p=0)
 Set the Attribute object Do not need to be pure virtual method. More...
 
virtual int ReadAttribute (const std::string &name, void *data, FTDataType data_type_p, const size_t &data_length_p=0)
 Get the Attribute object Do not need to be pure virtual method. More...
 
virtual int GetAttributeSize (const std::string &name, FTDataType data_type_p)
 
virtual void EnableCollectiveIO ()
 
virtual void DisableCollectiveIO ()
 
virtual std::vector< std::string > GetDirFileVector ()
 Get the Dir File Vector object. More...
 
virtual void SetDirFileVector (std::vector< std::string > &file_list)
 Set the Dir File Vector object. More...
 
virtual std::vector< int > GetDirChunkSize ()
 Get the Dir Chunk Size object. More...
 
virtual void SetDirChunkSize (std::vector< int > &dir_chunk_size_p)
 Set the Dir Chunk Size object. More...
 
virtual int Control (int opt_code, std::vector< std::string > &parameter_v)
 call a special operator on endpoint such as, enable collective I/O for HDF5 dump file from MEMORY to HDF5 More...
 
virtual int MapOpStr2Int (std::string op_cmd_str)
 map a op_cmd_str to int as input of SpecialOperator More...
 
virtual std::string MapOpInt2Str (int op_int)
 map op_int to string More...
 

Additional Inherited Members

- Protected Attributes inherited from Endpoint
AuEndpointType endpoint_type
 
std::string endpoint_info
 
std::vector< unsigned long long > endpoint_size
 
int endpoint_ranks
 
AuEndpointDataType data_element_type
 
std::string data_endpoint_orig
 
bool set_endpoint_dim_size_flag = false
 
bool open_flag = false
 
bool create_flag = false
 
unsigned read_write_flag
 

Detailed Description

Author: Bin Dong dbin@.nosp@m.lbl..nosp@m.gov Web: https://crd.lbl.gov/bin-dong Scientific Data Management Research Group Lawrence Berkeley National Laboratory

Constructor & Destructor Documentation

◆ EndpointPnetCDF()

EndpointPnetCDF::EndpointPnetCDF ( std::string  endpoint_info_p)
inline

Construct a new EndpointHDF5 object.

Parameters
data_endpointcontains the info of the endpoint, e.g., file type + file info

◆ ~EndpointPnetCDF()

EndpointPnetCDF::~EndpointPnetCDF ( )
inline

Member Function Documentation

◆ Close()

int EndpointPnetCDF::Close ( )
inlineoverridevirtual

close the end-point

Returns
int int < 0 error, >= 0 works

Implements Endpoint.

◆ Create()

int EndpointPnetCDF::Create ( )
inlineoverridevirtual

create the endpoint

Returns
< 0 error, >= 0 works

Implements Endpoint.

◆ ExtractMeta()

int EndpointPnetCDF::ExtractMeta ( )
inlineoverridevirtual

extracts metadata, possbile endpoint_ranks/endpoint_dim_size/other ep_type dependents ones

Returns
int < 0 error, >= 0 works

Implements Endpoint.

◆ Map2MyType()

void EndpointPnetCDF::Map2MyType ( )
inlineoverridevirtual

call the finalize to close everything (like call Destractor)

Returns
int

Implements Endpoint.

◆ Open()

int EndpointPnetCDF::Open ( )
inlineoverridevirtual

open the endpoint

Returns
< 0 error, >= 0 works

Implements Endpoint.

◆ ParseEndpointInfo()

int EndpointPnetCDF::ParseEndpointInfo ( )
inlineoverridevirtual

parse endpoint_info to my own info

Returns
int: 0 works, < 0 error,

Implements Endpoint.

◆ PrintInfo()

int EndpointPnetCDF::PrintInfo ( )
inlineoverridevirtual

print information about the endpoint

Returns
< 0 error, >= 0 works

Implements Endpoint.

◆ Read()

int EndpointPnetCDF::Read ( std::vector< unsigned long long >  start,
std::vector< unsigned long long >  end,
void *  data 
)
inlineoverridevirtual

read the data from end-point

Parameters
start,coordinatesof the cell to start (including)
end,coordinatesof the cell to end (including)
data,storethe result data
Returns
int < 0 error, >= 0 works

Implements Endpoint.

◆ Write()

int EndpointPnetCDF::Write ( std::vector< unsigned long long >  start,
std::vector< unsigned long long >  end,
void *  data 
)
inlineoverridevirtual

write the data to the end-point

Parameters
start,coordinatesof the cell to start (including)
end,coordinatesof the cell to end (including)
data,storethe result data
Returns
int < 0 error, >= 0 works

Implements Endpoint.


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