BamTools::IBamIODevice Class Reference

#include <IBamIODevice.h>

List of all members.

Public Types
enum	OpenMode { NotOpen = 0x0000, ReadOnly = 0x0001, WriteOnly = 0x0002, ReadWrite = ReadOnly | WriteOnly }
Public Member Functions
virtual	~IBamIODevice (void)
virtual void	Close (void)=0
virtual bool	IsRandomAccess (void) const =0
virtual bool	Open (const OpenMode mode)=0
virtual int64_t	Read (char *data, const unsigned int numBytes)=0
virtual bool	Seek (const int64_t &position, const int origin=SEEK_SET)=0
virtual int64_t	Tell (void) const =0
virtual int64_t	Write (const char *data, const unsigned int numBytes)=0
virtual std::string	GetErrorString (void)
virtual bool	IsOpen (void) const
virtual OpenMode	Mode (void) const
Protected Member Functions
	IBamIODevice (void)
void	SetErrorString (const std::string &where, const std::string &what)
Protected Attributes
OpenMode	m_mode
std::string	m_errorString

---

Member Enumeration Documentation

enum BamTools::IBamIODevice::OpenMode

Enumerator:

NotOpen
ReadOnly
WriteOnly
ReadWrite

---

Constructor & Destructor Documentation

virtual BamTools::IBamIODevice::~IBamIODevice

(

void

)

[inline, virtual]

BamTools::IBamIODevice::IBamIODevice

(

void

)

[inline, protected]

---

Member Function Documentation

virtual void BamTools::IBamIODevice::Close

(

void

)

[pure virtual]

std::string BamTools::IBamIODevice::GetErrorString

(

void

)

[inline, virtual]

bool BamTools::IBamIODevice::IsOpen

(

void

)

const [inline, virtual]

virtual bool BamTools::IBamIODevice::IsRandomAccess

(

void

)

const [pure virtual]

IBamIODevice::OpenMode BamTools::IBamIODevice::Mode

(

void

)

const [inline, virtual]

virtual bool BamTools::IBamIODevice::Open

(

const OpenMode

mode

)

[pure virtual]

virtual int64_t BamTools::IBamIODevice::Read	(	char *	data,
		const unsigned int	numBytes
	)			[pure virtual]

virtual bool BamTools::IBamIODevice::Seek	(	const int64_t &	position,
		const int	origin = SEEK_SET
	)			[pure virtual]

void BamTools::IBamIODevice::SetErrorString	(	const std::string &	where,
		const std::string &	what
	)			[inline, protected]

virtual int64_t BamTools::IBamIODevice::Tell

(

void

)

const [pure virtual]

virtual int64_t BamTools::IBamIODevice::Write	(	const char *	data,
		const unsigned int	numBytes
	)			[pure virtual]

---

Member Data Documentation

std::string BamTools::IBamIODevice::m_errorString [protected]

OpenMode BamTools::IBamIODevice::m_mode [protected]

---

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

• IBamIODevice.h