Cpl::Io::File::Null Class Reference

This concrete class implements a NULL InputOutputApi File that all of its input operations return 'End-of-File' (i.e. More...

Detailed Description

This concrete class implements a NULL InputOutputApi File that all of its input operations return 'End-of-File' (i.e.

return false) and all output is dropped in the proverbial bit-bucket and goes no where! Note: The write() methods always return true (i.e. no error).

#include <Null.h>

Inheritance diagram for Cpl::Io::File::Null:

Collaboration diagram for Cpl::Io::File::Null:

Public Member Functions
	Null ()
	Constructor.
	~Null ()
	Destructor.
bool	read (void *buffer, int numBytes, int &bytesRead)
	See Cpl::Io::Input.
bool	available ()
	See Cpl::Io::Input.
bool	write (const void *buffer, int maxBytes, int &bytesWritten)
	See Cpl::Io::Output.
void	flush ()
	See Cpl::Io::Output.
bool	isEos ()
	See Cpl::Io::IsEos (is equivalent to isEof())
void	close ()
	See Cpl::Io::Close. Note: Once closed() has been called, all of the write() and ObjecApi methods will return false.
bool	isEof ()
	See Cpl::Io::File::ObjectApi.
bool	length (unsigned long &len)
	See Cpl::Io::File::ObjectApi.
bool	currentPos (unsigned long &curPos)
	See Cpl::Io::File::ObjectApi.
bool	setRelativePos (long deltaOffset)
	See Cpl::Io::File::ObjectApi.
bool	setAbsolutePos (unsigned long newoffset)
	See Cpl::Io::File::ObjectApi.
bool	setToEof ()
	See Cpl::Io::File::ObjectApi.
Public Member Functions inherited from Cpl::Io::File::InputOutputApi
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	~Input ()
	Lets the make the destructor virtual.
Public Member Functions inherited from Cpl::Io::Close
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	~IsEos ()
	Lets the make the destructor virtual.
Public Member Functions inherited from Cpl::Io::File::ObjectApi
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	~Output ()
	Lets the make the destructor virtual.

Protected Attributes
bool	m_opened
	Track my opened/closed state.

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.

Constructor & Destructor Documentation

Null()

Cpl::Io::File::Null::Null

(

)

Constructor.

~Null()

Cpl::Io::File::Null::~Null

(

)

Destructor.

Member Function Documentation

available()

bool Cpl::Io::File::Null::available ( )

virtual

See Cpl::Io::Input.

Implements Cpl::Io::Input.

close()

void Cpl::Io::File::Null::close ( )

virtual

See Cpl::Io::Close. Note: Once closed() has been called, all of the write() and ObjecApi methods will return false.

Implements Cpl::Io::Close.

currentPos()

bool Cpl::Io::File::Null::currentPos ( unsigned long & curPos )

virtual

See Cpl::Io::File::ObjectApi.

Implements Cpl::Io::File::ObjectApi.

flush()

void Cpl::Io::File::Null::flush ( )

virtual

See Cpl::Io::Output.

Implements Cpl::Io::Output.

isEof()

bool Cpl::Io::File::Null::isEof ( )

virtual

See Cpl::Io::File::ObjectApi.

Implements Cpl::Io::File::ObjectApi.

isEos()

bool Cpl::Io::File::Null::isEos ( )

virtual

See Cpl::Io::IsEos (is equivalent to isEof())

Implements Cpl::Io::IsEos.

length()

bool Cpl::Io::File::Null::length ( unsigned long & len )

virtual

See Cpl::Io::File::ObjectApi.

Implements Cpl::Io::File::ObjectApi.

read()

bool Cpl::Io::File::Null::read ( void * buffer, int numBytes, int & bytesRead )

virtual

See Cpl::Io::Input.

Implements Cpl::Io::Input.

setAbsolutePos()

bool Cpl::Io::File::Null::setAbsolutePos ( unsigned long newoffset )

virtual

See Cpl::Io::File::ObjectApi.

Implements Cpl::Io::File::ObjectApi.

setRelativePos()

bool Cpl::Io::File::Null::setRelativePos ( long deltaOffset )

virtual

See Cpl::Io::File::ObjectApi.

Implements Cpl::Io::File::ObjectApi.

setToEof()

bool Cpl::Io::File::Null::setToEof ( )

virtual

See Cpl::Io::File::ObjectApi.

Implements Cpl::Io::File::ObjectApi.

write()

bool Cpl::Io::File::Null::write ( const void * buffer, int maxBytes, int & bytesWritten )

virtual

See Cpl::Io::Output.

Implements Cpl::Io::Output.

Member Data Documentation

m_opened

bool Cpl::Io::File::Null::m_opened

protected

Track my opened/closed state.

---

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

• Cpl/Io/File/Null.h