#include <BcfArchiveFolder.h>
Inheritance diagram for OdBcf::OdBcfArchiveFolder:
Public Member Functions | |
| ODRX_DECLARE_MEMBERS (OdBcfArchiveFolder) | |
| OdBcfArchiveFolder () | |
| ~OdBcfArchiveFolder () | |
| const OdString & | getFolder () const |
| bool | isFolderUnset () const |
 Public Member Functions inherited from OdRxObject | |
| ODRX_HEAP_OPERATORS () | |
| OdRxObject () | |
| virtual | ~OdRxObject () |
| virtual OdRxObject * | queryX (const OdRxClass *pClass) const |
| virtual OdRxObject * | x (const OdRxClass *pClass) const |
| virtual OdRxClass * | isA () 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 OdSmartPtr< OdBcfArchiveFolder > | createObject (const OdString &folder) |
| Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
Protected Attributes | |
| OdString | m_folder |
Detailed Description
A class that provides functionality for working with an archive folder.
Definition at line 40 of file BcfArchiveFolder.h.
Constructor & Destructor Documentation
◆ OdBcfArchiveFolder()
| OdBcf::OdBcfArchiveFolder::OdBcfArchiveFolder | ( | ) |
Creates a new archive folder object with an unset path.
◆ ~OdBcfArchiveFolder()
| OdBcf::OdBcfArchiveFolder::~OdBcfArchiveFolder | ( | ) |
Destroys the archive folder object.
Member Function Documentation
◆ createObject()
|
static |
Creates a new archive folder object.
- Parameters
-
folder [in] A string containing the path to archive working folder.
- Returns
- A smart pointer to the created <link OdBcf::OdBcfArchiveFolder, OdBcfArchiveFolder> instance.
◆ getFolder()
| const OdString & OdBcf::OdBcfArchiveFolder::getFolder | ( | ) | const |
Retrieves the path to the archive folder. The archive folder is a temporary folder on a drive where the BCF archive was unpacked.
- Returns
- A string that contains the path.
- Remarks
- The folder path returned by the method can't be modified in the calling subroutine.
◆ isFolderUnset()
| bool OdBcf::OdBcfArchiveFolder::isFolderUnset | ( | ) | const |
Defines whether the path to the archive folder is not initialized.
- Returns
- true if the path to the archive folder is not initialized; otherwise, the method returns false.
◆ ODRX_DECLARE_MEMBERS()
| OdBcf::OdBcfArchiveFolder::ODRX_DECLARE_MEMBERS | ( | OdBcfArchiveFolder | ) |
Member Data Documentation
◆ m_folder
|
protected |
Definition at line 82 of file BcfArchiveFolder.h.
The documentation for this class was generated from the following file: