CameraState

实时遥测数据：温度、网络链路状态、可用性、连接状态……

C++

CameraStateclass

Information about camera connection state, temperatures, etc.

Public Functions

CameraState(): Default constructor.

CameraState( stdstring&const:: fileName)explicit: Construct CameraState by loading from file.

stdstringserialize()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.

< Argstemplatetypename...> CameraState(Args& &...args)inlineexplicit

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 CameraState then invoking set(args).

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

CameraState::Available
CameraState::Connected
CameraState::InaccessibleReason
CameraState::Network
CameraState::Network::Ethernet
CameraState::Network::Ethernet::LinkSpeed
CameraState::Network::IPV4
CameraState::Network::IPV4::Address
CameraState::Network::LocalInterfaces
CameraState::Status
CameraState::Temperature
CameraState::Temperature::DMD
CameraState::Temperature::General
CameraState::Temperature::LED
CameraState::Temperature::Lens
CameraState::Temperature::PCB

< Argstemplatetypename...> set(Args& &...args)inlinevoid

Set multiple arguments.

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

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

CameraState::Available
CameraState::Connected
CameraState::InaccessibleReason
CameraState::Network
CameraState::Network::Ethernet
CameraState::Network::Ethernet::LinkSpeed
CameraState::Network::IPV4
CameraState::Network::IPV4::Address
CameraState::Network::LocalInterfaces
CameraState::Status
CameraState::Temperature
CameraState::Temperature::DMD
CameraState::Temperature::General
CameraState::Temperature::LED
CameraState::Temperature::Lens
CameraState::Temperature::PCB

< Argstemplatetypename...> CameraStatecopyWith(Args& &...args)constinline 

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

Creates a copy of this CameraState 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 CameraState. These types can be provided:

CameraState::Available
CameraState::Connected
CameraState::InaccessibleReason
CameraState::Network
CameraState::Network::Ethernet
CameraState::Network::Ethernet::LinkSpeed
CameraState::Network::IPV4
CameraState::Network::IPV4::Address
CameraState::Network::LocalInterfaces
CameraState::Status
CameraState::Temperature
CameraState::Temperature::DMD
CameraState::Temperature::General
CameraState::Temperature::LED
CameraState::Temperature::Lens
CameraState::Temperature::PCB

Available&isAvailable()constinlineconst : Get Available.

Available&isAvailable()inline : Get Available.

CameraState&set( Available&const value)inline : Set Available.

Connected&isConnected()constinlineconst : Get Connected.

Connected&isConnected()inline : Get Connected.

CameraState&set( Connected&const value)inline : Set Connected.

InaccessibleReason&inaccessibleReason()constinlineconst : Get InaccessibleReason.

InaccessibleReason&inaccessibleReason()inline : Get InaccessibleReason.

CameraState&set( InaccessibleReason&const value)inline : Set InaccessibleReason.

Network&network()constinlineconst : Get Network.

Network&network()inline : Get Network.

CameraState&set( Network&const value)inline : Set Network.

CameraState&set( Network Ethernet&const:: value)inline : Set Network::Ethernet.

CameraState&set( Network Ethernet LinkSpeed&const:::: value)inline : Set Network::Ethernet::LinkSpeed.

CameraState&set( Network IPV4&const:: value)inline : Set Network::IPV4.

CameraState&set( Network IPV4 Address&const:::: value)inline : Set Network::IPV4::Address.

CameraState&set( Network LocalInterfaces&const:: value)inline : Set Network::LocalInterfaces.

Status&status()constinlineconst : Get Status.

Status&status()inline : Get Status.

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

Temperature&temperature()constinlineconst : Get Temperature.

Temperature&temperature()inline : Get Temperature.

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

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

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

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

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

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

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

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

==operator( CameraState&const other)constbool : Equality operator.

!=operator( CameraState&const other)constbool : Inequality operator.

stdstringtoString()const:: : Get the value as string.

save( stdstring&const:: fileName)constvoid : Save to the given file.

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

Public Static Functions

CameraStatefromSerialized( stdstring&const:: value)static 

Construct a new CameraState instance from a previously serialized string.

See also serialize.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypegroupstaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "": The full path for this value.

name={}staticconstexprconstchar* "CameraState": The name of this value.

static constexpr const char * description {R"description(Information about camera connection state, temperatures, etc.)description"}: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, CameraState&const value)inlinefriend:: : Operator to send the value as string to a stream.

Availableclass

Flag if camera is physically connected to the computer and is available for use, but not connected in software.

This corresponds to the Status enums available or firmwareUpdateRequired. Zivid recommends to use the Status enum instead of this bool.

Public Types

ValueType=boolusing : The type of the underlying value.

Public Functions

Available()=default : Default constructor.

Available( boolvalue)inlineexplicitconstexpr: Constructor.

value()constbool : Get the value.

stdstringtoString()const:: : Get the value as string.

operatorbool()constinlineexplicit : Convert to bool where appropriate.

==operator( Available&const other)constinlinebool : Comparison operator.

!=operator( Available&const other)constinlinebool : Comparison operator.

Public Static Functions

stdsetbool validValues()staticinline::<>: All valid values of Available.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Available": The full path for this value.

name={}staticconstexprconstchar* "Available": The name of this value.

static constexpr const char * description {R"description(Flag if camera is physically connected to the computer and is available for use, but not connected insoftware. This corresponds to theStatusenums `available` or `firmwareUpdateRequired`. Zividrecommends to use theStatusenum instead of this bool.)description"}: The description for this value.

Availableyesstaticconst : On/enabled.

Availablenostaticconst : Off/disabled.

Friends

stdostream&<<operator(stdostream&:: stream, Available&const value)inlinefriend:: : Operator to serialize the value to a stream.

Connectedclass

Flag if camera is connected in software.

This bool is true when the Status value is connected. Zivid recommends to use the Status enum instead of this bool.

Public Types

ValueType=boolusing : The type of the underlying value.

Public Functions

Connected()=default : Default constructor.

Connected( boolvalue)inlineexplicitconstexpr: Constructor.

value()constbool : Get the value.

stdstringtoString()const:: : Get the value as string.

operatorbool()constinlineexplicit : Convert to bool where appropriate.

==operator( Connected&const other)constinlinebool : Comparison operator.

!=operator( Connected&const other)constinlinebool : Comparison operator.

Public Static Functions

stdsetbool validValues()staticinline::<>: All valid values of Connected.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Connected": The full path for this value.

name={}staticconstexprconstchar* "Connected": The name of this value.

static constexpr const char * description {R"description(Flag if camera is connected in software. This bool is true when theStatus valueis `connected`. Zividrecommends to use theStatusenum instead of this bool.)description"}: The description for this value.

Connectedyesstaticconst : On/enabled.

Connectednostaticconst : Off/disabled.

Friends

stdostream&<<operator(stdostream&:: stream, Connected&const value)inlinefriend:: : Operator to serialize the value to a stream.

InaccessibleReasonclass

If the camera status is inaccessible, then this enum value will give you the reason.

Public Types

ValueTypeenumclass

The type of the underlying value.

Values:

ipConflictWithAnotherCameraenumerator

ipConflictWithLocalNetworkAdapterenumerator

ipNotInLocalSubnetenumerator

ipInMultipleLocalSubnetsenumerator

Public Functions

InaccessibleReason()=default : Default constructor.

InaccessibleReason(ValueTypevalue )inlineexplicitconstexpr: Constructor.

ValueTypevalue()const 

Get the value.

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

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

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

stdstringtoString()const:: : Get the value as string.

==operator( InaccessibleReason&const other)constinlinebool : Comparison operator.

!=operator( InaccessibleReason&const other)constinlinebool : Comparison operator.

Public Static Functions

stdsetValueType validValues()staticinline::<>: All valid values of InaccessibleReason.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "InaccessibleReason": The full path for this value.

name={}staticconstexprconstchar* "InaccessibleReason": The name of this value.

static constexpr const char * description {R"description(If the camerastatus is `inaccessible`, then this enum valuewill give you the reason.)description"}: The description for this value.

InaccessibleReasonipConflictWithAnotherCamerastaticconst : ipConflictWithAnotherCamera

InaccessibleReasonipConflictWithLocalNetworkAdapterstaticconst : ipConflictWithLocalNetworkAdapter

InaccessibleReasonipNotInLocalSubnetstaticconst : ipNotInLocalSubnet

InaccessibleReasonipInMultipleLocalSubnetsstaticconst : ipInMultipleLocalSubnets

Friends

stdostream&<<operator(stdostream&:: stream, InaccessibleReason ValueType&const:: value)inlinefriend:: : Operator to serialize ValueType to a stream.

stdostream&<<operator(stdostream&:: stream, InaccessibleReason&const value)inlinefriend:: : Operator to serialize the value to a stream.

Networkclass

Current network state.

Public Functions

Network(): Default constructor.

< Argstemplatetypename...> Network(Args& &...args)inlineexplicit

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 Network then invoking set(args).

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

CameraState::Network::Ethernet
CameraState::Network::Ethernet::LinkSpeed
CameraState::Network::IPV4
CameraState::Network::IPV4::Address
CameraState::Network::LocalInterfaces

< Argstemplatetypename...> set(Args& &...args)inlinevoid

Set multiple arguments.

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

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

CameraState::Network::Ethernet
CameraState::Network::Ethernet::LinkSpeed
CameraState::Network::IPV4
CameraState::Network::IPV4::Address
CameraState::Network::LocalInterfaces

< Argstemplatetypename...> NetworkcopyWith(Args& &...args)constinline 

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

Creates a copy of this Network 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 Network. These types can be provided:

CameraState::Network::Ethernet
CameraState::Network::Ethernet::LinkSpeed
CameraState::Network::IPV4
CameraState::Network::IPV4::Address
CameraState::Network::LocalInterfaces

Ethernet&ethernet()constinlineconst : Get Ethernet.

Ethernet&ethernet()inline : Get Ethernet.

Network&set( Ethernet&const value)inline : Set Ethernet.

Network&set( Ethernet LinkSpeed&const:: value)inline : Set Ethernet::LinkSpeed.

IPV4&ipv4()constinlineconst : Get IPV4.

IPV4&ipv4()inline : Get IPV4.

Network&set( IPV4&const value)inline : Set IPV4.

Network&set( IPV4 Address&const:: value)inline : Set IPV4::Address.

LocalInterfaces&localInterfaces()constinlineconst : Get LocalInterfaces.

LocalInterfaces&localInterfaces()inline : Get LocalInterfaces.

Network&set( LocalInterfaces&const value)inline : Set LocalInterfaces.

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

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

==operator( Network&const other)constbool : Equality operator.

!=operator( Network&const other)constbool : Inequality operator.

stdstringtoString()const:: : Get the value as string.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypegroupstaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Network": The full path for this value.

name={}staticconstexprconstchar* "Network": The name of this value.

static constexpr const char * description = { R"description(Current network state)description" }: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, Network&const value)inlinefriend:: : Operator to send the value as string to a stream.

Ethernetclass

Current Ethernet state.

Public Functions

Ethernet(): Default constructor.

< Argstemplatetypename...> Ethernet(Args& &...args)inlineexplicit

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 Ethernet then invoking set(args).

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

CameraState::Network::Ethernet::LinkSpeed

< Argstemplatetypename...> set(Args& &...args)inlinevoid

Set multiple arguments.

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

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

CameraState::Network::Ethernet::LinkSpeed

< Argstemplatetypename...> EthernetcopyWith(Args& &...args)constinline 

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

Creates a copy of this Ethernet 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 Ethernet. These types can be provided:

CameraState::Network::Ethernet::LinkSpeed

LinkSpeed&linkSpeed()constinlineconst : Get LinkSpeed.

LinkSpeed&linkSpeed()inline : Get LinkSpeed.

Ethernet&set( LinkSpeed&const value)inline : Set LinkSpeed.

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

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

==operator( Ethernet&const other)constbool : Equality operator.

!=operator( Ethernet&const other)constbool : Inequality operator.

stdstringtoString()const:: : Get the value as string.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypegroupstaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Network/Ethernet": The full path for this value.

name={}staticconstexprconstchar* "Ethernet": The name of this value.

static constexpr const char * description = { R"description(Current Ethernet state)description" }: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, Ethernet&const value)inlinefriend:: : Operator to send the value as string to a stream.

LinkSpeedclass

The link speed that the camera's Ethernet interface is operating at.

Public Types

ValueTypeenumclass

The type of the underlying value.

Values:

unknownenumerator

link10Mbpsenumerator

link100Mbpsenumerator

link1Gbpsenumerator

link2_5Gbpsenumerator

link5Gbpsenumerator

link10Gbpsenumerator

Public Functions

LinkSpeed()=default : Default constructor.

LinkSpeed(ValueTypevalue )inlineexplicitconstexpr: Constructor.

ValueTypevalue()const : Get the value.

stdstringtoString()const:: : Get the value as string.

==operator( LinkSpeed&const other)constinlinebool : Comparison operator.

!=operator( LinkSpeed&const other)constinlinebool : Comparison operator.

Public Static Functions

stdsetValueType validValues()staticinline::<>: All valid values of LinkSpeed.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Network/Ethernet/LinkSpeed": The full path for this value.

name={}staticconstexprconstchar* "LinkSpeed": The name of this value.

static constexpr const char * description {R"description(The link speed that the camera'sEthernetinterface is operating at.)description"}: The description for this value.

LinkSpeedunknownstaticconst : unknown

LinkSpeedlink10Mbpsstaticconst : link10Mbps

LinkSpeedlink100Mbpsstaticconst : link100Mbps

LinkSpeedlink1Gbpsstaticconst : link1Gbps

LinkSpeedlink2_5Gbpsstaticconst : link2_5Gbps

LinkSpeedlink5Gbpsstaticconst : link5Gbps

LinkSpeedlink10Gbpsstaticconst : link10Gbps

Friends

stdostream&<<operator(stdostream&:: stream, LinkSpeed ValueType&const:: value)inlinefriend:: : Operator to serialize ValueType to a stream.

stdostream&<<operator(stdostream&:: stream, LinkSpeed&const value)inlinefriend:: : Operator to serialize the value to a stream.

IPV4class

Current IPv4 protocol state.

Public Functions

IPV4(): Default constructor.

< Argstemplatetypename...> IPV4(Args& &...args)inlineexplicit

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 IPV4 then invoking set(args).

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

CameraState::Network::IPV4::Address

< Argstemplatetypename...> set(Args& &...args)inlinevoid

Set multiple arguments.

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

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

CameraState::Network::IPV4::Address

< Argstemplatetypename...> IPV4copyWith(Args& &...args)constinline 

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

Creates a copy of this IPV4 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 IPV4. These types can be provided:

CameraState::Network::IPV4::Address

Address&address()constinlineconst : Get Address.

Address&address()inline : Get Address.

IPV4&set( Address&const value)inline : Set Address.

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

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

==operator( IPV4&const other)constbool : Equality operator.

!=operator( IPV4&const other)constbool : Inequality operator.

stdstringtoString()const:: : Get the value as string.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypegroupstaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Network/IPV4": The full path for this value.

name={}staticconstexprconstchar* "IPV4": The name of this value.

static constexpr const char * description = { R"description(Current IPv4 protocol state)description" }: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, IPV4&const value)inlinefriend:: : Operator to send the value as string to a stream.

Addressclass

Current IPv4 address.

Public Types

ValueType=stdstringusing ::: The type of the underlying value.

Public Functions

Address()=default : Default constructor.

Address(stdstringvalue:: )inlineexplicit: Constructor.

stdstring&value()constconst:: : Get the value.

stdstringtoString()const:: : Get the value as string.

==operator( Address&const other)constinlinebool : Comparison operator.

!=operator( Address&const other)constinlinebool : Comparison operator.

<operator( Address&const other)constinlinebool : Comparison operator.

>operator( Address&const other)constinlinebool : Comparison operator.

<=operator( Address&const other)constinlinebool : Comparison operator.

>=operator( Address&const other)constinlinebool : Comparison operator.

Public Static Functions

Range ValueTypesize_type validSize()staticinlineconstexpr<::>: The valid sizes for Address.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Network/IPV4/Address": The full path for this value.

name={}staticconstexprconstchar* "Address": The name of this value.

static constexpr const char * description = { R"description(Current IPv4 address)description" }: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, Address&const value)inlinefriend:: : Operator to serialize the value to a stream.

LocalInterfaceclass

Current state of the computer's local network interface.

Public Functions

LocalInterface(): Default constructor.

< Argstemplatetypename...> LocalInterface(Args& &...args)inlineexplicit

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 LocalInterface then invoking set(args).

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

CameraState::Network::LocalInterface::Ethernet
CameraState::Network::LocalInterface::Ethernet::LinkSpeed
CameraState::Network::LocalInterface::IPV4
CameraState::Network::LocalInterface::IPV4::Subnets
CameraState::Network::LocalInterface::InterfaceName

< Argstemplatetypename...> set(Args& &...args)inlinevoid

Set multiple arguments.

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

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

CameraState::Network::LocalInterface::Ethernet
CameraState::Network::LocalInterface::Ethernet::LinkSpeed
CameraState::Network::LocalInterface::IPV4
CameraState::Network::LocalInterface::IPV4::Subnets
CameraState::Network::LocalInterface::InterfaceName

< Argstemplatetypename...> LocalInterfacecopyWith(Args& &...args)constinline 

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

Creates a copy of this LocalInterface 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 LocalInterface. These types can be provided:

CameraState::Network::LocalInterface::Ethernet
CameraState::Network::LocalInterface::Ethernet::LinkSpeed
CameraState::Network::LocalInterface::IPV4
CameraState::Network::LocalInterface::IPV4::Subnets
CameraState::Network::LocalInterface::InterfaceName

