CFx SDK Documentation  2022 SP0
Public Member Functions | Static Public Member Functions | List of all members
OD::RxFS Class Referenceabstract

#include <RxFS.h>

Inheritance diagram for OD::RxFS:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (RxFS)
 
virtual void attach (const OdString &pathToData)=0
 
StreamP open (const OdString &path, int access=File::Read, File::Share sh=File::DenyReadWrite, File::Creation dispos=File::OpenExisting)
 
virtual File::Id fileId (const File::Hash &hsh)=0
 
virtual File::Id fileId (const OdString &path)=0
 
bool exists (const OdString &path, File::Hash &outHash)
 
virtual bool fileHash (File::Id fid, File::Hash &outHash)=0
 
virtual void mount (File::Id fid, const OdString &path)=0
 
void unmount (File::Id fid)
 
virtual File::ReadBufP openR (File::Id file)=0
 
File::ReadBufP openR (const OdString &path)
 
File::ReadBufP openR (const File::Hash &hsh)
 
virtual File::WriteBufP openW (const OdString &path=OdString::kEmpty, OdInt64 fixedLength=-1)=0
 
virtual File::Id put (Stream *data, File::Hash *out, const OdString &mountPath=OdString::kEmpty)=0
 
void put (const OdString &path, const char *msg, OdUInt64 len=-1, File::Creation dispos=File::CreateAlways)
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Static Public Member Functions

static RxFSP create (const OdString &pathToData=OdString::kEmpty)
 
static RxFSP byMountPath (const OdString &storageMountPath)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

Definition at line 104 of file RxFS.h.

Member Function Documentation

◆ attach()

virtual void OD::RxFS::attach ( const OdString pathToData)
pure virtual

◆ byMountPath()

static RxFSP OD::RxFS::byMountPath ( const OdString storageMountPath)
inlinestatic

Definition at line 144 of file RxFS.h.

◆ create()

OD::RxFSP OD::RxFS::create ( const OdString pathToData = OdString::kEmpty)
inlinestatic

Definition at line 255 of file RxFS.h.

◆ exists()

bool OD::RxFS::exists ( const OdString path,
File::Hash outHash 
)
inline

Definition at line 274 of file RxFS.h.

◆ fileHash()

virtual bool OD::RxFS::fileHash ( File::Id  fid,
File::Hash outHash 
)
pure virtual

◆ fileId() [1/2]

virtual File::Id OD::RxFS::fileId ( const File::Hash hsh)
pure virtual

◆ fileId() [2/2]

virtual File::Id OD::RxFS::fileId ( const OdString path)
pure virtual

◆ mount()

virtual void OD::RxFS::mount ( File::Id  fid,
const OdString path 
)
pure virtual

◆ ODRX_DECLARE_MEMBERS()

OD::RxFS::ODRX_DECLARE_MEMBERS ( RxFS  )

◆ open()

StreamP OD::RxFS::open ( const OdString path,
int  access = File::Read,
File::Share  sh = File::DenyReadWrite,
File::Creation  dispos = File::OpenExisting 
)
inline

Definition at line 264 of file RxFS.h.

◆ openR() [1/3]

File::ReadBufP OD::RxFS::openR ( const File::Hash hsh)
inline

Definition at line 133 of file RxFS.h.

◆ openR() [2/3]

File::ReadBufP OD::RxFS::openR ( const OdString path)
inline

Definition at line 126 of file RxFS.h.

◆ openR() [3/3]

virtual File::ReadBufP OD::RxFS::openR ( File::Id  file)
pure virtual

◆ openW()

virtual File::WriteBufP OD::RxFS::openW ( const OdString path = OdString::kEmpty,
OdInt64  fixedLength = -1 
)
pure virtual

◆ put() [1/2]

void OD::RxFS::put ( const OdString path,
const char *  msg,
OdUInt64  len = -1,
File::Creation  dispos = File::CreateAlways 
)
inline

Definition at line 271 of file RxFS.h.

◆ put() [2/2]

virtual File::Id OD::RxFS::put ( Stream data,
File::Hash out,
const OdString mountPath = OdString::kEmpty 
)
pure virtual

◆ unmount()

void OD::RxFS::unmount ( File::Id  fid)
inline

Definition at line 122 of file RxFS.h.


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