Inheritance diagram for openPMD::AbstractIOHandlerImplCommon< FilePositionType >:

Public Member Functions
	AbstractIOHandlerImplCommon (AbstractIOHandler *handler)

Public Member Functions inherited from openPMD::AbstractIOHandlerImpl
	AbstractIOHandlerImpl (AbstractIOHandler *handler)

std::future< void >	flush ()

virtual void	closeFile (Writable *, Parameter< Operation::CLOSE_FILE > const &)=0
	Close the file corresponding with the writable and release file handles.

virtual void	checkFile (Writable *, Parameter< Operation::CHECK_FILE > &)=0
	Check if the file specified by the parameter is already present on disk.

virtual void	advance (Writable *, Parameter< Operation::ADVANCE > &parameters)
	Advance the file/stream that this writable belongs to.

virtual void	closePath (Writable *, Parameter< Operation::CLOSE_PATH > const &)
	Close an openPMD group.

virtual void	availableChunks (Writable *, Parameter< Operation::AVAILABLE_CHUNKS > &)=0
	Report chunks that are available for loading from the dataset represented by this writable.

virtual void	createFile (Writable *, Parameter< Operation::CREATE_FILE > const &)=0
	Create a new file in physical storage, possibly overriding an existing file.

virtual void	createPath (Writable *, Parameter< Operation::CREATE_PATH > const &)=0
	Create all necessary groups for a path, possibly recursively.

virtual void	createDataset (Writable *, Parameter< Operation::CREATE_DATASET > const &)=0
	Create a new dataset of given type, extent and storage properties.

virtual void	extendDataset (Writable *, Parameter< Operation::EXTEND_DATASET > const &)=0
	Increase the extent of an existing dataset.

virtual void	openFile (Writable *, Parameter< Operation::OPEN_FILE > &)=0
	Open an existing file assuming it conforms to openPMD.

virtual void	openPath (Writable *, Parameter< Operation::OPEN_PATH > const &)=0
	Open all contained groups in a path, possibly recursively.

virtual void	openDataset (Writable *, Parameter< Operation::OPEN_DATASET > &)=0
	Open an existing dataset and determine its datatype and extent.

virtual void	deleteFile (Writable *, Parameter< Operation::DELETE_FILE > const &)=0
	Delete an existing file from physical storage.

virtual void	deletePath (Writable *, Parameter< Operation::DELETE_PATH > const &)=0
	Delete all objects within an existing path.

virtual void	deleteDataset (Writable *, Parameter< Operation::DELETE_DATASET > const &)=0
	Delete an existing dataset.

virtual void	deleteAttribute (Writable *, Parameter< Operation::DELETE_ATT > const &)=0
	Delete an existing attribute.

virtual void	writeDataset (Writable *, Parameter< Operation::WRITE_DATASET > &)=0
	Write a chunk of data into an existing dataset.

virtual void	getBufferView (Writable *, Parameter< Operation::GET_BUFFER_VIEW > &parameters)
	Get a view into a dataset buffer that can be filled by a user.

virtual void	writeAttribute (Writable *, Parameter< Operation::WRITE_ATT > const &)=0
	Create a single attribute and fill the value, possibly overwriting an existing attribute.

virtual void	readDataset (Writable *, Parameter< Operation::READ_DATASET > &)=0
	Read a chunk of data from an existing dataset.

virtual void	readAttribute (Writable *, Parameter< Operation::READ_ATT > &)=0
	Read the value of an existing attribute.

virtual void	readAttributeAllsteps (Writable *, Parameter< Operation::READ_ATT_ALLSTEPS > &)
	Collective task to read modifiable attributes over steps.

virtual void	listPaths (Writable *, Parameter< Operation::LIST_PATHS > &)=0
	List all paths/sub-groups inside a group, non-recursively.

virtual void	listDatasets (Writable *, Parameter< Operation::LIST_DATASETS > &)=0
	List all datasets inside a group, non-recursively.

virtual void	listAttributes (Writable *, Parameter< Operation::LIST_ATTS > &)=0
	List all attributes associated with an object.

virtual void	deregister (Writable *, Parameter< Operation::DEREGISTER > const &param)=0
	Notify the backend that the Writable has been / will be deallocated.

virtual void	touch (Writable *, Parameter< Operation::TOUCH > const &param)=0
	Treat this writable's file as open/active/dirty.

virtual void	setWritten (Writable *, Parameter< Operation::SET_WRITTEN > const &param)

template<typename... Args>
void	writeToStderr (Args &&...) const

template<typename... Args>
void	writeToStderr (Args &&...args) const

Protected Types
enum	PossiblyExisting { PE_InvalidatableFile = 0 , PE_Iterator , PE_NewlyCreated }

Protected Member Functions
std::tuple< InvalidatableFile, std::unordered_map< Writable *, InvalidatableFile >::iterator, bool >	getPossiblyExisting (std::string file)

void	associateWithFile (Writable *writable, InvalidatableFile file)

std::string	fullPath (InvalidatableFile)

std::string	fullPath (std::string)

InvalidatableFile	refreshFileFromParent (Writable *writable, bool preferParentFile)
	Get the writable's containing file.

std::shared_ptr< FilePositionType >	setAndGetFilePosition (Writable *writable, bool write=true)
	Figure out the file position of the writable.

virtual std::shared_ptr< FilePositionType >	setAndGetFilePosition (Writable *writable, std::string extend)
	Figure out the file position of the writable and extend it.

virtual std::string	filePositionToString (std::shared_ptr< FilePositionType >)=0

virtual std::shared_ptr< FilePositionType >	extendFilePosition (std::shared_ptr< FilePositionType > const &, std::string)=0

Protected Attributes
std::unordered_map< Writable *, InvalidatableFile >	m_files
	map each Writable to its associated file contains only the filename, without the OS path

std::unordered_set< InvalidatableFile >	m_dirty

Additional Inherited Members
Public Attributes inherited from openPMD::AbstractIOHandlerImpl
AbstractIOHandler *	m_handler

bool	m_verboseIOTasks = false

Member Function Documentation

◆ extendFilePosition()

template<typename FilePositionType = AbstractFilePosition>

virtual std::shared_ptr< FilePositionType > openPMD::AbstractIOHandlerImplCommon< FilePositionType >::extendFilePosition	(	std::shared_ptr< FilePositionType > const &	,
		std::string	)

protectedpure virtual

Returns: A new file position that is extended with the given string.

◆ filePositionToString()

template<typename FilePositionType = AbstractFilePosition>

virtual std::string openPMD::AbstractIOHandlerImplCommon< FilePositionType >::filePositionToString ( std::shared_ptr< FilePositionType > )

protectedpure virtual

Returns: A string representation of the file position.

◆ fullPath()

template<typename FilePositionType>

std::string openPMD::AbstractIOHandlerImplCommon< FilePositionType >::fullPath ( InvalidatableFile fileName )

protected

Returns: Full OS path of the file.

◆ refreshFileFromParent()

template<typename FilePositionType>

InvalidatableFile openPMD::AbstractIOHandlerImplCommon< FilePositionType >::refreshFileFromParent	(	Writable *	writable,
		bool	preferParentFile )

protected

Get the writable's containing file.

Parameters

writable	The writable whose containing file to figure out.
preferParentFile	If true, the file is set to the parent's file if present. Otherwise, the parent file is only considered if no own file is defined. This is usually needed when switching between iterations when opening paths.

Returns: The containing file of the writable. If its parent is associated with another file, update the writable to match its parent and return the refreshed file.

◆ setAndGetFilePosition() [1/2]

template<typename FilePositionType>

std::shared_ptr< FilePositionType > openPMD::AbstractIOHandlerImplCommon< FilePositionType >::setAndGetFilePosition	(	Writable *	writable,
		bool	write = true )

protected

Figure out the file position of the writable.

Only modify the writable's fileposition when specified.

Parameters

writable	The writable.
write	Whether to refresh the writable's file position.

Returns: The current file position.

◆ setAndGetFilePosition() [2/2]

template<typename FilePositionType>

std::shared_ptr< FilePositionType > openPMD::AbstractIOHandlerImplCommon< FilePositionType >::setAndGetFilePosition	(	Writable *	writable,
		std::string	extend )

protectedvirtual

Figure out the file position of the writable and extend it.

Parameters

writable	The writable.
extend	The extension string.

Returns: The current file position.

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

/tmp/tmp.NhLRcLhrNZ/openPMD-api/include/openPMD/backend/Writable.hpp
/tmp/tmp.NhLRcLhrNZ/openPMD-api/include/openPMD/IO/AbstractIOHandlerImplCommon.hpp

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ extendFilePosition()

◆ filePositionToString()

◆ fullPath()

◆ refreshFileFromParent()

◆ setAndGetFilePosition() [1/2]

◆ setAndGetFilePosition() [2/2]