Base Class for status reporting interface. More...

#include <StatusReporter.h>

Inheritance diagram for tcStatusReporter:

Collaboration diagram for tcStatusReporter:

Public Types
enum	teStatus { eeCapturingStart, eeCapturingEnd, eeGood, eeWarning, eeError, eeClear, eeInfo }

Public Member Functions
	tcStatusReporter ()

virtual	~tcStatusReporter ()

virtual void	updateStatus (teStatus aeStatus, const char *apMessage)=0

virtual void	disableIndicators (bool abDisable)

Static Public Member Functions
static void	UpdateStatus (teStatus aeStatus, const char *apMessage)

static void	DisableIndicators (bool abDisable)

Protected Member Functions
const char *	statusToString (teStatus aeStatus)

Static Protected Attributes
static std::list< tcStatusReporter * >	mcReporters

Detailed Description

Base Class for status reporting interface.

The tcStatusReporter class provides a set of static utility methods and common API for status reporting / indicators for the MityCAM libaray. Designers can implement derived classes that implement the updateStatus() methods to present status information as required for their application.

Member Enumeration Documentation

◆ teStatus

enum tcStatusReporter::teStatus

These are the statuses that should be supported

Enumerator
eeCapturingStart
eeCapturingEnd
eeGood
eeWarning
eeError
eeClear
eeInfo

Constructor & Destructor Documentation

◆ tcStatusReporter()

tcStatusReporter::tcStatusReporter ( )

inline

◆ ~tcStatusReporter()

virtual tcStatusReporter::~tcStatusReporter ( )

inlinevirtual

Member Function Documentation

◆ disableIndicators()

virtual void tcStatusReporter::disableIndicators ( bool abDisable )

inlinevirtual

This may be used to disable indicators that can generate light (like an LED).

Parameters

abDisable when true, disable any Visible indicators regardless of status

Reimplemented in tcPCA9553Status.

◆ DisableIndicators()

void tcStatusReporter::DisableIndicators ( bool abDisable )

static

◆ statusToString()

const char * tcStatusReporter::statusToString ( teStatus aeStatus )

protected

◆ UpdateStatus()

void tcStatusReporter::UpdateStatus	(	teStatus	aeStatus,
		const char *	apMessage
	)

static

◆ updateStatus()

virtual void tcStatusReporter::updateStatus	(	teStatus	aeStatus,
		const char *	apMessage
	)

pure virtual

Signifies that the StatusReporter object should update.

Parameters

aeStatus - the status to report.

Implemented in SocCamera::tcMityViewerInterface, tcGenICamStatusReporter, and tcStdOutStatusReporter.

Member Data Documentation

◆ mcReporters

std::list< tcStatusReporter * > tcStatusReporter::mcReporters

staticprotected

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

/tmp/mitycam_sdk/ARM/camera_software/src/StatusReporter/StatusReporter.h
/tmp/mitycam_sdk/ARM/camera_software/src/StatusReporter/StatusReporter.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes