CameraHealth

Result of running the camera’s built-in health checks.

C++

class CameraHealth

Result of running the camera’s health checks.

Each check has a Status (severity) and a Value (the underlying measurement, when available). The Overall field aggregates the worst severity across all populated checks.

Status values:

OK: Optimal.
Suboptimal: Degraded but functional.
Error: Faulty or out of spec.
Unknown: Check was not performed, or its outcome could not be determined.

Public Functions

CameraHealth(): Default constructor.

explicit CameraHealth(const std::string &fileName): Construct CameraHealth by loading from file.

std::string serialize() const

Serialize to a string.

See also fromSerialized. The returned string is formatted in YAML, and is compatible with the contents of files saved using save.

template<typename ...Args> inline explicit CameraHealth(Args&&... args)

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing CameraHealth then invoking set(args).

The provided arguments must be descendants of CameraHealth. These types can be provided:

template<typename ...Args> inline void set(Args&&... args)

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of CameraHealth. These types can be provided:

template<typename ...Args> inline CameraHealth copyWith(Args&&... args) const

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this CameraHealth object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of CameraHealth. These types can be provided:

inline const Fan &fan() const: Get Fan.

inline Fan &fan(): Get Fan.

inline CameraHealth &set(const Fan &value): Set Fan.

inline CameraHealth &set(const Fan::Status &value): Set Fan::Status.

inline CameraHealth &set(const Fan::Value &value): Set Fan::Value.

inline const InfieldVerification &infieldVerification() const: Get InfieldVerification.

inline InfieldVerification &infieldVerification(): Get InfieldVerification.

inline CameraHealth &set(const InfieldVerification &value): Set InfieldVerification.

inline CameraHealth &set(const InfieldVerification::Status &value): Set InfieldVerification::Status.

inline CameraHealth &set(const InfieldVerification::Value &value): Set InfieldVerification::Value.

inline const MaxTransferSpeed &maxTransferSpeed() const: Get MaxTransferSpeed.

inline MaxTransferSpeed &maxTransferSpeed(): Get MaxTransferSpeed.

inline CameraHealth &set(const MaxTransferSpeed &value): Set MaxTransferSpeed.

inline CameraHealth &set(const MaxTransferSpeed::Status &value): Set MaxTransferSpeed::Status.

inline CameraHealth &set(const MaxTransferSpeed::Value &value): Set MaxTransferSpeed::Value.

inline const Memory &memory() const: Get Memory.

inline Memory &memory(): Get Memory.

inline CameraHealth &set(const Memory &value): Set Memory.

inline CameraHealth &set(const Memory::Status &value): Set Memory::Status.

inline CameraHealth &set(const Memory::Value &value): Set Memory::Value.

inline const Overall &overall() const: Get Overall.

inline Overall &overall(): Get Overall.

inline CameraHealth &set(const Overall &value): Set Overall.

inline const Temperature &temperature() const: Get Temperature.

inline Temperature &temperature(): Get Temperature.

inline CameraHealth &set(const Temperature &value): Set Temperature.

inline CameraHealth &set(const Temperature::DMD &value): Set Temperature::DMD.

inline CameraHealth &set(const Temperature::DMD::Status &value): Set Temperature::DMD::Status.

inline CameraHealth &set(const Temperature::DMD::Value &value): Set Temperature::DMD::Value.

inline CameraHealth &set(const Temperature::LED &value): Set Temperature::LED.

inline CameraHealth &set(const Temperature::LED::Status &value): Set Temperature::LED::Status.

inline CameraHealth &set(const Temperature::LED::Value &value): Set Temperature::LED::Value.

inline CameraHealth &set(const Temperature::Lens &value): Set Temperature::Lens.

inline CameraHealth &set(const Temperature::Lens::Status &value): Set Temperature::Lens::Status.

inline CameraHealth &set(const Temperature::Lens::Value &value): Set Temperature::Lens::Value.

template<typename F> inline void forEach(const F &f) const: Run the given function on each direct member with the value of the member as parameter.

template<typename F> inline void forEach(const F &f): Run the given function on each direct member with the value of the member as parameter.

bool operator==(const CameraHealth &other) const: Equality operator.

bool operator!=(const CameraHealth &other) const: Inequality operator.

std::string toString() const: Get the value as string.

void save(const std::string &fileName) const: Save to the given file.

void load(const std::string &fileName): Load from the given file.

Public Static Functions

static CameraHealth fromSerialized(const std::string &value)

Construct a new CameraHealth instance from a previously serialized string.

See also serialize.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group: The type of this node.

static constexpr const char *path = {""}: The full path for this value.

static constexpr const char *name = {"CameraHealth"}: The name of this value.

static constexpr const char * description {R"description(Result of running the camera's health checks. Each check has a`Status` (severity) and a `Value` (the underlying measurement, whenavailable). The `Overall` field aggregates the worst severity acrossall populated checks.Status values:- OK: Optimal.- Suboptimal: Degraded but functional.- Error: Faulty or out of spec.- Unknown: Check was not performed, or its outcome could not be determined.)description"}: The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const CameraHealth &value): Operator to send the value as string to a stream.

class Fan

The status of the camera’s fan.

OK: Fan operating as expected.
Error: Unexpected fan stop.
Unknown: Fan status could not be determined.

Public Functions

Fan(): Default constructor.

template<typename ...Args> inline explicit Fan(Args&&... args)

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing Fan then invoking set(args).

The provided arguments must be descendants of Fan. These types can be provided:

CameraHealth::Fan::Status
CameraHealth::Fan::Value

template<typename ...Args> inline void set(Args&&... args)

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of Fan. These types can be provided:

CameraHealth::Fan::Status
CameraHealth::Fan::Value

template<typename ...Args> inline Fan copyWith(Args&&... args) const

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this Fan object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of Fan. These types can be provided:

CameraHealth::Fan::Status
CameraHealth::Fan::Value

inline const Status &status() const: Get Status.

inline Status &status(): Get Status.

inline Fan &set(const Status &value): Set Status.

inline const Value &value() const: Get Value.

inline Value &value(): Get Value.

inline Fan &set(const Value &value): Set Value.

template<typename F> inline void forEach(const F &f) const: Run the given function on each direct member with the value of the member as parameter.

template<typename F> inline void forEach(const F &f): Run the given function on each direct member with the value of the member as parameter.

bool operator==(const Fan &other) const: Equality operator.

bool operator!=(const Fan &other) const: Inequality operator.

std::string toString() const: Get the value as string.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group: The type of this node.

static constexpr const char *path = {"Fan"}: The full path for this value.

static constexpr const char *name = {"Fan"}: The name of this value.

static constexpr const char * description = { R"description(The statusof the camera's fan.- OK:Fanoperating as expected.- Error: Unexpectedfanstop.- Unknown:Fan statuscould not be determined.)description" }: The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Fan &value): Operator to send the value as string to a stream.

class Status

Severity of the fan check.

Public Types

enum class ValueType

The type of the underlying value.

Values:

enumerator ok

enumerator suboptimal

enumerator error

enumerator unknown

Public Functions

Status() = default: Default constructor.

inline explicit constexpr Status(ValueType value): Constructor.

ValueType value() const: Get the value.

std::string toString() const: Get the value as string.

inline bool operator==(const Status &other) const: Comparison operator.

inline bool operator!=(const Status &other) const: Comparison operator.

Public Static Functions

static inline std::set<ValueType> validValues(): All valid values of Status.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue: The type of this node.

static constexpr const char *path = {"Fan/Status"}: The full path for this value.

static constexpr const char *name = {"Status"}: The name of this value.

static constexpr const char * description = { R"description(Severity of the fan check.)description" }: The description for this value.

static const Status ok: ok

static const Status suboptimal: suboptimal

static const Status error: error

static const Status unknown: unknown

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Status::ValueType &value): Operator to serialize ValueType to a stream.

inline friend std::ostream &operator<<(std::ostream &stream, const Status &value): Operator to serialize the value to a stream.

class Value

Whether the fan is operating as expected, or stopped unexpectedly.

Public Types

enum class ValueType

The type of the underlying value.

Values:

enumerator ok

enumerator unexpectedFanStop

Public Functions

Value() = default: Default constructor.

inline explicit constexpr Value(ValueType value): Constructor.

ValueType value() const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

bool hasValue() const: Check if the value is set.

void reset(): Reset the node to unset state.

std::string toString() const: Get the value as string.

inline bool operator==(const Value &other) const: Comparison operator.

inline bool operator!=(const Value &other) const: Comparison operator.

Public Static Functions

static inline std::set<ValueType> validValues(): All valid values of Value.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue: The type of this node.

static constexpr const char *path = {"Fan/Value"}: The full path for this value.

static constexpr const char *name = {"Value"}: The name of this value.

static constexpr const char * description {R"description(Whether thefanis operating as expected, or stopped unexpectedly.)description"}: The description for this value.

static const Value ok: ok

static const Value unexpectedFanStop: unexpectedFanStop

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Value::ValueType &value): Operator to serialize ValueType to a stream.

inline friend std::ostream &operator<<(std::ostream &stream, const Value &value): Operator to serialize the value to a stream.

class InfieldVerification

The status of the camera’s most recent infield verification.

OK: Last verification performed within the past year
Suboptimal: Last verification older than one year
Unknown: Camera has never been verified in the field

Public Functions

InfieldVerification(): Default constructor.

template<typename ...Args> inline explicit InfieldVerification(Args&&... args)

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing InfieldVerification then invoking set(args).

The provided arguments must be descendants of InfieldVerification. These types can be provided:

CameraHealth::InfieldVerification::Status
CameraHealth::InfieldVerification::Value

template<typename ...Args> inline void set(Args&&... args)

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of InfieldVerification. These types can be provided:

CameraHealth::InfieldVerification::Status
CameraHealth::InfieldVerification::Value

template<typename ...Args> inline InfieldVerification copyWith(Args&&... args) const

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this InfieldVerification object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of InfieldVerification. These types can be provided:

CameraHealth::InfieldVerification::Status
CameraHealth::InfieldVerification::Value

inline const Status &status() const: Get Status.

inline Status &status(): Get Status.

inline InfieldVerification &set(const Status &value): Set Status.

inline const Value &value() const: Get Value.

inline Value &value(): Get Value.

inline InfieldVerification &set(const Value &value): Set Value.

template<typename F> inline void forEach(const F &f) const: Run the given function on each direct member with the value of the member as parameter.

template<typename F> inline void forEach(const F &f): Run the given function on each direct member with the value of the member as parameter.

bool operator==(const InfieldVerification &other) const: Equality operator.

bool operator!=(const InfieldVerification &other) const: Inequality operator.

std::string toString() const: Get the value as string.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group: The type of this node.

static constexpr const char *path = {"InfieldVerification"}: The full path for this value.

static constexpr const char *name = {"InfieldVerification"}: The name of this value.

static constexpr const char * description {R"description(Thestatusof the camera's most recent infield verification.- OK: Last verification performed within the past year- Suboptimal: Last verification older than one year- Unknown:Camerahas never been verified in the field)description"}: The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const InfieldVerification &value): Operator to send the value as string to a stream.

class Status

Severity of the infield verification check.

Public Types

enum class ValueType

The type of the underlying value.

Values:

enumerator ok

enumerator suboptimal

enumerator error

enumerator unknown

Public Functions

Status() = default: Default constructor.

inline explicit constexpr Status(ValueType value): Constructor.

ValueType value() const: Get the value.

std::string toString() const: Get the value as string.

inline bool operator==(const Status &other) const: Comparison operator.

inline bool operator!=(const Status &other) const: Comparison operator.

Public Static Functions

static inline std::set<ValueType> validValues(): All valid values of Status.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue: The type of this node.

static constexpr const char *path = {"InfieldVerification/Status"}: The full path for this value.

static constexpr const char *name = {"Status"}: The name of this value.

static constexpr const char * description {R"description(Severity of the infield verification check.)description"}: The description for this value.

static const Status ok: ok

static const Status suboptimal: suboptimal

static const Status error: error

static const Status unknown: unknown

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Status::ValueType &value): Operator to serialize ValueType to a stream.

inline friend std::ostream &operator<<(std::ostream &stream, const Status &value): Operator to serialize the value to a stream.

class Value

Time of the most recent infield verification.

Public Types

using ValueType = std::chrono::system_clock::time_point: The type of the underlying value.

Public Functions

Value() = default: Default constructor.

inline explicit constexpr Value(std::chrono::system_clock::time_point value): Constructor.

std::chrono::system_clock::time_point value() const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

bool hasValue() const: Check if the value is set.

void reset(): Reset the node to unset state.

std::string toString() const: Get the value as string.

inline bool operator==(const Value &other) const: Comparison operator.

inline bool operator!=(const Value &other) const: Comparison operator.

inline bool operator<(const Value &other) const: Comparison operator.

inline bool operator>(const Value &other) const: Comparison operator.

inline bool operator<=(const Value &other) const: Comparison operator.

inline bool operator>=(const Value &other) const: Comparison operator.

Public Static Functions

static inline constexpr Range<std::chrono::system_clock::time_point> validRange(): The range of valid values for Value.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue: The type of this node.

static constexpr const char *path = {"InfieldVerification/Value"}: The full path for this value.

static constexpr const char *name = {"Value"}: The name of this value.

static constexpr const char * description {R"description(Time of the most recent infield verification.)description"}: The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Value &value): Operator to serialize the value to a stream.

class MaxTransferSpeed

The end-to-end link speed between the camera and the host computer, defined as the minimum of the camera’s link speed and the PC’s link speed.

OK: Max transfer speed > 1 Gbps
Suboptimal: Max transfer speed = 1 Gbps
Error: Max transfer speed < 1 Gbps
Unknown: Max transfer speed could not be determined

Public Functions

MaxTransferSpeed(): Default constructor.

template<typename ...Args> inline explicit MaxTransferSpeed(Args&&... args)

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing MaxTransferSpeed then invoking set(args).

The provided arguments must be descendants of MaxTransferSpeed. These types can be provided:

CameraHealth::MaxTransferSpeed::Status
CameraHealth::MaxTransferSpeed::Value

template<typename ...Args> inline void set(Args&&... args)

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of MaxTransferSpeed. These types can be provided:

CameraHealth::MaxTransferSpeed::Status
CameraHealth::MaxTransferSpeed::Value

template<typename ...Args> inline MaxTransferSpeed copyWith(Args&&... args) const

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this MaxTransferSpeed object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of MaxTransferSpeed. These types can be provided:

CameraHealth::MaxTransferSpeed::Status
CameraHealth::MaxTransferSpeed::Value

inline const Status &status() const: Get Status.

inline Status &status(): Get Status.

inline MaxTransferSpeed &set(const Status &value): Set Status.

inline const Value &value() const: Get Value.

inline Value &value(): Get Value.

inline MaxTransferSpeed &set(const Value &value): Set Value.

template<typename F> inline void forEach(const F &f) const: Run the given function on each direct member with the value of the member as parameter.

template<typename F> inline void forEach(const F &f): Run the given function on each direct member with the value of the member as parameter.

bool operator==(const MaxTransferSpeed &other) const: Equality operator.

bool operator!=(const MaxTransferSpeed &other) const: Inequality operator.

std::string toString() const: Get the value as string.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group: The type of this node.

static constexpr const char *path = {"MaxTransferSpeed"}: The full path for this value.

static constexpr const char *name = {"MaxTransferSpeed"}: The name of this value.

static constexpr const char * description {R"description(Theend-to-endlink speed between the camera and the hostcomputer, defined as the minimum of the camera's link speedand the PC's link speed.- OK: Max transfer speed > 1 Gbps- Suboptimal: Max transfer speed = 1 Gbps- Error: Max transfer speed < 1 Gbps- Unknown: Max transfer speed could not be determined)description"}: The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const MaxTransferSpeed &value): Operator to send the value as string to a stream.

class Status

Severity of the max transfer speed check.

Public Types

enum class ValueType

The type of the underlying value.

Values:

enumerator ok

enumerator suboptimal

enumerator error

enumerator unknown

Public Functions

Status() = default: Default constructor.

inline explicit constexpr Status(ValueType value): Constructor.

ValueType value() const: Get the value.

std::string toString() const: Get the value as string.

inline bool operator==(const Status &other) const: Comparison operator.

inline bool operator!=(const Status &other) const: Comparison operator.

Public Static Functions

static inline std::set<ValueType> validValues(): All valid values of Status.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue: The type of this node.

static constexpr const char *path = {"MaxTransferSpeed/Status"}: The full path for this value.

static constexpr const char *name = {"Status"}: The name of this value.

static constexpr const char * description {R"description(Severity of the max transfer speed check.)description"}: The description for this value.

static const Status ok: ok

static const Status suboptimal: suboptimal

static const Status error: error

static const Status unknown: unknown

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Status::ValueType &value): Operator to serialize ValueType to a stream.

inline friend std::ostream &operator<<(std::ostream &stream, const Status &value): Operator to serialize the value to a stream.

class Value

Max transfer speed in megabits per second (Mbps).

Public Types

using ValueType = uint32_t: The type of the underlying value.

Public Functions

Value() = default: Default constructor.

inline explicit constexpr Value(uint32_t value): Constructor.

uint32_t value() const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

bool hasValue() const: Check if the value is set.

void reset(): Reset the node to unset state.

std::string toString() const: Get the value as string.

inline bool operator==(const Value &other) const: Comparison operator.

inline bool operator!=(const Value &other) const: Comparison operator.

inline bool operator<(const Value &other) const: Comparison operator.

inline bool operator>(const Value &other) const: Comparison operator.

inline bool operator<=(const Value &other) const: Comparison operator.

inline bool operator>=(const Value &other) const: Comparison operator.

Public Static Functions

static inline constexpr Range<uint32_t> validRange(): The range of valid values for Value.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue: The type of this node.

static constexpr const char *path = {"MaxTransferSpeed/Value"}: The full path for this value.

static constexpr const char *name = {"Value"}: The name of this value.

static constexpr const char * description {R"description(Max transfer speed in megabits per second (Mbps).)description"}: The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Value &value): Operator to serialize the value to a stream.

class Memory

The status of the camera’s memory test.

OK: Memory was tested and reported zero errors
Error: Memory was tested and an error was located
Unknown: Memory test was not performed

Public Functions

Memory(): Default constructor.

template<typename ...Args> inline explicit Memory(Args&&... args)

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing Memory then invoking set(args).

The provided arguments must be descendants of Memory. These types can be provided:

CameraHealth::Memory::Status
CameraHealth::Memory::Value

template<typename ...Args> inline void set(Args&&... args)

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of Memory. These types can be provided:

CameraHealth::Memory::Status
CameraHealth::Memory::Value

template<typename ...Args> inline Memory copyWith(Args&&... args) const

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this Memory object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of Memory. These types can be provided:

CameraHealth::Memory::Status
CameraHealth::Memory::Value

inline const Status &status() const: Get Status.

inline Status &status(): Get Status.

inline Memory &set(const Status &value): Set Status.

inline const Value &value() const: Get Value.

inline Value &value(): Get Value.

inline Memory &set(const Value &value): Set Value.

template<typename F> inline void forEach(const F &f) const: Run the given function on each direct member with the value of the member as parameter.

template<typename F> inline void forEach(const F &f): Run the given function on each direct member with the value of the member as parameter.

bool operator==(const Memory &other) const: Equality operator.

bool operator!=(const Memory &other) const: Inequality operator.

std::string toString() const: Get the value as string.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group: The type of this node.

static constexpr const char *path = {"Memory"}: The full path for this value.

static constexpr const char *name = {"Memory"}: The name of this value.

static constexpr const char * description = { R"description(The status of the camera's memorytest.- OK:Memorywas tested and reported zero errors- Error:Memorywas tested and an error was located- Unknown:Memorytest was not performed)description" }: The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Memory &value): Operator to send the value as string to a stream.

class Status

Severity of the memory check.

Public Types

enum class ValueType

The type of the underlying value.

Values:

enumerator ok

enumerator suboptimal

enumerator error

enumerator unknown

Public Functions

Status() = default: Default constructor.

inline explicit constexpr Status(ValueType value): Constructor.

ValueType value() const: Get the value.

std::string toString() const: Get the value as string.

inline bool operator==(const Status &other) const: Comparison operator.

inline bool operator!=(const Status &other) const: Comparison operator.

Public Static Functions

static inline std::set<ValueType> validValues(): All valid values of Status.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue: The type of this node.

static constexpr const char *path = {"Memory/Status"}: The full path for this value.

static constexpr const char *name = {"Status"}: The name of this value.

static constexpr const char * description = { R"description(Severity of the memory check.)description" }: The description for this value.

static const Status ok: ok

static const Status suboptimal: suboptimal

static const Status error: error

static const Status unknown: unknown

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Status::ValueType &value): Operator to serialize ValueType to a stream.

inline friend std::ostream &operator<<(std::ostream &stream, const Status &value): Operator to serialize the value to a stream.

class Value

Number of memory errors detected by the memory test.

Public Types

using ValueType = uint32_t: The type of the underlying value.

Public Functions

Value() = default: Default constructor.

inline explicit constexpr Value(uint32_t value): Constructor.

uint32_t value() const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

bool hasValue() const: Check if the value is set.

void reset(): Reset the node to unset state.

std::string toString() const: Get the value as string.

inline bool operator==(const Value &other) const: Comparison operator.

inline bool operator!=(const Value &other) const: Comparison operator.

inline bool operator<(const Value &other) const: Comparison operator.

inline bool operator>(const Value &other) const: Comparison operator.

inline bool operator<=(const Value &other) const: Comparison operator.

inline bool operator>=(const Value &other) const: Comparison operator.

Public Static Functions

static inline constexpr Range<uint32_t> validRange(): The range of valid values for Value.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue: The type of this node.

static constexpr const char *path = {"Memory/Value"}: The full path for this value.

static constexpr const char *name = {"Value"}: The name of this value.

static constexpr const char * description {R"description(Number ofmemory errors detected by the memorytest.)description"}: The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Value &value): Operator to serialize the value to a stream.

class Overall

The aggregated severity across all checks, taking the highest-precedence severity among them.

Precedence from highest to lowest is Error, Unknown, Suboptimal, OK: a failing check is the most important to surface, and a check whose outcome could not be determined (Unknown) takes precedence over a Suboptimal one.

Public Types

enum class ValueType

The type of the underlying value.

Values:

enumerator ok

enumerator suboptimal

enumerator error

enumerator unknown

Public Functions

Overall() = default: Default constructor.

inline explicit constexpr Overall(ValueType value): Constructor.

ValueType value() const: Get the value.

std::string toString() const: Get the value as string.

inline bool operator==(const Overall &other) const: Comparison operator.

inline bool operator!=(const Overall &other) const: Comparison operator.

Public Static Functions

static inline std::set<ValueType> validValues(): All valid values of Overall.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue: The type of this node.

static constexpr const char *path = {"Overall"}: The full path for this value.

static constexpr const char *name = {"Overall"}: The name of this value.

static constexpr const char * description {R"description(The aggregated severity across all checks, taking thehighest-precedence severity among them. Precedence from highest tolowest is Error, Unknown, Suboptimal, OK: a failing check is themost important to surface, and a check whose outcome could not bedetermined (Unknown) takes precedence over a Suboptimal one.)description"}: The description for this value.

static const Overall ok: ok

static const Overall suboptimal: suboptimal

static const Overall error: error

static const Overall unknown: unknown

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Overall::ValueType &value): Operator to serialize ValueType to a stream.

inline friend std::ostream &operator<<(std::ostream &stream, const Overall &value): Operator to serialize the value to a stream.

class Temperature

The status of the camera’s temperatures.

Each sub-status reflects the temperature of a specific component.

Public Functions

Temperature(): Default constructor.

template<typename ...Args> inline explicit Temperature(Args&&... args)

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing Temperature then invoking set(args).

The provided arguments must be descendants of Temperature. These types can be provided:

CameraHealth::Temperature::DMD
CameraHealth::Temperature::DMD::Status
CameraHealth::Temperature::DMD::Value
CameraHealth::Temperature::LED
CameraHealth::Temperature::LED::Status
CameraHealth::Temperature::LED::Value
CameraHealth::Temperature::Lens
CameraHealth::Temperature::Lens::Status
CameraHealth::Temperature::Lens::Value

template<typename ...Args> inline void set(Args&&... args)

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of Temperature. These types can be provided:

CameraHealth::Temperature::DMD
CameraHealth::Temperature::DMD::Status
CameraHealth::Temperature::DMD::Value
CameraHealth::Temperature::LED
CameraHealth::Temperature::LED::Status
CameraHealth::Temperature::LED::Value
CameraHealth::Temperature::Lens
CameraHealth::Temperature::Lens::Status
CameraHealth::Temperature::Lens::Value

template<typename ...Args> inline Temperature copyWith(Args&&... args) const

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this Temperature object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of Temperature. These types can be provided:

CameraHealth::Temperature::DMD
CameraHealth::Temperature::DMD::Status
CameraHealth::Temperature::DMD::Value
CameraHealth::Temperature::LED
CameraHealth::Temperature::LED::Status
CameraHealth::Temperature::LED::Value
CameraHealth::Temperature::Lens
CameraHealth::Temperature::Lens::Status
CameraHealth::Temperature::Lens::Value

inline const DMD &dmd() const: Get DMD.

inline DMD &dmd(): Get DMD.

inline Temperature &set(const DMD &value): Set DMD.

inline Temperature &set(const DMD::Status &value): Set DMD::Status.

inline Temperature &set(const DMD::Value &value): Set DMD::Value.

inline const LED &led() const: Get LED.

inline LED &led(): Get LED.

inline Temperature &set(const LED &value): Set LED.

inline Temperature &set(const LED::Status &value): Set LED::Status.

inline Temperature &set(const LED::Value &value): Set LED::Value.

inline const Lens &lens() const: Get Lens.

inline Lens &lens(): Get Lens.

inline Temperature &set(const Lens &value): Set Lens.

inline Temperature &set(const Lens::Status &value): Set Lens::Status.

inline Temperature &set(const Lens::Value &value): Set Lens::Value.

template<typename F> inline void forEach(const F &f) const: Run the given function on each direct member with the value of the member as parameter.

template<typename F> inline void forEach(const F &f): Run the given function on each direct member with the value of the member as parameter.

bool operator==(const Temperature &other) const: Equality operator.

bool operator!=(const Temperature &other) const: Inequality operator.

std::string toString() const: Get the value as string.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group: The type of this node.

static constexpr const char *path = {"Temperature"}: The full path for this value.

static constexpr const char *name = {"Temperature"}: The name of this value.

static constexpr const char * description {R"description(The status of the camera's temperatures. Each sub-statusreflects thetemperatureof a specific component.)description"}: The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Temperature &value): Operator to send the value as string to a stream.

class DMD

The status of the DMD (Digital Micromirror Device) temperature, in degrees Celsius.

OK: Temperature in (0, 50)
Suboptimal: Temperature in [50, 60]
Error: Temperature < 0 or > 60

Public Functions

DMD(): Default constructor.

template<typename ...Args> inline explicit DMD(Args&&... args)

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing DMD then invoking set(args).

The provided arguments must be descendants of DMD. These types can be provided:

CameraHealth::Temperature::DMD::Status
CameraHealth::Temperature::DMD::Value

template<typename ...Args> inline void set(Args&&... args)

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of DMD. These types can be provided:

CameraHealth::Temperature::DMD::Status
CameraHealth::Temperature::DMD::Value

template<typename ...Args> inline DMD copyWith(Args&&... args) const

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this DMD object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of DMD. These types can be provided:

CameraHealth::Temperature::DMD::Status
CameraHealth::Temperature::DMD::Value

inline const Status &status() const: Get Status.

inline Status &status(): Get Status.

inline DMD &set(const Status &value): Set Status.

inline const Value &value() const: Get Value.

inline Value &value(): Get Value.

inline DMD &set(const Value &value): Set Value.

template<typename F> inline void forEach(const F &f) const: Run the given function on each direct member with the value of the member as parameter.

template<typename F> inline void forEach(const F &f): Run the given function on each direct member with the value of the member as parameter.

bool operator==(const DMD &other) const: Equality operator.

bool operator!=(const DMD &other) const: Inequality operator.

std::string toString() const: Get the value as string.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group: The type of this node.

static constexpr const char *path = {"Temperature/DMD"}: The full path for this value.

static constexpr const char *name = {"DMD"}: The name of this value.

static constexpr const char * description {R"description(Thestatus of the DMD (Digital Micromirror Device) temperature, in degrees Celsius.- OK:Temperaturein (0, 50)- Suboptimal:Temperaturein [50, 60]- Error:Temperature< 0 or > 60)description"}: The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const DMD &value): Operator to send the value as string to a stream.

class Status

Severity of the DMD temperature check.

Public Types

enum class ValueType

The type of the underlying value.

Values:

enumerator ok

enumerator suboptimal

enumerator error

enumerator unknown

Public Functions

Status() = default: Default constructor.

inline explicit constexpr Status(ValueType value): Constructor.

ValueType value() const: Get the value.

std::string toString() const: Get the value as string.

inline bool operator==(const Status &other) const: Comparison operator.

inline bool operator!=(const Status &other) const: Comparison operator.

Public Static Functions

static inline std::set<ValueType> validValues(): All valid values of Status.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue: The type of this node.

static constexpr const char *path = {"Temperature/DMD/Status"}: The full path for this value.

static constexpr const char *name = {"Status"}: The name of this value.

static constexpr const char * description {R"description(Severity of theDMD temperaturecheck.)description"}: The description for this value.

static const Status ok: ok

static const Status suboptimal: suboptimal

static const Status error: error

static const Status unknown: unknown

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Status::ValueType &value): Operator to serialize ValueType to a stream.

inline friend std::ostream &operator<<(std::ostream &stream, const Status &value): Operator to serialize the value to a stream.

class Value

DMD temperature in degrees Celsius.

Public Types

using ValueType = double: The type of the underlying value.

Public Functions

Value() = default: Default constructor.

inline explicit constexpr Value(double value): Constructor.

double value() const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

bool hasValue() const: Check if the value is set.

void reset(): Reset the node to unset state.

std::string toString() const: Get the value as string.

inline bool operator==(const Value &other) const: Comparison operator.

inline bool operator!=(const Value &other) const: Comparison operator.

inline bool operator<(const Value &other) const: Comparison operator.

inline bool operator>(const Value &other) const: Comparison operator.

inline bool operator<=(const Value &other) const: Comparison operator.

inline bool operator>=(const Value &other) const: Comparison operator.

Public Static Functions

static inline constexpr Range<double> validRange(): The range of valid values for Value.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue: The type of this node.

static constexpr const char *path = {"Temperature/DMD/Value"}: The full path for this value.

static constexpr const char *name = {"Value"}: The name of this value.

static constexpr const char * description {R"description(DMD temperaturein degrees Celsius.)description"}: The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Value &value): Operator to serialize the value to a stream.

class LED

The status of the LED temperature, in degrees Celsius.

OK: Temperature in (0, 60)
Suboptimal: Temperature in [60, 70]
Error: Temperature < 0 or > 70

Public Functions

LED(): Default constructor.

template<typename ...Args> inline explicit LED(Args&&... args)

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing LED then invoking set(args).

The provided arguments must be descendants of LED. These types can be provided:

CameraHealth::Temperature::LED::Status
CameraHealth::Temperature::LED::Value

template<typename ...Args> inline void set(Args&&... args)

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of LED. These types can be provided:

CameraHealth::Temperature::LED::Status
CameraHealth::Temperature::LED::Value

template<typename ...Args> inline LED copyWith(Args&&... args) const

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this LED object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of LED. These types can be provided:

CameraHealth::Temperature::LED::Status
CameraHealth::Temperature::LED::Value

inline const Status &status() const: Get Status.

inline Status &status(): Get Status.

inline LED &set(const Status &value): Set Status.

inline const Value &value() const: Get Value.

inline Value &value(): Get Value.

inline LED &set(const Value &value): Set Value.

template<typename F> inline void forEach(const F &f) const: Run the given function on each direct member with the value of the member as parameter.

template<typename F> inline void forEach(const F &f): Run the given function on each direct member with the value of the member as parameter.

bool operator==(const LED &other) const: Equality operator.

bool operator!=(const LED &other) const: Inequality operator.

std::string toString() const: Get the value as string.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group: The type of this node.

static constexpr const char *path = {"Temperature/LED"}: The full path for this value.

static constexpr const char *name = {"LED"}: The name of this value.

static constexpr const char * description {R"description(Thestatus of the LED temperature, in degrees Celsius.- OK:Temperaturein (0, 60)- Suboptimal:Temperaturein [60, 70]- Error:Temperature< 0 or > 70)description"}: The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const LED &value): Operator to send the value as string to a stream.

class Status

Severity of the LED temperature check.

Public Types

enum class ValueType

The type of the underlying value.

Values:

enumerator ok

enumerator suboptimal

enumerator error

enumerator unknown

Public Functions

Status() = default: Default constructor.

inline explicit constexpr Status(ValueType value): Constructor.

ValueType value() const: Get the value.

std::string toString() const: Get the value as string.

inline bool operator==(const Status &other) const: Comparison operator.

inline bool operator!=(const Status &other) const: Comparison operator.

Public Static Functions

static inline std::set<ValueType> validValues(): All valid values of Status.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue: The type of this node.

static constexpr const char *path = {"Temperature/LED/Status"}: The full path for this value.

static constexpr const char *name = {"Status"}: The name of this value.

static constexpr const char * description {R"description(Severity of theLED temperaturecheck.)description"}: The description for this value.

static const Status ok: ok

static const Status suboptimal: suboptimal

static const Status error: error

static const Status unknown: unknown

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Status::ValueType &value): Operator to serialize ValueType to a stream.

inline friend std::ostream &operator<<(std::ostream &stream, const Status &value): Operator to serialize the value to a stream.

class Value

LED temperature in degrees Celsius.

Public Types

using ValueType = double: The type of the underlying value.

Public Functions

Value() = default: Default constructor.

inline explicit constexpr Value(double value): Constructor.

double value() const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

bool hasValue() const: Check if the value is set.

void reset(): Reset the node to unset state.

std::string toString() const: Get the value as string.

inline bool operator==(const Value &other) const: Comparison operator.

inline bool operator!=(const Value &other) const: Comparison operator.

inline bool operator<(const Value &other) const: Comparison operator.

inline bool operator>(const Value &other) const: Comparison operator.

inline bool operator<=(const Value &other) const: Comparison operator.

inline bool operator>=(const Value &other) const: Comparison operator.

Public Static Functions

static inline constexpr Range<double> validRange(): The range of valid values for Value.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue: The type of this node.

static constexpr const char *path = {"Temperature/LED/Value"}: The full path for this value.

static constexpr const char *name = {"Value"}: The name of this value.

static constexpr const char * description {R"description(LED temperaturein degrees Celsius.)description"}: The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Value &value): Operator to serialize the value to a stream.

class Lens

The status of the lens temperature, in degrees Celsius.

OK: Temperature in (0, 50)
Suboptimal: Temperature in [50, 60]
Error: Temperature < 0 or > 60

Public Functions

Lens(): Default constructor.

template<typename ...Args> inline explicit Lens(Args&&... args)

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing Lens then invoking set(args).

The provided arguments must be descendants of Lens. These types can be provided:

CameraHealth::Temperature::Lens::Status
CameraHealth::Temperature::Lens::Value

template<typename ...Args> inline void set(Args&&... args)

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of Lens. These types can be provided:

CameraHealth::Temperature::Lens::Status
CameraHealth::Temperature::Lens::Value

template<typename ...Args> inline Lens copyWith(Args&&... args) const

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this Lens object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of Lens. These types can be provided:

CameraHealth::Temperature::Lens::Status
CameraHealth::Temperature::Lens::Value

inline const Status &status() const: Get Status.

inline Status &status(): Get Status.

inline Lens &set(const Status &value): Set Status.

inline const Value &value() const: Get Value.

inline Value &value(): Get Value.