Ethernet&ethernet()constinlineconst : Get Ethernet.

Ethernet&ethernet()inline : Get Ethernet.

LocalInterface&set( Ethernet&const value)inline : Set Ethernet.

LocalInterface&set( Ethernet LinkSpeed&const:: value)inline : Set Ethernet::LinkSpeed.

IPV4&ipv4()constinlineconst : Get IPV4.

IPV4&ipv4()inline : Get IPV4.

LocalInterface&set( IPV4&const value)inline : Set IPV4.

LocalInterface&set( IPV4 Subnets&const:: value)inline : Set IPV4::Subnets.

InterfaceName&interfaceName()constinlineconst : Get InterfaceName.

InterfaceName&interfaceName()inline : Get InterfaceName.

LocalInterface&set( InterfaceName&const value)inline : Set InterfaceName.

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

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

==operator( LocalInterface&const other)constbool : Equality operator.

!=operator( LocalInterface&const other)constbool : Inequality operator.

stdstringtoString()const:: : Get the value as string.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypegroupstaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Network/LocalInterface": The full path for this value.

name={}staticconstexprconstchar* "LocalInterface": The name of this value.

static constexpr const char * description {R"description(Current state of the computer's localnetworkinterface.)description"}: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, LocalInterface&const value)inlinefriend:: : Operator to send the value as string to a stream.

Ethernetclass

Current Ethernet state.

Public Functions

Ethernet(): Default constructor.

< Argstemplatetypename...> Ethernet(Args& &...args)inlineexplicit

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 Ethernet then invoking set(args).

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

CameraState::Network::LocalInterface::Ethernet::LinkSpeed

< Argstemplatetypename...> set(Args& &...args)inlinevoid

Set multiple arguments.

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

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

CameraState::Network::LocalInterface::Ethernet::LinkSpeed

< Argstemplatetypename...> EthernetcopyWith(Args& &...args)constinline 

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

Creates a copy of this Ethernet 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 Ethernet. These types can be provided:

CameraState::Network::LocalInterface::Ethernet::LinkSpeed

LinkSpeed&linkSpeed()constinlineconst : Get LinkSpeed.

LinkSpeed&linkSpeed()inline : Get LinkSpeed.

Ethernet&set( LinkSpeed&const value)inline : Set LinkSpeed.

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

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

==operator( Ethernet&const other)constbool : Equality operator.

!=operator( Ethernet&const other)constbool : Inequality operator.

stdstringtoString()const:: : Get the value as string.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypegroupstaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Network/LocalInterface/Ethernet": The full path for this value.

name={}staticconstexprconstchar* "Ethernet": The name of this value.

static constexpr const char * description = { R"description(Current Ethernet state)description" }: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, Ethernet&const value)inlinefriend:: : Operator to send the value as string to a stream.

LinkSpeedclass

The link speed that the computer's Ethernet interface is operating at.

Public Types

ValueTypeenumclass

The type of the underlying value.

Values:

unknownenumerator

link10Mbpsenumerator

link100Mbpsenumerator

link1Gbpsenumerator

link2_5Gbpsenumerator

link5Gbpsenumerator

link10Gbpsenumerator

Public Functions

LinkSpeed()=default : Default constructor.

LinkSpeed(ValueTypevalue )inlineexplicitconstexpr: Constructor.

ValueTypevalue()const : Get the value.

stdstringtoString()const:: : Get the value as string.

==operator( LinkSpeed&const other)constinlinebool : Comparison operator.

!=operator( LinkSpeed&const other)constinlinebool : Comparison operator.

Public Static Functions

stdsetValueType validValues()staticinline::<>: All valid values of LinkSpeed.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Network/LocalInterface/Ethernet/LinkSpeed": The full path for this value.

name={}staticconstexprconstchar* "LinkSpeed": The name of this value.

static constexpr const char * description {R"description(The link speed that the computer'sEthernetinterface is operating at.)description"}: The description for this value.

LinkSpeedunknownstaticconst : unknown

LinkSpeedlink10Mbpsstaticconst : link10Mbps

LinkSpeedlink100Mbpsstaticconst : link100Mbps

LinkSpeedlink1Gbpsstaticconst : link1Gbps

LinkSpeedlink2_5Gbpsstaticconst : link2_5Gbps

LinkSpeedlink5Gbpsstaticconst : link5Gbps

LinkSpeedlink10Gbpsstaticconst : link10Gbps

Friends

stdostream&<<operator(stdostream&:: stream, LinkSpeed ValueType&const:: value)inlinefriend:: : Operator to serialize ValueType to a stream.

stdostream&<<operator(stdostream&:: stream, LinkSpeed&const value)inlinefriend:: : Operator to serialize the value to a stream.

InterfaceNameclass

Name of the computer's local network interface.

Public Types

ValueType=stdstringusing ::: The type of the underlying value.

Public Functions

InterfaceName()=default : Default constructor.

InterfaceName(stdstringvalue:: )inlineexplicit: Constructor.

stdstring&value()constconst:: : Get the value.

stdstringtoString()const:: : Get the value as string.

==operator( InterfaceName&const other)constinlinebool : Comparison operator.

!=operator( InterfaceName&const other)constinlinebool : Comparison operator.

<operator( InterfaceName&const other)constinlinebool : Comparison operator.

>operator( InterfaceName&const other)constinlinebool : Comparison operator.

<=operator( InterfaceName&const other)constinlinebool : Comparison operator.

>=operator( InterfaceName&const other)constinlinebool : Comparison operator.

Public Static Functions

Range ValueTypesize_type validSize()staticinlineconstexpr<::>: The valid sizes for InterfaceName.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Network/LocalInterface/InterfaceName": The full path for this value.

name={}staticconstexprconstchar* "InterfaceName": The name of this value.

static constexpr const char * description {R"description(Name of the computer's localnetworkinterface.)description"}: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, InterfaceName&const value)inlinefriend:: : Operator to serialize the value to a stream.

IPV4class

Current IPv4 protocol state of the computer's local network interface.

Public Functions

IPV4(): Default constructor.

< Argstemplatetypename...> IPV4(Args& &...args)inlineexplicit

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 IPV4 then invoking set(args).

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

CameraState::Network::LocalInterface::IPV4::Subnets

< Argstemplatetypename...> set(Args& &...args)inlinevoid

Set multiple arguments.

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

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

CameraState::Network::LocalInterface::IPV4::Subnets

< Argstemplatetypename...> IPV4copyWith(Args& &...args)constinline 

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

Creates a copy of this IPV4 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 IPV4. These types can be provided:

CameraState::Network::LocalInterface::IPV4::Subnets

Subnets&subnets()constinlineconst : Get Subnets.

Subnets&subnets()inline : Get Subnets.

IPV4&set( Subnets&const value)inline : Set Subnets.

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

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

==operator( IPV4&const other)constbool : Equality operator.

!=operator( IPV4&const other)constbool : Inequality operator.

stdstringtoString()const:: : Get the value as string.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypegroupstaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Network/LocalInterface/IPV4": The full path for this value.

name={}staticconstexprconstchar* "IPV4": The name of this value.

static constexpr const char * description {R"description(Current IPv4 protocol state of the computer's localnetworkinterface.)description"}: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, IPV4&const value)inlinefriend:: : Operator to send the value as string to a stream.

Subnetclass

An IPv4 subnet that the local network interface is connected to.

Public Functions

Subnet(): Default constructor.

< Argstemplatetypename...> Subnet(Args& &...args)inlineexplicit

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 Subnet then invoking set(args).

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

CameraState::Network::LocalInterface::IPV4::Subnet::Address
CameraState::Network::LocalInterface::IPV4::Subnet::Mask

< Argstemplatetypename...> set(Args& &...args)inlinevoid

Set multiple arguments.

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

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

CameraState::Network::LocalInterface::IPV4::Subnet::Address
CameraState::Network::LocalInterface::IPV4::Subnet::Mask

< Argstemplatetypename...> SubnetcopyWith(Args& &...args)constinline 

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

Creates a copy of this Subnet 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 Subnet. These types can be provided:

CameraState::Network::LocalInterface::IPV4::Subnet::Address
CameraState::Network::LocalInterface::IPV4::Subnet::Mask

Address&address()constinlineconst : Get Address.

Address&address()inline : Get Address.

Subnet&set( Address&const value)inline : Set Address.

Mask&mask()constinlineconst : Get Mask.

Mask&mask()inline : Get Mask.

Subnet&set( Mask&const value)inline : Set Mask.

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

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

==operator( Subnet&const other)constbool : Equality operator.

!=operator( Subnet&const other)constbool : Inequality operator.

stdstringtoString()const:: : Get the value as string.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypegroupstaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Network/LocalInterface/IPV4/Subnet": The full path for this value.

name={}staticconstexprconstchar* "Subnet": The name of this value.

static constexpr const char * description {R"description(An IPv4 subnet that the localnetworkinterface is connected to.)description"}: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, Subnet&const value)inlinefriend:: : Operator to send the value as string to a stream.

Addressclass

IP address of the computer's local network interface.

Public Types

ValueType=stdstringusing ::: The type of the underlying value.

Public Functions

Address()=default : Default constructor.

Address(stdstringvalue:: )inlineexplicit: Constructor.

stdstring&value()constconst:: : Get the value.

stdstringtoString()const:: : Get the value as string.

==operator( Address&const other)constinlinebool : Comparison operator.

!=operator( Address&const other)constinlinebool : Comparison operator.

<operator( Address&const other)constinlinebool : Comparison operator.

>operator( Address&const other)constinlinebool : Comparison operator.

<=operator( Address&const other)constinlinebool : Comparison operator.

>=operator( Address&const other)constinlinebool : Comparison operator.

Public Static Functions

Range ValueTypesize_type validSize()staticinlineconstexpr<::>: The valid sizes for Address.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Network/LocalInterface/IPV4/Subnet/Address": The full path for this value.

name={}staticconstexprconstchar* "Address": The name of this value.

static constexpr const char * description {R"description(IPaddress of the computer's local networkinterface.)description"}: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, Address&const value)inlinefriend:: : Operator to serialize the value to a stream.

Maskclass

Subnet mask of the computer's local network interface.

Public Types

ValueType=stdstringusing ::: The type of the underlying value.

Public Functions

Mask()=default : Default constructor.

Mask(stdstringvalue:: )inlineexplicit: Constructor.

stdstring&value()constconst:: : Get the value.

stdstringtoString()const:: : Get the value as string.

==operator( Mask&const other)constinlinebool : Comparison operator.

!=operator( Mask&const other)constinlinebool : Comparison operator.

<operator( Mask&const other)constinlinebool : Comparison operator.

>operator( Mask&const other)constinlinebool : Comparison operator.

<=operator( Mask&const other)constinlinebool : Comparison operator.

>=operator( Mask&const other)constinlinebool : Comparison operator.

Public Static Functions

Range ValueTypesize_type validSize()staticinlineconstexpr<::>: The valid sizes for Mask.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Network/LocalInterface/IPV4/Subnet/Mask": The full path for this value.

name={}staticconstexprconstchar* "Mask": The name of this value.

static constexpr const char * description {R"description(Subnet mask of the computer's local networkinterface.)description"}: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, Mask&const value)inlinefriend:: : Operator to serialize the value to a stream.

Subnetsclass

List of IPv4 addresses and subnet masks that the interface is configured with.

This list can contain multiple entries if the local network interface is configured with multiple IPv4 addresses.

Public Types

ValueType=stdvectorCameraState Network LocalInterface IPV4 Subnetusing ::<::::::::>: The type of the underlying value.

Iterator=stdvectorCameraState Network LocalInterface IPV4 Subnet::iteratorusing ::<::::::::>: Iterator type for Subnets.

ConstIterator=stdvectorCameraState Network LocalInterface IPV4 Subnet::const_iteratorusing ::<::::::::>: Constant iterator type for Subnets.

Public Functions

Subnets()=default : Default constructor.

Subnets(stdvectorCameraState Network LocalInterface IPV4 Subnet ::<::::::::>value)inlineexplicit: Constructor.

Subnets(stdinitializer_listCameraState Network LocalInterface IPV4 Subnet ::<::::::::>value)inlineexplicit: Constructor.

stdvectorCameraState Network LocalInterface IPV4 Subnet value()constconst::<::::::::>& : Get the value.

stdstringtoString()const:: : Get the value as string.

stdsize_tsize()constnoexcept:: : Get the size of the list.

isEmpty()constnoexceptbool : Check if the list is empty.

< Argstemplatetypename...> emplaceBack(Args& &...args)inlinevoid

Appends a new element to the end of the list.

The new element is constructed in-place. The provided arguments Args are forwarded to the constructor of CameraState::Network::LocalInterface::IPV4::Subnet. Invoking this method may invalidate all references to elements in the list.

CameraState Network LocalInterface IPV4 Subnet&at(stdsize_tpos:: ):::::::: 

Returns a reference to the element at position pos in the list.

This function checks that pos is within the bounds (from 0 to size - 1). If pos is not within bounds an exception is thrown.

CameraState Network LocalInterface IPV4 Subnet&at(stdsize_tpos:: )constconst:::::::: 

Returns a const reference to the element at position pos in the list.

This function checks that pos is within the bounds (from 0 to size - 1). If pos is not within bounds an exception is thrown.

CameraState Network LocalInterface IPV4 Subnet&[]operator(stdsize_tpos:: ):::::::: 

Returns a reference to the element at position pos in the list.

pos must be within the bounds (from 0 to size - 1). No bounds checking is performed. at(size_t) will check the bounds and throw an exception if pos it out of bounds.

CameraState Network LocalInterface IPV4 Subnet&[]operator(stdsize_tpos:: )constconst:::::::: 

Returns a const reference to the element at position pos in the list.

pos must be within the bounds (from 0 to size - 1). No bounds checking is performed. at(size_t) const will check the bounds and throw an exception if pos it out of bounds.

< Ftemplatetypename> forEach( F&const f)inlinevoid: Run the given function on each element in the list.

< Ftemplatetypename> forEach( F&const f)constinlinevoid : Run the given function on each element in the list.

Iteratorbegin()noexcept : Returns an iterator to the first element of the list.

Iteratorend()noexcept : Returns an iterator to the element following the last element of the list.

ConstIteratorbegin()constnoexcept : Returns a constant iterator to the first element of the list.

ConstIteratorend()constnoexcept : Returns a constant iterator to the element following the last element of the list.

ConstIteratorcbegin()constnoexcept : Returns a constant iterator to the first element of the list.

ConstIteratorcend()constnoexcept : Returns a constant iterator to the element following the last element of the list.

==operator( Subnets&const other)constinlinebool : Comparison operator.

!=operator( Subnets&const other)constinlinebool : Comparison operator.

Public Static Functions

Range ValueTypesize_type validSize()staticinlineconstexpr<::>: The valid sizes for Subnets.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafDataModelListstaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Network/LocalInterface/IPV4/Subnets": The full path for this value.

name={}staticconstexprconstchar* "Subnets": The name of this value.

static constexpr const char * description {R"description(List of IPv4 addresses and subnet masks that the interface is configured with. This list cancontain multiple entries if the localnetworkinterface is configured with multiple IPv4addresses.)description"}: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, Subnets&const value)inlinefriend:: : Operator to serialize the value to a stream.

LocalInterfacesclass

List of the computer's local network interfaces that discovered the camera.

In the most common scenario with the camera connected to the computer with an Ethernet cable, this list will contain only the network interface for that Ethernet port. In more complex network scenarios it can be the case that the camera is discovered by multiple interfaces, and in that case this list will contain multiple network interfaces. However, when CameraState::Status is connected, only the one network interface that has the active TCP/IP connection to the camera will be listed.

Public Types

ValueType=stdvectorCameraState Network LocalInterfaceusing ::<::::>: The type of the underlying value.

Iterator=stdvectorCameraState Network LocalInterface::iteratorusing ::<::::>: Iterator type for LocalInterfaces.

ConstIterator=stdvectorCameraState Network LocalInterface::const_iteratorusing ::<::::>: Constant iterator type for LocalInterfaces.

Public Functions

LocalInterfaces()=default : Default constructor.

LocalInterfaces(stdvectorCameraState Network LocalInterface ::<::::>value)inlineexplicit: Constructor.

LocalInterfaces(stdinitializer_listCameraState Network LocalInterface ::<::::>value)inlineexplicit: Constructor.

stdvectorCameraState Network LocalInterface value()constconst::<::::>& : Get the value.

stdstringtoString()const:: : Get the value as string.

stdsize_tsize()constnoexcept:: : Get the size of the list.

isEmpty()constnoexceptbool : Check if the list is empty.

< Argstemplatetypename...> emplaceBack(Args& &...args)inlinevoid

Appends a new element to the end of the list.

The new element is constructed in-place. The provided arguments Args are forwarded to the constructor of CameraState::Network::LocalInterface. Invoking this method may invalidate all references to elements in the list.

CameraState Network LocalInterface&at(stdsize_tpos:: ):::: 

Returns a reference to the element at position pos in the list.

This function checks that pos is within the bounds (from 0 to size - 1). If pos is not within bounds an exception is thrown.

CameraState Network LocalInterface&at(stdsize_tpos:: )constconst:::: 

Returns a const reference to the element at position pos in the list.

This function checks that pos is within the bounds (from 0 to size - 1). If pos is not within bounds an exception is thrown.

CameraState Network LocalInterface&[]operator(stdsize_tpos:: ):::: 

Returns a reference to the element at position pos in the list.

pos must be within the bounds (from 0 to size - 1). No bounds checking is performed. at(size_t) will check the bounds and throw an exception if pos it out of bounds.

CameraState Network LocalInterface&[]operator(stdsize_tpos:: )constconst:::: 

Returns a const reference to the element at position pos in the list.

pos must be within the bounds (from 0 to size - 1). No bounds checking is performed. at(size_t) const will check the bounds and throw an exception if pos it out of bounds.

< Ftemplatetypename> forEach( F&const f)inlinevoid: Run the given function on each element in the list.

< Ftemplatetypename> forEach( F&const f)constinlinevoid : Run the given function on each element in the list.

Iteratorbegin()noexcept : Returns an iterator to the first element of the list.

Iteratorend()noexcept : Returns an iterator to the element following the last element of the list.

ConstIteratorbegin()constnoexcept : Returns a constant iterator to the first element of the list.

ConstIteratorend()constnoexcept : Returns a constant iterator to the element following the last element of the list.

ConstIteratorcbegin()constnoexcept : Returns a constant iterator to the first element of the list.

ConstIteratorcend()constnoexcept : Returns a constant iterator to the element following the last element of the list.

==operator( LocalInterfaces&const other)constinlinebool : Comparison operator.

!=operator( LocalInterfaces&const other)constinlinebool : Comparison operator.

Public Static Functions

Range ValueTypesize_type validSize()staticinlineconstexpr<::>: The valid sizes for LocalInterfaces.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafDataModelListstaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Network/LocalInterfaces": The full path for this value.

name={}staticconstexprconstchar* "LocalInterfaces": The name of this value.

static constexpr const char * description {R"description(List of the computer's localnetworkinterfaces that discovered the camera. In the most common scenariowith the camera connected to the computer with anEthernet cable, this list will contain only the network interface for that Ethernet port. In more complex networkscenarios it can be the case that thecamera is discovered by multiple interfaces, and in that case this list will contain multiplenetwork interfaces. However, when `CameraState::Status` is `connected`, only the one networkinterface that hasthe active TCP/IP connection to the camera will be listed.)description"}: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, LocalInterfaces&const value)inlinefriend:: : Operator to serialize the value to a stream.

Statusclass

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.

Public Types

ValueTypeenumclass

The type of the underlying value.

Values:

inaccessibleenumerator

busyenumerator

applyingNetworkConfigurationenumerator

firmwareUpdateRequiredenumerator

updatingFirmwareenumerator

availableenumerator

connectingenumerator

connectedenumerator

disconnectingenumerator

disappearedenumerator

Public Functions

Status()=default : Default constructor.

Status(ValueTypevalue )inlineexplicitconstexpr: Constructor.

ValueTypevalue()const : Get the value.

stdstringtoString()const:: : Get the value as string.

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

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

Public Static Functions

stdsetValueType validValues()staticinline::<>: All valid values of Status.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Status": The full path for this value.

name={}staticconstexprconstchar* "Status": The name of this value.

descriptionstaticconstexprconstchar*: The description for this value.

Statusinaccessiblestaticconst : inaccessible

Statusbusystaticconst : busy

StatusapplyingNetworkConfigurationstaticconst : applyingNetworkConfiguration

StatusfirmwareUpdateRequiredstaticconst : firmwareUpdateRequired

StatusupdatingFirmwarestaticconst : updatingFirmware

Statusavailablestaticconst : available

Statusconnectingstaticconst : connecting

Statusconnectedstaticconst : connected

Statusdisconnectingstaticconst : disconnecting

Statusdisappearedstaticconst : disappeared

Friends

stdostream&<<operator(stdostream&:: stream, Status ValueType&const:: value)inlinefriend:: : Operator to serialize ValueType to a stream.

stdostream&<<operator(stdostream&:: stream, Status&const value)inlinefriend:: : Operator to serialize the value to a stream.

Temperatureclass

Current temperature(s)

Public Functions

Temperature(): Default constructor.

< Argstemplatetypename...> Temperature(Args& &...args)inlineexplicit

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:

CameraState::Temperature::DMD
CameraState::Temperature::General
CameraState::Temperature::LED
CameraState::Temperature::Lens
CameraState::Temperature::PCB

< Argstemplatetypename...> set(Args& &...args)inlinevoid

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:

CameraState::Temperature::DMD
CameraState::Temperature::General
CameraState::Temperature::LED
CameraState::Temperature::Lens
CameraState::Temperature::PCB

< Argstemplatetypename...> TemperaturecopyWith(Args& &...args)constinline 

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:

CameraState::Temperature::DMD
CameraState::Temperature::General
CameraState::Temperature::LED
CameraState::Temperature::Lens
CameraState::Temperature::PCB

DMD&dmd()constinlineconst : Get DMD.

DMD&dmd()inline : Get DMD.

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

General&general()constinlineconst : Get General.

General&general()inline : Get General.

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

LED&led()constinlineconst : Get LED.

LED&led()inline : Get LED.

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

Lens&lens()constinlineconst : Get Lens.

Lens&lens()inline : Get Lens.

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

PCB&pcb()constinlineconst : Get PCB.

PCB&pcb()inline : Get PCB.

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

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

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

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

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

stdstringtoString()const:: : Get the value as string.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypegroupstaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Temperature": The full path for this value.

name={}staticconstexprconstchar* "Temperature": The name of this value.

static constexpr const char * description = { R"description(Current temperature(s))description" }: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, Temperature&const value)inlinefriend:: : Operator to send the value as string to a stream.

DMDclass

DMD temperature.

Public Types

ValueType=doubleusing : The type of the underlying value.

Public Functions

DMD()=default : Default constructor.

DMD( doublevalue)inlineexplicitconstexpr: Constructor.

value()constdouble : Get the value.

stdstringtoString()const:: : Get the value as string.

==operator( DMD&const other)constinlinebool : Comparison operator.

!=operator( DMD&const other)constinlinebool : Comparison operator.

<operator( DMD&const other)constinlinebool : Comparison operator.

>operator( DMD&const other)constinlinebool : Comparison operator.

<=operator( DMD&const other)constinlinebool : Comparison operator.

>=operator( DMD&const other)constinlinebool : Comparison operator.

Public Static Functions

Rangedouble validRange()staticinlineconstexpr<>: The range of valid values for DMD.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Temperature/DMD": The full path for this value.

name={}staticconstexprconstchar* "DMD": The name of this value.

static constexpr const char * description = { R"description(DMD temperature)description" }: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, DMD&const value)inlinefriend:: : Operator to serialize the value to a stream.

Generalclass

General temperature.

Public Types

ValueType=doubleusing : The type of the underlying value.

Public Functions

General()=default : Default constructor.

General( doublevalue)inlineexplicitconstexpr: Constructor.

value()constdouble : Get the value.

stdstringtoString()const:: : Get the value as string.

==operator( General&const other)constinlinebool : Comparison operator.

!=operator( General&const other)constinlinebool : Comparison operator.

<operator( General&const other)constinlinebool : Comparison operator.

>operator( General&const other)constinlinebool : Comparison operator.

<=operator( General&const other)constinlinebool : Comparison operator.

>=operator( General&const other)constinlinebool : Comparison operator.

Public Static Functions

Rangedouble validRange()staticinlineconstexpr<>: The range of valid values for General.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Temperature/General": The full path for this value.

name={}staticconstexprconstchar* "General": The name of this value.

static constexpr const char * description = { R"description(General temperature)description" }: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, General&const value)inlinefriend:: : Operator to serialize the value to a stream.

LEDclass

LED temperature.

Public Types

ValueType=doubleusing : The type of the underlying value.

Public Functions

LED()=default : Default constructor.

LED( doublevalue)inlineexplicitconstexpr: Constructor.

value()constdouble : Get the value.

stdstringtoString()const:: : Get the value as string.

==operator( LED&const other)constinlinebool : Comparison operator.

!=operator( LED&const other)constinlinebool : Comparison operator.

<operator( LED&const other)constinlinebool : Comparison operator.

>operator( LED&const other)constinlinebool : Comparison operator.

<=operator( LED&const other)constinlinebool : Comparison operator.

>=operator( LED&const other)constinlinebool : Comparison operator.

Public Static Functions

Rangedouble validRange()staticinlineconstexpr<>: The range of valid values for LED.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Temperature/LED": The full path for this value.

name={}staticconstexprconstchar* "LED": The name of this value.

static constexpr const char * description = { R"description(LED temperature)description" }: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, LED&const value)inlinefriend:: : Operator to serialize the value to a stream.

Lensclass

Lens temperature.

Public Types

ValueType=doubleusing : The type of the underlying value.

Public Functions

Lens()=default : Default constructor.

Lens( doublevalue)inlineexplicitconstexpr: Constructor.

value()constdouble : Get the value.

stdstringtoString()const:: : Get the value as string.

==operator( Lens&const other)constinlinebool : Comparison operator.

!=operator( Lens&const other)constinlinebool : Comparison operator.

<operator( Lens&const other)constinlinebool : Comparison operator.

>operator( Lens&const other)constinlinebool : Comparison operator.

<=operator( Lens&const other)constinlinebool : Comparison operator.

>=operator( Lens&const other)constinlinebool : Comparison operator.

Public Static Functions

Rangedouble validRange()staticinlineconstexpr<>: The range of valid values for Lens.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Temperature/Lens": The full path for this value.

name={}staticconstexprconstchar* "Lens": The name of this value.

static constexpr const char * description = { R"description(Lens temperature)description" }: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, Lens&const value)inlinefriend:: : Operator to serialize the value to a stream.

PCBclass

PCB temperature.

Public Types

ValueType=doubleusing : The type of the underlying value.

Public Functions

PCB()=default : Default constructor.

PCB( doublevalue)inlineexplicitconstexpr: Constructor.

value()constdouble : Get the value.

stdstringtoString()const:: : Get the value as string.

==operator( PCB&const other)constinlinebool : Comparison operator.

!=operator( PCB&const other)constinlinebool : Comparison operator.

<operator( PCB&const other)constinlinebool : Comparison operator.

>operator( PCB&const other)constinlinebool : Comparison operator.

<=operator( PCB&const other)constinlinebool : Comparison operator.

>=operator( PCB&const other)constinlinebool : Comparison operator.

Public Static Functions

Rangedouble validRange()staticinlineconstexpr<>: The range of valid values for PCB.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::: The type of this node.

path={}staticconstexprconstchar* "Temperature/PCB": The full path for this value.

name={}staticconstexprconstchar* "PCB": The name of this value.

static constexpr const char * description = { R"description(PCB temperature)description" }: The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, PCB&const value)inlinefriend:: : Operator to serialize the value to a stream.

C#

CameraStatestruct

Information about camera connection state, temperatures, etc.

Public Types

InaccessibleReasonOption:stdunderlying_typeZividCameraState InaccessibleReason ValueType::typeenumclass ::<::::::>

If the camera status is inaccessible, then this enum value will give you the reason.

Values:

IpConflictWithAnotherCameraenumerator

IpConflictWithLocalNetworkAdapterenumerator

IpNotInLocalSubnetenumerator

IpInMultipleLocalSubnetsenumerator

StatusOption:stdunderlying_typeZividCameraState Status ValueType::typeenumclass ::<::::::>

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.

Values:

Inaccessibleenumerator

Busyenumerator

ApplyingNetworkConfigurationenumerator

FirmwareUpdateRequiredenumerator

UpdatingFirmwareenumerator

Availableenumerator

Connectingenumerator

Connectedenumerator

Disconnectingenumerator

Disappearedenumerator

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.

CameraState()inline: Constructor.

CameraState ^ 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.

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

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

Properties

Availablebool

Flag if camera is physically connected to the computer and is available for use, but not connected in software.

This corresponds to the Status enums available or firmwareUpdateRequired. Zivid recommends to use the Status enum instead of this bool.

Connectedbool

Flag if camera is connected in software.

This bool is true when the Status value is connected. Zivid recommends to use the Status enum instead of this bool.

SystemNullableInaccessibleReasonOption InaccessibleReason::<>: If the camera status is inaccessible, then this enum value will give you the reason.

StatusOptionStatus 

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.

Public Static Attributes

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

Construct CameraState by loading from file.

Construct a new CameraState instance from a previously serialized string