winIDEA SDK
isys::CDocumentStatus Class Reference

Description

This class contains document status.

It should not be instantiated by clients. Call CAnalyzerDocController::getDocumentStatus() to get instance of this class.

#include <CDocumentController.h>

Public Member Functions

 CDocumentStatus (DWORD hResult)
 This object should not be instantiated by clients - call method getDocumentStatus() to get the current analyzer status.
 
bool isSerializing () const
 Returns true, if analyzer document is in file opening or saving phase. More...
 
bool isEmpty () const
 Returns true, if analyzer document is empty (nothing was recorded).
 
bool isDirty () const
 Returns true, if analyzer document is dirty (changed but not saved).
 
bool isCanStart () const
 Returns true, if document action start is available.
 
std::string toString ()
 Returns object data as string. More...
 

Member Function Documentation

◆ 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.

◆ 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.