soma::FileDataSource Class Reference
#include <soma-io/datasource/filedatasource.h>
Inheritance diagram for soma::FileDataSource:
Collaboration diagram for soma::FileDataSource:
Public Member Functions | |
| FileDataSource (const std::string &filename, offset_t offset=0, int mode=Read) | |
| virtual | ~FileDataSource () |
| virtual std::string | url () const |
| offset_t | initialOffset () const |
| virtual DataSource * | clone () const |
| virtual bool | open (int mode) |
| useless for a file descriptor: a fd is already open More... | |
| virtual bool | allowsMemoryMapping () const |
| in the general case, memory mapping is not possible More... | |
| virtual offset_t | size () const |
| virtual offset_t | at () const |
| virtual bool | at (offset_t pos) |
 Public Member Functions inherited from soma::FDDataSource | |
| FDDataSource (int fd=-1, int mode=Read) | |
| virtual | ~FDDataSource () |
| virtual int | iterateMode () const |
| possible iteration mode(s): bitwise OR of IterateMode values More... | |
| virtual bool | isOpen () const |
| virtual void | close () |
| virtual long | readBlock (char *data, unsigned long maxlen) |
| virtual long | writeBlock (const char *data, unsigned long len) |
| virtual int | getch () |
| virtual int | putch (int ch) |
| virtual bool | ungetch (int ch) |
| int | descriptor () const |
| void | setDescriptor (int fd) |
| bool | isFile () const |
| Public Member Functions inherited from soma::DataSource | |
| DataSource () | |
| virtual | ~DataSource () |
| int | mode () const |
| access mode(s) (read/write): bitwise OR of Mode values More... | |
| virtual bool | eof () const |
| virtual bool | operator! () const |
| virtual | operator bool () const |
| virtual void | flush () |
| virtual bool | atEnd () const |
| bool | reset () |
| Public Member Functions inherited from carto::RCObject | |
| RCObject () | |
| RCObject (const RCObject &) | |
| RCObject & | operator= (const RCObject &) |
| virtual | ~RCObject () |
Additional Inherited Members | |
| Public Types inherited from soma::DataSource | |
| enum | Mode { Read = 1 , Write = 2 , ReadWrite = 3 } |
| enum | IterateMode { DirectAccess = 1 , SequentialAccess = 2 } |
| Public Types inherited from carto::RCObject | |
| typedef int | RefCounterType |
| Static Public Member Functions inherited from soma::DataSource | |
| static const carto::rc_ptr< DataSource > | none () |
| An empty ref-counter that is more convenient than calling a constructor of rc_ptr<DataSource> (useful when calling functions) More... | |
| Protected Attributes inherited from soma::FDDataSource | |
| int | _fd |
| Protected Attributes inherited from soma::DataSource | |
| int | _mode |
Detailed Description
Definition at line 54 of file filedatasource.h.
Constructor & Destructor Documentation
◆ FileDataSource()
| soma::FileDataSource::FileDataSource | ( | const std::string & | filename, |
| offset_t | offset = 0, |
||
| int | mode = Read |
||
| ) |
◆ ~FileDataSource()
|
virtual |
Member Function Documentation
◆ allowsMemoryMapping()
|
virtual |
in the general case, memory mapping is not possible
Reimplemented from soma::FDDataSource.
◆ at() [1/2]
|
virtual |
Reimplemented from soma::FDDataSource.
◆ at() [2/2]
|
virtual |
Reimplemented from soma::FDDataSource.
◆ clone()
|
virtual |
Reimplemented from soma::FDDataSource.
◆ initialOffset()
| offset_t soma::FileDataSource::initialOffset | ( | ) | const |
◆ open()
|
virtual |
useless for a file descriptor: a fd is already open
Reimplemented from soma::FDDataSource.
◆ size()
|
virtual |
Reimplemented from soma::FDDataSource.
◆ url()
|
virtual |
Reimplemented from soma::DataSource.
The documentation for this class was generated from the following file:
- soma-io/datasource/filedatasource.h
