#include <src/ft_endpoint_memory.h>

Inheritance diagram for EndpointMEMORY:

Public Member Functions
	EndpointMEMORY (std::string endpoint_info_p)
	Construct a new EndpointMEMORY object. More...

	EndpointMEMORY ()
	Construct a new Endpoint in MEMORY Nothing to do there, can be used as sub-endpoint of directory. More...

	~EndpointMEMORY ()

int	ExtractMeta ()
	extracts metadata, possbile endpoint_ranks/endpoint_dim_size/data_element_type More...

int	PrintInfo ()
	print information about the endpoint More...

int	Create ()
	create the endpoint More...

int	Open ()
	open the endpoint More...

int	Read (std::vector< unsigned long long > start, std::vector< unsigned long long > end, void *data)
	read the data from end-point More...

int	Write (std::vector< unsigned long long > start, std::vector< unsigned long long > end, void *data)
	write the data to the end-point More...

int	Close ()
	close the end-point More...

void	Map2MyType ()
	call the finalize to close everything (like call Destractor) More...

void	EnableCollectiveIO ()

void	DisableCollectiveIO ()

int	ParseEndpointInfo ()
	parse endpoint_info to my own info In MEMORY, it map endpoint_info to filename, group name and datasetname More...

int	SpecialOperator (int opt_code, std::vector< std::string > parameter_v)
	call a special operator on endpoint to dump file from MEMORY to HDF5, or in verse More...

int	Nonvolatile (std::string parameter)
	Nonvolatile the data in MEMORY to HDF5. More...

int	Volatile (std::string parameter)
	Volatile the data from HDF5 to MEMORY. More...

int	MergeMirrors (std::string op_str)
	Merger mirrors on all processes. More...

int	CreateLocalMirror (std::string init_value_str)
	Create a Local Mirror object. 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< AuEndpointDataTypeUnion >	Void2Union (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 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

Constructor & Destructor Documentation

◆ EndpointMEMORY() [1/2]

EndpointMEMORY::EndpointMEMORY ( std::string endpoint_info_p )

inline

Construct a new EndpointMEMORY object.

Parameters

data_endpoint contains the info of the endpoint, e.g., file type + file info

◆ EndpointMEMORY() [2/2]

EndpointMEMORY::EndpointMEMORY ( )

inline

Construct a new Endpoint in MEMORY Nothing to do there, can be used as sub-endpoint of directory.

◆ ~EndpointMEMORY()

EndpointMEMORY::~EndpointMEMORY ( )

inline

Member Function Documentation

◆ Close()

int EndpointMEMORY::Close ( )

inlinevirtual

close the end-point

Returns: int int < 0 error, >= 0 works

Implements Endpoint.

◆ Create()

int EndpointMEMORY::Create ( )

inlinevirtual

create the endpoint

Returns: < 0 error, >= 0 works

Implements Endpoint.

◆ CreateLocalMirror()

int EndpointMEMORY::CreateLocalMirror ( std::string init_value_str )

inline

Create a Local Mirror object.

Returns: int

◆ DisableCollectiveIO()

void EndpointMEMORY::DisableCollectiveIO ( )

inlinevirtual

Reimplemented from Endpoint.

◆ EnableCollectiveIO()

void EndpointMEMORY::EnableCollectiveIO ( )

inlinevirtual

Reimplemented from Endpoint.

◆ ExtractMeta()

int EndpointMEMORY::ExtractMeta ( )

inlinevirtual

extracts metadata, possbile endpoint_ranks/endpoint_dim_size/data_element_type

Returns: int < 0 error, >= 0 works

Implements Endpoint.

◆ Map2MyType()

void EndpointMEMORY::Map2MyType ( )

inlinevirtual

call the finalize to close everything (like call Destractor)

Returns: int

Implements Endpoint.

◆ MergeMirrors()

int EndpointMEMORY::MergeMirrors ( std::string op_str )

inline

Merger mirrors on all processes.

Returns: int

◆ Nonvolatile()

int EndpointMEMORY::Nonvolatile ( std::string parameter )

inline

Nonvolatile the data in MEMORY to HDF5.

Parameters

parameter

Returns: int

◆ Open()

int EndpointMEMORY::Open ( )

inlinevirtual

open the endpoint

Returns: < 0 error, >= 0 works

Implements Endpoint.

◆ ParseEndpointInfo()

int EndpointMEMORY::ParseEndpointInfo ( )

inlinevirtual

parse endpoint_info to my own info In MEMORY, it map endpoint_info to filename, group name and datasetname

Returns: int: 0 works, < 0 error,

Implements Endpoint.

◆ PrintInfo()

int EndpointMEMORY::PrintInfo ( )

inlinevirtual

print information about the endpoint

Returns: < 0 error, >= 0 works

Implements Endpoint.

◆ Read()

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

inlinevirtual

read the data from end-point

Parameters

start,coordinates	of the cell to start (including)
end,coordinates	of the cell to end (including)
data,store	the result data

Returns: int < 0 error, >= 0 works

Implements Endpoint.

◆ SpecialOperator()

int EndpointMEMORY::SpecialOperator	(	int	opt_code,
		std::vector< std::string >	parameter_v
	)

inline

call a special operator on endpoint to dump file from MEMORY to HDF5, or in verse

Parameters

opt_code,specially defined code

◆ Volatile()

int EndpointMEMORY::Volatile ( std::string parameter )

inline

Volatile the data from HDF5 to MEMORY.

Parameters

parameter

Returns: int

◆ Write()

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

inlinevirtual

write the data to the end-point

Parameters

start,coordinates	of the cell to start (including)
end,coordinates	of the cell to end (including)
data,store	the result data

Returns: int < 0 error, >= 0 works

Implements Endpoint.

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

ft_endpoint_memory.h

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ EndpointMEMORY() [1/2]

◆ EndpointMEMORY() [2/2]

◆ ~EndpointMEMORY()

Member Function Documentation

◆ Close()

◆ Create()

◆ CreateLocalMirror()

◆ DisableCollectiveIO()

◆ EnableCollectiveIO()

◆ ExtractMeta()

◆ Map2MyType()

◆ MergeMirrors()

◆ Nonvolatile()

◆ Open()

◆ ParseEndpointInfo()

◆ PrintInfo()

◆ Read()

◆ SpecialOperator()

◆ Volatile()

◆ Write()