Cpl::Io::File::InputOutputApi Class Reference

This abstract class defines the interface for a Random Access Input Output File. More...

Detailed Description

This abstract class defines the interface for a Random Access Input Output File.

NOTE: All the read/write operations return 'false' if an error occurred, this INCLUDES the end-of-file condition (which is error when dealing with streams). To differentiate between a true error and EOF, the client must call isEof().

#include <InputOutputApi.h>

Inheritance diagram for Cpl::Io::File::InputOutputApi:

Collaboration diagram for Cpl::Io::File::InputOutputApi:

Public Member Functions
virtual Cpl::Io::InputOutput &	getStream ()=0
	Returns a 'stream proxy' for the File instance that is of type: Cpl::Io::InputOutput.
Public Member Functions inherited from Cpl::Io::Input
virtual bool	read (char &c)
	Reads a single byte from the stream.
virtual bool	read (Cpl::Text::String &destString)
	Reads N bytes into the String's internal buffer.
virtual bool	read (void *buffer, int numBytes, int &bytesRead)=0
	Attempts to read the specified number of bytes from the stream in the supplied buffer.
virtual bool	available ()=0
	Returns true if there data available to be read from the stream.
virtual	~Input ()
	Lets the make the destructor virtual.
Public Member Functions inherited from Cpl::Io::Close
virtual void	close ()=0
	This method will close the stream.
virtual	~Close ()
	Lets the make the destructor virtual.
Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.
bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.
Public Member Functions inherited from Cpl::Io::IsEos
virtual bool	isEos ()=0
	This method returns true if End-of-Stream was encountered on the stream.
virtual	~IsEos ()
	Lets the make the destructor virtual.
Public Member Functions inherited from Cpl::Io::File::ObjectApi
virtual bool	isEof ()=0
	After a read/write operation this method returns true if the file pointer is at EOF.
virtual bool	length (unsigned long &length)=0
	Returns the length, in bytes, of the file.
virtual bool	currentPos (unsigned long &currentPos)=0
	Returns the current file pointer offset, in bytes, from the top of the file.
virtual bool	setRelativePos (long deltaOffset)=0
	Adjusts the current pointer offset by the specified delta (in bytes).
virtual bool	setAbsolutePos (unsigned long newoffset)=0
	Sets the file pointer to the absolute specified offset (in bytes).
virtual bool	setToEof ()=0
	Sets the file pointer to End-Of-File.
virtual	~ObjectApi ()
	Virtual destructor.
Public Member Functions inherited from Cpl::Io::Output
virtual bool	write (char c)
	Writes a single byte to the stream.
virtual bool	write (const char *string)
	Writes a string to the stream.
virtual bool	write (const Cpl::Text::String &string)
	Writes a string to the stream.
virtual bool	write (Cpl::Text::String &formatBuffer, const char *format,...)
	Formatted write to the stream.
virtual bool	vwrite (Cpl::Text::String &formatBuffer, const char *format, va_list ap)
	Same as write( String& formatBuffer, const char* format,...), except that it is called with a va_list instead of a variable number of arguments.
virtual bool	write (const void *buffer, int numBytes)
	Writes the content of the buffer to the stream.
virtual bool	write (const void *buffer, int maxBytes, int &bytesWritten)=0
	Writes the content of the buffer to the stream.
virtual void	flush ()=0
	Forces all buffered data (if any) to be written to the stream media.
virtual	~Output ()
	Lets the make the destructor virtual.

Additional Inherited Members
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.
Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.
Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.
	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Member Function Documentation

getStream()

virtual Cpl::Io::InputOutput & Cpl::Io::File::InputOutputApi::getStream ( )

pure virtual

Returns a 'stream proxy' for the File instance that is of type: Cpl::Io::InputOutput.

This method is needed because an Cpl::Io::File::InputOutputApi does NOT inherit from Cpl::Io::InputOutput.

Implemented in Cpl::Io::File::InputOutput.

---

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

• Cpl/Io/File/InputOutputApi.h