inline Lens &set(const Value &value): Set Value.

template<typename F> inline void forEach(const F &f) const: Run the given function on each direct member with the value of the member as parameter.

template<typename F> inline void forEach(const F &f): Run the given function on each direct member with the value of the member as parameter.

bool operator==(const Lens &other) const: Equality operator.

bool operator!=(const Lens &other) const: Inequality operator.

std::string toString() const: Get the value as string.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group: The type of this node.

static constexpr const char *path = {"Temperature/Lens"}: The full path for this value.

static constexpr const char *name = {"Lens"}: The name of this value.

static constexpr const char * description {R"description(Thestatus of the lens temperature, in degrees Celsius.- OK:Temperaturein (0, 50)- Suboptimal:Temperaturein [50, 60]- Error:Temperature< 0 or > 60)description"}: The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Lens &value): Operator to send the value as string to a stream.

class Status

Severity of the lens temperature check.

Public Types

enum class ValueType

The type of the underlying value.

Values:

enumerator ok

enumerator suboptimal

enumerator error

enumerator unknown

Public Functions

Status() = default: Default constructor.

inline explicit constexpr Status(ValueType value): Constructor.

ValueType value() const: Get the value.

std::string toString() const: Get the value as string.

inline bool operator==(const Status &other) const: Comparison operator.

inline bool operator!=(const Status &other) const: Comparison operator.

Public Static Functions

static inline std::set<ValueType> validValues(): All valid values of Status.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue: The type of this node.

static constexpr const char *path = {"Temperature/Lens/Status"}: The full path for this value.

static constexpr const char *name = {"Status"}: The name of this value.

static constexpr const char * description {R"description(Severity of thelens temperaturecheck.)description"}: The description for this value.

static const Status ok: ok

static const Status suboptimal: suboptimal

static const Status error: error

static const Status unknown: unknown

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Status::ValueType &value): Operator to serialize ValueType to a stream.

inline friend std::ostream &operator<<(std::ostream &stream, const Status &value): Operator to serialize the value to a stream.

class Value

Lens temperature in degrees Celsius.

Public Types

using ValueType = double: The type of the underlying value.

Public Functions

Value() = default: Default constructor.

inline explicit constexpr Value(double value): Constructor.

double value() const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

bool hasValue() const: Check if the value is set.

void reset(): Reset the node to unset state.

std::string toString() const: Get the value as string.

inline bool operator==(const Value &other) const: Comparison operator.

inline bool operator!=(const Value &other) const: Comparison operator.

inline bool operator<(const Value &other) const: Comparison operator.

inline bool operator>(const Value &other) const: Comparison operator.

inline bool operator<=(const Value &other) const: Comparison operator.

inline bool operator>=(const Value &other) const: Comparison operator.

Public Static Functions

static inline constexpr Range<double> validRange(): The range of valid values for Value.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue: The type of this node.

static constexpr const char *path = {"Temperature/Lens/Value"}: The full path for this value.

static constexpr const char *name = {"Value"}: The name of this value.

static constexpr const char * description {R"description(Lens temperaturein degrees Celsius.)description"}: The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Value &value): Operator to serialize the value to a stream.

C#

struct CameraHealth

Result of running the camera’s health checks.

Each check has a Status (severity) and a Value (the underlying measurement, when available). The Overall field aggregates the worst severity across all populated checks.

Status values:

OK: Optimal.
Suboptimal: Degraded but functional.
Error: Faulty or out of spec.
Unknown: Check was not performed, or its outcome could not be determined.

Public Types

enum class OverallOption : std::underlying_type<Zivid::CameraHealth::Overall::ValueType>::type

The aggregated severity across all checks, taking the highest-precedence severity among them.

Precedence from highest to lowest is Error, Unknown, Suboptimal, OK: a failing check is the most important to surface, and a check whose outcome could not be determined (Unknown) takes precedence over a Suboptimal one.

Values:

enumerator OK

enumerator Suboptimal

enumerator Error

enumerator Unknown

Public Functions

System::String ^ Serialize ()

Serialize to a string.

See also FromSerialized. The returned string is formatted in YAML, and is compatible with the contents of files saved using Save.

void Save (System::String ^ fileName): Save to the given file.

void Load (System::String ^ fileName): Load from the given file.

inline CameraHealth(): Constructor.

CameraHealth ^ CopyWith (CopyWithDelegate ^ delegate)

Create a clone (deep copy) of the current instance and invoke delegate on the clone.

Creates a clone (deep copy) of this object, then invokes the delegate function on the clone, and finally returns the clone. This method can be used to create a clone of an instance and then change one or more properties on the clone in one method call. The current instance is unchanged.

CameraHealth ^ Clone (): Create a clone (deep copy) of the current instance.

System::String ^ ToString () override: Get string representation of the object.

Properties

OverallOption Overall

The aggregated severity across all checks, taking the highest-precedence severity among them.

Precedence from highest to lowest is Error, Unknown, Suboptimal, OK: a failing check is the most important to surface, and a check whose outcome could not be determined (Unknown) takes precedence over a Suboptimal one.

Public Static Attributes

static CameraHealth(System::String ^ fileName) CameraHealth FromSerialized )(System::String ^ value)

Construct CameraHealth by loading from file.

Construct a new CameraHealth instance from a previously serialized string