Instrument Neutral Distributed Interface INDI 2.2.5
Classes | Enumerations | Functions
geminipbh::indi_driver Namespace Reference

Classes

class  CallbackStaging
 
struct  PendingOperation
 

Enumerations

enum class  DriverPropertyState { Idle , Ok , Busy , Alert }
 
enum class  PendingOperationKind { DcOutput , UsbOutput , HeaterEnabled , HeaterMode }
 
enum class  PendingEvaluation {
  Confirmed , Pending , Timeout , NotConfirmable ,
  InvalidTarget , ValueUnavailable
}
 

Functions

const char * errorName (Error error)
 
DriverPropertyState propertyStateForImmediateResult (Result result)
 
const char * pendingOperationName (PendingOperationKind kind)
 
bool sameLogicalOperation (const PendingOperation &operation, PendingOperationKind kind, std::size_t index)
 
void replacePendingOperation (std::vector< PendingOperation > &operations, PendingOperation replacement)
 
ValueResult< OperationTarget > makeBooleanTarget (PendingOperationKind kind, std::size_t index, bool enabled)
 
ValueResult< OperationTarget > makeHeaterModeTarget (std::size_t index, HeaterMode mode)
 
PendingEvaluation evaluatePendingOperation (const PendingOperation &operation, const TelemetrySnapshot *snapshot, std::chrono::steady_clock::time_point now)
 
const char * heaterModeName (HeaterMode mode)
 
bool heaterModeFromSwitchName (const char *name, HeaterMode &mode)
 
std::size_t heaterModeSwitchIndex (HeaterMode mode)
 
bool manualPowerIsTelemetryConfirmable ()
 
bool instrumentationDuplicatesSemanticDriverLog (const instrumentation::Event &event)
 

Enumeration Type Documentation

◆ DriverPropertyState

Enumerator
Idle 
Ok 
Busy 
Alert 

Definition at line 42 of file driver_support.h.

◆ PendingEvaluation

Enumerator
Confirmed 
Pending 
Timeout 
NotConfirmable 
InvalidTarget 
ValueUnavailable 

Definition at line 58 of file driver_support.h.

◆ PendingOperationKind

Enumerator
DcOutput 
UsbOutput 
HeaterEnabled 
HeaterMode 

Definition at line 50 of file driver_support.h.

Function Documentation

◆ errorName()

const char * geminipbh::indi_driver::errorName ( Error  error)
inline

Definition at line 84 of file driver_support.h.

◆ evaluatePendingOperation()

PendingEvaluation geminipbh::indi_driver::evaluatePendingOperation ( const PendingOperation &  operation,
const TelemetrySnapshot *  snapshot,
std::chrono::steady_clock::time_point  now 
)
inline

Definition at line 171 of file driver_support.h.

◆ heaterModeFromSwitchName()

bool geminipbh::indi_driver::heaterModeFromSwitchName ( const char *  name,
HeaterMode &  mode 
)
inline

Definition at line 211 of file driver_support.h.

◆ heaterModeName()

const char * geminipbh::indi_driver::heaterModeName ( HeaterMode  mode)
inline

Definition at line 197 of file driver_support.h.

◆ heaterModeSwitchIndex()

std::size_t geminipbh::indi_driver::heaterModeSwitchIndex ( HeaterMode  mode)
inline

Definition at line 231 of file driver_support.h.

◆ instrumentationDuplicatesSemanticDriverLog()

bool geminipbh::indi_driver::instrumentationDuplicatesSemanticDriverLog ( const instrumentation::Event &  event)
inline

Definition at line 250 of file driver_support.h.

◆ makeBooleanTarget()

ValueResult< OperationTarget > geminipbh::indi_driver::makeBooleanTarget ( PendingOperationKind  kind,
std::size_t  index,
bool  enabled 
)
inline

Definition at line 150 of file driver_support.h.

◆ makeHeaterModeTarget()

ValueResult< OperationTarget > geminipbh::indi_driver::makeHeaterModeTarget ( std::size_t  index,
HeaterMode  mode 
)
inline

Definition at line 166 of file driver_support.h.

◆ manualPowerIsTelemetryConfirmable()

bool geminipbh::indi_driver::manualPowerIsTelemetryConfirmable ( )
inline

Definition at line 245 of file driver_support.h.

◆ pendingOperationName()

const char * geminipbh::indi_driver::pendingOperationName ( PendingOperationKind  kind)
inline

Definition at line 119 of file driver_support.h.

◆ propertyStateForImmediateResult()

DriverPropertyState geminipbh::indi_driver::propertyStateForImmediateResult ( Result  result)
inline

Definition at line 114 of file driver_support.h.

◆ replacePendingOperation()

void geminipbh::indi_driver::replacePendingOperation ( std::vector< PendingOperation > &  operations,
PendingOperation  replacement 
)
inline

Definition at line 140 of file driver_support.h.

◆ sameLogicalOperation()

bool geminipbh::indi_driver::sameLogicalOperation ( const PendingOperation &  operation,
PendingOperationKind  kind,
std::size_t  index 
)
inline

Definition at line 135 of file driver_support.h.