Zivid::CameraState::Status Class Reference

This enum describes the current status of this camera. The enum can have the following values: More...

#include <Zivid/CameraState.h>

Public Types
enum class	ValueType {   inaccessible , busy , applyingNetworkConfiguration , firmwareUpdateRequired ,   updatingFirmware , available , connecting , connected ,   disconnecting , disappeared }
	The type of the underlying value. More...

Public Member Functions
	Status ()=default
	Default constructor.
constexpr	Status (ValueType value)
	Constructor.
ValueType	value () const
	Get the value.
std::string	toString () const
	Get the value as string.
bool	operator== (const Status &other) const
	Comparison operator.
bool	operator!= (const Status &other) const
	Comparison operator.

Static Public Member Functions
static std::set< ValueType >	validValues ()
	All valid values of Status.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::leafValue
	The type of this node.
static constexpr const char *	path { "Status" }
	The full path for this value.
static constexpr const char *	name { "Status" }
	The name of this value.
static constexpr const char *	description
	The description for this value.
static const Status	inaccessible
	inaccessible
static const Status	busy
	busy
static const Status	applyingNetworkConfiguration
	applyingNetworkConfiguration
static const Status	firmwareUpdateRequired
	firmwareUpdateRequired
static const Status	updatingFirmware
	updatingFirmware
static const Status	available
	available
static const Status	connecting
	connecting
static const Status	connected
	connected
static const Status	disconnecting
	disconnecting
static const Status	disappeared
	disappeared

Friends
struct	DataModel::Detail::Befriend< Status >
std::ostream &	operator<< (std::ostream &stream, const Status::ValueType &value)
	Operator to serialize ValueType to a stream.
std::ostream &	operator<< (std::ostream &stream, const Status &value)
	Operator to serialize the value to a stream.

Detailed Description

This enum describes the current status of this camera. The enum can have the following values:

• inaccessible: The camera was discovered, but the SDK is not able to connect to this camera. This can be because the IP settings of the camera and the PC are not compatible, or because there are several cameras with the same IP connected to your PC. The InaccessibleReason enum will give you more details about why this camera is not accessible. The network configuration of the camera can be changed using the ZividNetworkCameraConfigurator CLI tool. See the knowledge base for more information.
• busy: The camera is currently in use by another process. This can be a different process on the same PC, or on a different PC if the camera is shared on a network.
• applyingNetworkConfiguration: The camera network configuration is being changed by the current process.
• firmwareUpdateRequired: The camera is accessible, but requires a firmware update before you can connect to it.
• updatingFirmware: The camera firmware is currently being updated in the current process.
• available: The camera is available for use by the current process. This means that you can invoke camera.connect() on this camera.
• connecting: The camera is currently connecting in the current process.
• connected: The camera is connected in the current process. This means camera.connect() has successfully completed and you can capture using this camera.
• disconnecting: The camera is currently disconnecting in the current process. When disconnection has completed, the camera will normally go back to the available state.
• disappeared: The camera was found earlier, but it can no longer be found. The connection between the PC and the camera may be disrupted, or the camera may have lost power. When in disappeared state, the camera will not be returned from Application::cameras(). The camera will go back to one of the other states if the camera is later found again.

Member Enumeration Documentation

ValueType

enum class Zivid::CameraState::Status::ValueType

strong

The type of the underlying value.

Enumerator
inaccessible
busy
applyingNetworkConfiguration
firmwareUpdateRequired
updatingFirmware
available
connecting
connected
disconnecting
disappeared

Constructor & Destructor Documentation

Status() [1/2]

Zivid::CameraState::Status::Status ( )

default

Default constructor.

Status() [2/2]

Zivid::CameraState::Status::Status ( ValueType value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

operator!=()

bool Zivid::CameraState::Status::operator!= ( const Status & other ) const

inline

Comparison operator.

operator==()

bool Zivid::CameraState::Status::operator== ( const Status & other ) const

inline

Comparison operator.

toString()

std::string Zivid::CameraState::Status::toString

(

)

const

Get the value as string.

validValues()

static std::set< ValueType > Zivid::CameraState::Status::validValues ( )

inlinestatic

All valid values of Status.

value()

ValueType Zivid::CameraState::Status::value

(

)

const

Get the value.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< Status >

friend struct DataModel::Detail::Befriend< Status >

friend

operator<< [1/2]

std::ostream & operator<< ( std::ostream & stream, const Status & value )

friend

Operator to serialize the value to a stream.

operator<< [2/2]

std::ostream & operator<< ( std::ostream & stream, const Status::ValueType & value )

friend

Operator to serialize ValueType to a stream.

Member Data Documentation

applyingNetworkConfiguration

const Status Zivid::CameraState::Status::applyingNetworkConfiguration

static

applyingNetworkConfiguration

available

const Status Zivid::CameraState::Status::available

static

available

busy

const Status Zivid::CameraState::Status::busy

static

busy

connected

const Status Zivid::CameraState::Status::connected

static

connected

connecting

const Status Zivid::CameraState::Status::connecting

static

connecting

description

const char* Zivid::CameraState::Status::description

staticconstexpr

The description for this value.

disappeared

const Status Zivid::CameraState::Status::disappeared

static

disappeared

disconnecting

const Status Zivid::CameraState::Status::disconnecting

static

disconnecting

firmwareUpdateRequired

const Status Zivid::CameraState::Status::firmwareUpdateRequired

static

firmwareUpdateRequired

inaccessible

const Status Zivid::CameraState::Status::inaccessible

static

inaccessible

name

const char* Zivid::CameraState::Status::name { "Status" }

staticconstexpr

The name of this value.

nodeType

DataModel::NodeType Zivid::CameraState::Status::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node.

path

const char* Zivid::CameraState::Status::path { "Status" }

staticconstexpr

The full path for this value.

updatingFirmware

const Status Zivid::CameraState::Status::updatingFirmware

static

updatingFirmware

---

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

• Zivid/CameraState.h