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

#include <RxFS.h>

Inheritance diagram for OD::FilePx:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (FilePx)
 
virtual OdRxObjectPtr open (OdRxObject *obj, const char *path, File::Access accessMode=File::Read, File::Share shareMode=File::DenyNo, File::Creation disposition=File::OpenExisting)=0
 
- 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 OdRxObjectPtr mount (OdRxObject *fs, const OdString &mountPath=OdString::kEmpty)
 
static OdRxObjectPtr unmount (const OdString &mountPath)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

This class is the base class for classes that provide platform-dependent file operations for Teigha.

Library: TD_Root

<group OdRx_Classes>

Definition at line 158 of file RxFS.h.

Member Function Documentation

◆ mount()

static OdRxObjectPtr OD::FilePx::mount ( OdRxObject fs,
const OdString mountPath = OdString::kEmpty 
)
static

◆ ODRX_DECLARE_MEMBERS()

OD::FilePx::ODRX_DECLARE_MEMBERS ( FilePx  )

◆ open()

virtual OdRxObjectPtr OD::FilePx::open ( OdRxObject obj,
const char *  path,
File::Access  accessMode = File::Read,
File::Share  shareMode = File::DenyNo,
File::Creation  disposition = File::OpenExisting 
)
pure virtual

Creates and/or opens the specified file.

Parameters
obj[in] VFS object (file/directory) with this protocol extension.
path[in] path in VFS to resource.
accessMode[in] Access mode.
shareMode[in] Share mode.
creationDisposition[in] Creation disposition.
Remarks
Returns a SmartPointer to an OdStreamBuf object for the file.

accessMode must be a combination of one or more of the following:

Value Description OD::File::Read 0x80000000 Read access. OD::File::Write 0x40000000 Write access. OD::File::Delete 0x10000000 Delete on close. OD::File::IsDir 0x08000000 Is directory.

shareMode must be one of the following:

Value Description OD::File::DenyReadWrite 0x10 deny read/write mode OD::File::DenyWrite 0x20 deny write mode OD::File::DenyRead 0x30 deny read mode OD::File::DenyNo 0x40 deny none mode

Creation disposition must be one of the following:

Value Description OD::Filer::CreateNew 1 Creates a new file; fails if the specified file already exists. OD::Filer::CreateAlways 2 Creates a new file; overwrites any existing file. OD::Filer::OpenExisting 3 Opens the file; fails if the file does not exist. OD::Filer::OpenAlways 4 Opens the file; creates the file if it does not exist. OD::Filer::TruncateExisting 5 Truncates the file; fails if the file does not exist. The file must be open at least Oda::kFileWrite.

◆ unmount()

static OdRxObjectPtr OD::FilePx::unmount ( const OdString mountPath)
static

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