This concrete class provides a platform independent 'standard' implementation of a Cpl::Io::File::Input object. More...

Detailed Description

This concrete class provides a platform independent 'standard' implementation of a Cpl::Io::File::Input object.

NOTE: All the read 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 <Input.h>

Inheritance diagram for Cpl::Io::File::Input:

[legend]

Collaboration diagram for Cpl::Io::File::Input:

[legend]

Public Member Functions
	Input (const char *fileName)
	Constructor -->Opens the file.

	Input (Cpl::Io::Descriptor streamfd)
	Constructor. 'streamfd' is a the file descriptor of a existing/opened file.

	~Input ()
	Destructor -->Will insure the file gets closed.

bool	isOpened ()
	This method returns true if the file was successfully open and/or is still opened (i.e.

bool	read (char &c)
	See Cpl::Io::Input.

bool	read (Cpl::Text::String &destString)
	See Cpl::Io::Input.

bool	read (void *buffer, int numBytes, int &bytesRead)
	See Cpl::Io::Input.

bool	available ()
	See Cpl::Io::Input.

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

void	close ()
	See Cpl::Io::Close.

bool	isEof ()
	See Cpl::Io::File::ObjectApi (is equivalent to isEos())

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::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.

Protected Attributes
Cpl::Io::Stdio::Input_	m_stream
	Provides core read functionality.

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

◆ Input() [1/2]

Cpl::Io::File::Input::Input ( const char * fileName )

Constructor -->Opens the file.

◆ Input() [2/2]

Cpl::Io::File::Input::Input ( Cpl::Io::Descriptor streamfd )

Constructor. 'streamfd' is a the file descriptor of a existing/opened file.

◆ ~Input()

Cpl::Io::File::Input::~Input ( )

virtual

Destructor -->Will insure the file gets closed.

Reimplemented from Cpl::Io::Input.

Member Function Documentation

◆ available()

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

virtual

See Cpl::Io::Input.

Implements Cpl::Io::Input.

◆ close()

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

virtual

See Cpl::Io::Close.

Implements Cpl::Io::Close.

◆ currentPos()

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

virtual

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

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

◆ isEof()

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

virtual

See Cpl::Io::File::ObjectApi (is equivalent to isEos())

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

◆ isEos()

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

virtual

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

Implements Cpl::Io::IsEos.

◆ isOpened()

bool Cpl::Io::File::Input::isOpened ( )

This method returns true if the file was successfully open and/or is still opened (i.e.

close() has not been called). Note: it is okay to call other methods in the class if the file is not open - i.e. nothing 'bad' will happen and the method will return 'failed' status (when appropriate).