isys::CAnalyzerStatus Class Reference

#include <CDocumentController.h>

Public Member Functions
DWORD	getReturnCode ()
	Returns detailed return code, but above methods should be sufficient and are more readable.
bool	isBufferOverrun () const
	Returns true, if session was terminated automatically when buffer was full.
bool	isDocumentEmpty () const
	Returns true, if analyzer document is empty (nothing was recorded).
bool	isError () const
	Returns true if any of the above errors occurs.
bool	isErrorInBuffer () const
	Returns true, if some recordings are incomplete due to OCT bottleneck.
bool	isLoading () const
	Returns true, if analyzer is loading data to PC.
bool	isRecordingError () const
	Returns true, if there was error in recording.
bool	isWaiting () const
	Returns true, if analyzer is waiting for the trigger to occur.
std::string	toString ()
	Returns object data as YAML string.

Detailed Description

Deprecated

Call getAnalyzerStatus() or getDocumentStatus() to obtain CAnalyzerSessionStatus() or CDocumentSattus() instead.

This class contains analyzer status. It should not be instantiated by clients. Call CAnalyzerDocController::getStatus() to get instance of this class.

Member Function Documentation

getReturnCode()

DWORD isys::CAnalyzerStatus::getReturnCode ( )

inline

Returns detailed return code, but above methods should be sufficient and are more readable.

Since

9.12.288

isBufferOverrun()

bool isys::CAnalyzerStatus::isBufferOverrun ( ) const

inline

Returns true, if session was terminated automatically when buffer was full.

Since

9.12.288

isDocumentEmpty()

bool isys::CAnalyzerStatus::isDocumentEmpty ( ) const

inline

Returns true, if analyzer document is empty (nothing was recorded).

Since

9.12.288

isError()

bool isys::CAnalyzerStatus::isError ( ) const

inline

Returns true if any of the above errors occurs.

Since

9.12.288

isErrorInBuffer()

bool isys::CAnalyzerStatus::isErrorInBuffer ( ) const

inline

Returns true, if some recordings are incomplete due to OCT bottleneck.

Since

9.12.288

isLoading()

bool isys::CAnalyzerStatus::isLoading ( ) const

inline

Returns true, if analyzer is loading data to PC.

Since

9.12.288

isRecordingError()

bool isys::CAnalyzerStatus::isRecordingError ( ) const

inline

Returns true, if there was error in recording.

Since

9.12.288

isWaiting()

bool isys::CAnalyzerStatus::isWaiting ( ) const

inline

Returns true, if analyzer is waiting for the trigger to occur.

Since

9.12.288

toString()

std::string isys::CAnalyzerStatus::toString ( )

inline

Returns object data as YAML string.

Since

9.12.288