Implements evioChannel functionality for I/O to and from files. More...

#include <evioFileChannel.hxx>

Inheritance diagram for evio::evioFileChannel:

Public Member Functions
	evioFileChannel (const string &fileName, const string &mode="r", int size=1000000)
	Constructor opens channel for reading or writing. More...

	evioFileChannel (const string &fileName, evioDictionary *dict, const string &mode="r", int size=1000000)
	Constructor opens channel for reading or writing, dictionary specified. More...

	evioFileChannel (const string &fileName, evioDictionary dict, const uint32_t firstEvent, const string &mode="w", int size=1000000)
	Constructor opens channel for reading or writing to file with dictionary specified, If writing, the first event (an event which gets written once in each split file) may also be specified. More...

virtual	~evioFileChannel ()
	Destructor closes file, deletes internal buffer, deletes dictionary one created from file. More...

void	open ()
	Opens channel for reading or writing. More...

bool	read ()
	Reads from file into internal buffer. More...

bool	read (uint32_t *myEventBuf, int length)
	Reads from file into user-supplied buffer. More...

bool	readAlloc (uint32_t *buffer, uint32_t bufLen)
	Reads from file and allocates buffer as needed. More...

bool	readNoCopy ()
	Reads from file using no copy mechanism. More...

bool	readRandom (uint32_t bufferNumber)
	Reads buffer from file given buffer number. More...

void	write ()
	Writes to file from internal buffer. More...

void	write (const uint32_t *myEventBuf)
	Writes to file from user-supplied buffer. More...

void	write (const evioChannel &channel)
	Writes to file from internal buffer of another evioChannel object. More...

void	write (const evioChannel *channel)
	Writes from internal buffer of another evioChannel object. More...

void	write (const evioChannelBufferizable &o)
	Writes from contents of evioChannelBufferizable object. More...

void	write (const evioChannelBufferizable *o)
	Writes from contents of evioChannelBufferizable object. More...

void	close ()
	Closes channel. More...

int	ioctl (const string &request, void *argp)
	For getting and setting evIoctl parameters. More...

const uint32_t *	getBuffer () const
	Returns pointer to internal channel buffer. More...

int	getBufSize () const
	Returns internal channel buffer size. More...

const uint32_t *	getNoCopyBuffer () const
	Returns pointer to no copy buffer. More...

const uint32_t *	getRandomBuffer () const
	Returns pointer to random buffer. More...

void	getRandomAccessTable (uint32_t **const table, uint32_t len) const
	Returns random access table. More...

string	getFileName () const
	Returns channel file name. More...

string	getMode () const
	Returns channel I/O mode. More...

string	getFileXMLDictionary () const
	Returns XML dictionary read in from file. More...

Public Member Functions inherited from evio::evioChannel
	evioChannel ()

	evioChannel (evioDictionary *dict)

virtual	~evioChannel ()

virtual const evioDictionary *	getDictionary () const

Additional Inherited Members
Protected Attributes inherited from evio::evioChannel
evioDictionary *	dictionary

Detailed Description

Implements evioChannel functionality for I/O to and from files.

Basically a wrapper around the original evio C library.

Constructor & Destructor Documentation

◆ evioFileChannel() [1/3]

evioFileChannel::evioFileChannel	(	const string &	f,
		const string &	m = `"r"`,
		int	size = `1000000`
	)

Constructor opens channel for reading or writing.

Parameters

f	File name
m	I/O mode, "r", "ra", "w", "a", or "s"
size	Internal buffer size

◆ evioFileChannel() [2/3]

evioFileChannel::evioFileChannel	(	const string &	f,
		evioDictionary *	dict,
		const string &	m = `"r"`,
		int	size = `1000000`
	)

Constructor opens channel for reading or writing, dictionary specified.

Parameters

f	File name
dict	Dictionary
m	I/O mode, "r", "ra", "w", "a", or "s"
size	Internal buffer size

◆ evioFileChannel() [3/3]

evioFileChannel::evioFileChannel	(	const string &	f,
		evioDictionary *	dict,
		const uint32_t *	firstEvent,
		const string &	m = `"w"`,
		int	size = `1000000`
	)

Constructor opens channel for reading or writing to file with dictionary specified, If writing, the first event (an event which gets written once in each split file) may also be specified.

Parameters

f	File name
dict	Dictionary
firstEvent	buffer containing first event
m	I/O mode, "r", "ra", "w", "a", or "s"
size	Internal buffer size

◆ ~evioFileChannel()

evioFileChannel::~evioFileChannel ( )

virtual

Destructor closes file, deletes internal buffer, deletes dictionary one created from file.

References close(), and evio::evioChannel::dictionary.

Member Function Documentation

◆ close()

void evioFileChannel::close ( )

virtual

Closes channel.

Implements evio::evioChannel.

Referenced by ~evioFileChannel().

◆ getBuffer()

const uint32_t * evioFileChannel::getBuffer ( ) const

virtual

Returns pointer to internal channel buffer.

Returns: Pointer to internal buffer

Implements evio::evioChannel.

◆ getBufSize()

int evioFileChannel::getBufSize ( ) const

virtual

Returns internal channel buffer size.

Returns: Internal buffer size in 4-byte words

Implements evio::evioChannel.

◆ getFileName()

string evioFileChannel::getFileName ( ) const

Returns channel file name.

