|
| LocalInFileT (const std::string &BaseName_, const std::string &FullName_) |
| Constructor. More...
|
|
bool | IsOpen () const |
| Returns whether the file has successfully been opened and is still open. More...
|
|
const std::string & | GetBaseName () const |
| Returns the base name of this file. The base name is relative to and agnostic of the file system this file is in. More...
|
|
const std::string & | GetFullName () const |
| Returns the full name of this file. More...
|
|
uint64_t | GetPos () const |
| Returns the current read/write position in the file. More...
|
|
bool | Seek (int32_t Offset, SeekFromT SeekFrom) |
| Modifies the position of the read/write pointer in the file. More...
|
|
uint32_t | Read (char *Buffer, uint32_t Size) |
| Reads Size bytes into the Buffer. More...
|
|
uint64_t | GetSize () const |
| Returns the size of the file. More...
|
|
virtual | ~FileI () |
| The virtual destructor, so that derived classes can safely be deleted via a FileI (base class) pointer. More...
|
|
|
enum | SeekFromT { FROM_BEGINNING,
FROM_CURRENT_POS,
FROM_END
} |
| The values of this enumeration define from where the seek operation applies the offset. More...
|
|
LocalInFileT::LocalInFileT |
( |
const std::string & |
BaseName_, |
|
|
const std::string & |
FullName_ |
|
) |
| |
const std::string & LocalInFileT::GetBaseName |
( |
| ) |
const |
|
virtual |
Returns the base name of this file. The base name is relative to and agnostic of the file system this file is in.
Implements cf::FileSys::FileI.
const std::string & LocalInFileT::GetFullName |
( |
| ) |
const |
|
virtual |
Returns the full name of this file.
The full name is the base name prepended by the file system specific path/URL. TODO: Have a GetFileSys() method instead???
Implements cf::FileSys::FileI.
uint64_t LocalInFileT::GetPos |
( |
| ) |
const |
|
virtual |
uint64_t LocalInFileT::GetSize |
( |
| ) |
const |
|
virtual |
bool LocalInFileT::IsOpen |
( |
| ) |
const |
|
virtual |
Returns whether the file has successfully been opened and is still open.
Implements cf::FileSys::FileI.
uint32_t LocalInFileT::Read |
( |
char * |
Buffer, |
|
|
uint32_t |
Size |
|
) |
| |
|
virtual |
Reads Size bytes into the Buffer.
- Returns
- How many bytes have actually been read.
Implements cf::FileSys::InFileI.
bool LocalInFileT::Seek |
( |
int32_t |
Offset, |
|
|
SeekFromT |
SeekFrom |
|
) |
| |
|
virtual |
Modifies the position of the read/write pointer in the file.
- Parameters
-
Offset | How much to move the pointer. |
SeekFrom | Defines from where the offset is applied, see SeekFromT for possible values. |
- Returns
- true if the seek operation was successful, false otherwise.
Implements cf::FileSys::FileI.
The documentation for this class was generated from the following files: