This class contains document status.
More...
#include <CDocumentController.h>
|
| | CDocumentStatus (DWORD hResult) |
| | This object should not be instantiated by clients - call method getDocumentStatus() to get the current analyzer status.
|
| bool | isCanStart () const |
| | Returns true, if document action start is available.
|
| bool | isDirty () const |
| | Returns true, if analyzer document is dirty (changed but not saved).
|
| bool | isEmpty () const |
| | Returns true, if analyzer document is empty (nothing was recorded).
|
| bool | isSerializing () const |
| | Returns true, if analyzer document is in file opening or saving phase.
|
| std::string | toString () |
| | Returns object data as string.
|
This class contains document status.
It should not be instantiated by clients. Call CAnalyzerDocController::getDocumentStatus() to get instance of this class.
◆ CDocumentStatus()
| isys::CDocumentStatus::CDocumentStatus |
( |
DWORD | hResult | ) |
|
|
inline |
This object should not be instantiated by clients - call method getDocumentStatus() to get the current analyzer status.
- Since
- 9.12.288
◆ isCanStart()
| bool isys::CDocumentStatus::isCanStart |
( |
| ) |
const |
|
inline |
Returns true, if document action start is available.
- Since
- 9.12.288
◆ isDirty()
| bool isys::CDocumentStatus::isDirty |
( |
| ) |
const |
|
inline |
Returns true, if analyzer document is dirty (changed but not saved).
- Since
- 9.12.288
◆ isEmpty()
| bool isys::CDocumentStatus::isEmpty |
( |
| ) |
const |
|
inline |
Returns true, if analyzer document is empty (nothing was recorded).
- Since
- 9.12.288
◆ isSerializing()
| bool isys::CDocumentStatus::isSerializing |
( |
| ) |
const |
|
inline |
Returns true, if analyzer document is in file opening or saving phase.
For large .trd files the process of reading/writing the file can take some time.
- Since
- 9.12.288
◆ toString()
| std::string isys::CDocumentStatus::toString |
( |
| ) |
|
|
inline |
Returns object data as string.
This should be used for logging or debugging purposes only as format may change in future versions.
- Since
- 9.12.288