Returns: String containing file name

◆ getFileXMLDictionary()

string evioFileChannel::getFileXMLDictionary ( ) const

Returns XML dictionary read in from file.

Returns: XML dictionary read in from file

◆ getMode()

string evioFileChannel::getMode ( ) const

Returns channel I/O mode.

Returns: String containing I/O mode

◆ getNoCopyBuffer()

const uint32_t * evioFileChannel::getNoCopyBuffer ( ) const

virtual

Returns pointer to no copy buffer.

Returns: Pointer to no copy buffer

Implements evio::evioChannel.

◆ getRandomAccessTable()

void evioFileChannel::getRandomAccessTable	(	uint32_t ***const	table,
		uint32_t *	len
	)		const

virtual

Returns random access table.

Parameters

table	Pointer to table
len	Length of table

Reimplemented from evio::evioChannel.

◆ getRandomBuffer()

const uint32_t * evioFileChannel::getRandomBuffer ( ) const

virtual

Returns pointer to random buffer.

Returns: Pointer to random buffer

Reimplemented from evio::evioChannel.

◆ ioctl()

int evioFileChannel::ioctl	(	const string &	request,
		void *	argp
	)

virtual

For getting and setting evIoctl parameters.

Parameters

request	String containing evIoctl parameters
argp	Additional evIoctl parameter

Implements evio::evioChannel.

◆ open()

void evioFileChannel::open ( )

virtual

Opens channel for reading or writing.

For read, user-supplied dictionary overrides one found in file.

Implements evio::evioChannel.

References evio::evioChannel::dictionary, and evio::evioDictionary::getDictionaryXML().

◆ read() [1/2]

bool evioFileChannel::read ( )

virtual

Reads from file into internal buffer.

Returns: true if successful, false on EOF or other evRead error condition

Implements evio::evioChannel.

◆ read() [2/2]

bool evioFileChannel::read	(	uint32_t *	myBuf,
		int	length
	)

virtual

Reads from file into user-supplied buffer.

Parameters

myBuf User-supplied buffer. @parem length Length of buffer in 4-byte words.

Returns: true if successful, false on EOF or other evRead error condition

Implements evio::evioChannel.

◆ readAlloc()

bool evioFileChannel::readAlloc	(	uint32_t **	buffer,
		uint32_t *	bufLen
	)

virtual

Reads from file and allocates buffer as needed.

Parameters

buffer	Pointer to pointer to allocated buffer.
len	Length of allocated buffer in 4-byte words.

Returns: true if successful, false on EOF, throws exception for other error.

Note: user MUST free the allocated buffer!

Implements evio::evioChannel.

◆ readNoCopy()

bool evioFileChannel::readNoCopy ( )

virtual

Reads from file using no copy mechanism.

Returns: true if successful, false on EOF, throws exception for other error.

Implements evio::evioChannel.

◆ readRandom()

bool evioFileChannel::readRandom ( uint32_t bufferNumber )

virtual

Reads buffer from file given buffer number.

Parameters

bufferNumber Buffer to return

Returns: true if successful, false on EOF, throws exception for other error.

Reimplemented from evio::evioChannel.

◆ write() [1/6]

void evioFileChannel::write ( )

virtual

Writes to file from internal buffer.

Implements evio::evioChannel.

Referenced by write().

◆ write() [2/6]

void evioFileChannel::write ( const evioChannel & channel )

virtual

Writes to file from internal buffer of another evioChannel object.

Parameters

channel Channel object

Implements evio::evioChannel.

References evio::evioChannel::getBuffer().

◆ write() [3/6]

void evioFileChannel::write ( const evioChannel * channel )

virtual

Writes from internal buffer of another evioChannel object.

Parameters

channel Pointer to channel object

Implements evio::evioChannel.

References write().

◆ write() [4/6]

void evioFileChannel::write ( const evioChannelBufferizable & o )

virtual

Writes from contents of evioChannelBufferizable object.

Parameters

o	evioChannelBufferizable object that can serialze to buffer

Implements evio::evioChannel.

References evio::evioChannelBufferizable::toEVIOBuffer(), and write().

◆ write() [5/6]

void evioFileChannel::write ( const evioChannelBufferizable * o )

virtual

Writes from contents of evioChannelBufferizable object.

Parameters

o	Pointer to evioChannelBufferizable object that can serialize to buffer

Implements evio::evioChannel.

References write().

◆ write() [6/6]

void evioFileChannel::write ( const uint32_t * myBuf )

virtual

Writes to file from user-supplied buffer.

Parameters

myBuf Buffer containing event

Implements evio::evioChannel.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ evioFileChannel() [1/3]

◆ evioFileChannel() [2/3]

◆ evioFileChannel() [3/3]

◆ ~evioFileChannel()

Member Function Documentation

◆ close()

◆ getBuffer()

◆ getBufSize()

◆ getFileName()

◆ getFileXMLDictionary()

◆ getMode()

◆ getNoCopyBuffer()

◆ getRandomAccessTable()

◆ getRandomBuffer()

◆ ioctl()

◆ open()

◆ read() [1/2]

◆ read() [2/2]

◆ readAlloc()

◆ readNoCopy()

◆ readRandom()

◆ write() [1/6]

◆ write() [2/6]

◆ write() [3/6]

◆ write() [4/6]

◆ write() [5/6]

◆ write() [6/6]