ICell Class Reference

Interface to be used for storage feature. More...

#include <ICell.hpp>

Inheritance diagram for ICell:

Public Member Functions
virtual	~ICell ()
virtual ICell *	getParent () const =0
virtual const std::string &	getId () const =0
virtual std::string	getFullId (char sep='.') const =0
virtual void	remove ()=0
virtual void	setCompressLevel (int level)=0
virtual int	getCompressLevel () const =0
Public Member Functions inherited from ISmartPointer
virtual	~ISmartPointer ()
virtual void	use ()=0
virtual void	forget ()=0

Static Public Member Functions
static ICell *	getRoot (ICell *cell)

Detailed Description

Interface to be used for storage feature.

This interface defines a few methods for hierarchical management of entities that can be stored (likely in file system).

Constructor & Destructor Documentation

virtual ~ICell ( )

inlinevirtual

Destructor.

Member Function Documentation

virtual int getCompressLevel ( ) const

pure virtual

Get the compression level

Returns

the compression level.

Implemented in Cell.

virtual std::string getFullId ( char  sep = '.' ) const

pure virtual

Return the full identifier (like a path "x.y.z")

Parameters

[in]

sep

: separator character for the path string

Returns

the full identifier.

Implemented in Cell.

virtual const std::string& getId ( ) const

pure virtual

Return the identifier of the node.

Returns

the id of the node.

Implemented in Cell.

virtual ICell* getParent ( ) const

pure virtual

Get the parent node (if any).

Returns

the parent node.

Implemented in Cell.

static ICell* getRoot ( ICell *  cell )

inlinestatic

Get the root of the given cell

Parameters

[in]

cell

: the cell we want to get the root

Returns

the root of the given cell

virtual void remove ( )

pure virtual

Physically remove the node.

Implemented in Storage, Partition< Type >, Partition< gatb::core::kmer::impl::Kmer::Count >, Group, and CollectionNode< Item >.

virtual void setCompressLevel ( int  level )

pure virtual

Set the compression level (if supported)

Parameters

[in]

level

: from 0 (no compression) to 9 (best compression).

Implemented in Cell.

---

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

• /builds/workspace/publish-doc-api-gitlab/gatb-core/src/gatb/tools/storage/api/ICell.hpp