Cpl::Io::File::ObjectApi Class Reference

This abstract class defines the basic additional functionality, beyond that of a stream, for a file. More...

Detailed Description

This abstract class defines the basic additional functionality, beyond that of a stream, for a file.

#include <ObjectApi.h>

Inheritance diagram for Cpl::Io::File::ObjectApi:

Public Member Functions
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.

Constructor & Destructor Documentation

~ObjectApi()

virtual Cpl::Io::File::ObjectApi::~ObjectApi ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

currentPos()

virtual bool Cpl::Io::File::ObjectApi::currentPos ( unsigned long &  currentPos )

pure virtual

Returns the current file pointer offset, in bytes, from the top of the file.

If there is an error than false is returned.

Implemented in Cpl::Io::File::Input, Cpl::Io::File::Null, Cpl::Io::File::InputOutput, and Cpl::Io::File::Output.

isEof()

virtual bool Cpl::Io::File::ObjectApi::isEof ( )

pure virtual

After a read/write operation this method returns true if the file pointer is at EOF.

NOTES:

• This method is ONLY VALID immediately following a read/write operation!
• If the File object has been closed, this method will return true.

Implemented in Cpl::Io::File::Input, Cpl::Io::File::InputOutput, Cpl::Io::File::Null, and Cpl::Io::File::Output.

length()

virtual bool Cpl::Io::File::ObjectApi::length ( unsigned long &  length )

pure virtual

Returns the length, in bytes, of the file.

If there is an error than false is returned.

Implemented in Cpl::Io::File::Input, Cpl::Io::File::InputOutput, Cpl::Io::File::Null, and Cpl::Io::File::Output.

setAbsolutePos()

virtual bool Cpl::Io::File::ObjectApi::setAbsolutePos ( unsigned long  newoffset )

pure virtual

Sets the file pointer to the absolute specified offset (in bytes).

Returns true if successful, else false (i.e. setting the pointer past the end of the file).

Implemented in Cpl::Io::File::Input, Cpl::Io::File::InputOutput, Cpl::Io::File::Null, and Cpl::Io::File::Output.

setRelativePos()

virtual bool Cpl::Io::File::ObjectApi::setRelativePos ( long  deltaOffset )

pure virtual

Adjusts the current pointer offset by the specified delta (in bytes).

Returns true if successful, else false (i.e. setting the pointer past/before the file boundaries).

Implemented in Cpl::Io::File::Input, Cpl::Io::File::InputOutput, Cpl::Io::File::Null, and Cpl::Io::File::Output.

setToEof()

virtual bool Cpl::Io::File::ObjectApi::setToEof ( )

pure virtual

Sets the file pointer to End-Of-File.

Returns true if successful, else false if an error occurred.

Implemented in Cpl::Io::File::Input, Cpl::Io::File::InputOutput, Cpl::Io::File::Null, and Cpl::Io::File::Output.

---

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

• Cpl/Io/File/ObjectApi.h