CameraInfo

关于已连接相机的只读元数据（型号、序列号、固件版本等）。

C++

CameraInfoclass

Information about camera model, serial number etc.

Public Functions

CameraInfo(): Default constructor.

CameraInfo( stdstring&const:: fileName)explicit: Construct CameraInfo 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...> CameraInfo(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 CameraInfo then invoking set(args).

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

CameraInfo::FirmwareVersion
CameraInfo::HardwareRevision
CameraInfo::Model
CameraInfo::ModelName
CameraInfo::Revision
CameraInfo::Revision::Major
CameraInfo::Revision::Minor
CameraInfo::SerialNumber
CameraInfo::UserData
CameraInfo::UserData::MaxSizeBytes

< 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 CameraInfo. These types can be provided:

CameraInfo::FirmwareVersion
CameraInfo::HardwareRevision
CameraInfo::Model
CameraInfo::ModelName
CameraInfo::Revision
CameraInfo::Revision::Major
CameraInfo::Revision::Minor
CameraInfo::SerialNumber
CameraInfo::UserData
CameraInfo::UserData::MaxSizeBytes

< Argstemplatetypename...> CameraInfocopyWith(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 CameraInfo 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 CameraInfo. These types can be provided:

CameraInfo::FirmwareVersion
CameraInfo::HardwareRevision
CameraInfo::Model
CameraInfo::ModelName
CameraInfo::Revision
CameraInfo::Revision::Major
CameraInfo::Revision::Minor
CameraInfo::SerialNumber
CameraInfo::UserData
CameraInfo::UserData::MaxSizeBytes

FirmwareVersion&firmwareVersion()constinlineconst : Get FirmwareVersion.

FirmwareVersion&firmwareVersion()inline : Get FirmwareVersion.

CameraInfo&set( FirmwareVersion&const value)inline : Set FirmwareVersion.

HardwareRevision&hardwareRevision()constinlineconst : Get HardwareRevision.

HardwareRevision&hardwareRevision()inline : Get HardwareRevision.

CameraInfo&set( HardwareRevision&const value)inline : Set HardwareRevision.

Model&model()constinlineconst : Get Model.

Model&model()inline : Get Model.

CameraInfo&set( Model&const value)inline : Set Model.

ModelName&modelName()constinlineconst : Get ModelName.

ModelName&modelName()inline : Get ModelName.

CameraInfo&set( ModelName&const value)inline : Set ModelName.

Revision&revision()constinlineconst : Get Revision.

Revision&revision()inline : Get Revision.

CameraInfo&set( Revision&const value)inline : Set Revision.

CameraInfo&set( Revision Major&const:: value)inline : Set Revision::Major.

CameraInfo&set( Revision Minor&const:: value)inline : Set Revision::Minor.

SerialNumber&serialNumber()constinlineconst : Get SerialNumber.

SerialNumber&serialNumber()inline : Get SerialNumber.

CameraInfo&set( SerialNumber&const value)inline : Set SerialNumber.

UserData&userData()constinlineconst : Get UserData.

UserData&userData()inline : Get UserData.

CameraInfo&set( UserData&const value)inline : Set UserData.

CameraInfo&set( UserData MaxSizeBytes&const:: value)inline : Set UserData::MaxSizeBytes.

< 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( CameraInfo&const other)constbool : Equality operator.

!=operator( CameraInfo&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

CameraInfofromSerialized( stdstring&const:: value)static 

Construct a new CameraInfo 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* "CameraInfo": The name of this value.

static constexpr const char * description {R"description(Information about cameramodel, serial number etc.)description"}: The description for this value.

Friends

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

FirmwareVersionclass

The firmware version on the camera.

Public Types

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

Public Functions

FirmwareVersion()=default : Default constructor.

FirmwareVersion(stdstringvalue:: )inlineexplicit: Constructor.

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

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

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

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

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

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

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

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

Public Static Functions

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

Public Static Attributes

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

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

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

static constexpr const char * description = { R"description(The firmware version on the camera)description" }: The description for this value.

Friends

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

HardwareRevisionclass

Hardware revision of this camera.

This corresponds to the revision string that is printed on the product label.

Public Types

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

Public Functions

HardwareRevision()=default : Default constructor.

HardwareRevision(stdstringvalue:: )inlineexplicit: Constructor.

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

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

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

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

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

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

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

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

Public Static Functions

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

Public Static Attributes

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

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

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

static constexpr const char * description {R"description(Hardwarerevision of this camera. This corresponds to the revisionstring that is printed on the productlabel.)description"}: The description for this value.

Friends

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

Modelclass

The model of the camera.

Public Types

ValueTypeenumclass

The type of the underlying value.

Values:

zividOnePlusSmallenumerator

zividOnePlusMediumenumerator

zividOnePlusLargeenumerator

zividTwoenumerator

zividTwoL100enumerator

zivid2PlusM130enumerator

zivid2PlusM60enumerator

zivid2PlusL110enumerator

zivid2PlusMR130enumerator

zivid2PlusMR60enumerator

zivid2PlusLR110enumerator

zivid3XL250enumerator

Public Functions

Model()=default : Default constructor.

Model(ValueTypevalue )inlineexplicitconstexpr: Constructor.

ValueTypevalue()const : Get the value.

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

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

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

Public Static Functions

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

Public Static Attributes

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

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

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

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

ModelzividOnePlusSmallstaticconst : zividOnePlusSmall

ModelzividOnePlusMediumstaticconst : zividOnePlusMedium

ModelzividOnePlusLargestaticconst : zividOnePlusLarge

ModelzividTwostaticconst : zividTwo

ModelzividTwoL100staticconst : zividTwoL100

Modelzivid2PlusM130staticconst : zivid2PlusM130

Modelzivid2PlusM60staticconst : zivid2PlusM60

Modelzivid2PlusL110staticconst : zivid2PlusL110

Modelzivid2PlusMR130staticconst : zivid2PlusMR130

Modelzivid2PlusMR60staticconst : zivid2PlusMR60

Modelzivid2PlusLR110staticconst : zivid2PlusLR110

Modelzivid3XL250staticconst : zivid3XL250

Friends

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

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

ModelNameclass

The model name of the camera.

This is a user-friendly display name that may contain spaces and special characters. We recommend to use Model instead if you want to programmatically check for camera model.

Public Types

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

Public Functions

ModelName()=default : Default constructor.

ModelName(stdstringvalue:: )inlineexplicit: Constructor.

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

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

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

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

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

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

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

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

Public Static Functions

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

Public Static Attributes

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

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

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

static constexpr const char * description {R"description(Themodel name of the camera. This is a user-friendly display namethat may contain spaces and specialcharacters. We recommend to use `Model` instead if you want to programmatically check for camera model.)description"}: The description for this value.

Friends

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

Revisionclass

Major/Minor hardware revision number.

This field is deprecated and may be removed in a future version of the SDK. Please use HardwareRevision instead.

Public Functions

Revision(): Default constructor.

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

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

CameraInfo::Revision::Major
CameraInfo::Revision::Minor

< 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 Revision. These types can be provided:

CameraInfo::Revision::Major
CameraInfo::Revision::Minor

< Argstemplatetypename...> RevisioncopyWith(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 Revision 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 Revision. These types can be provided:

CameraInfo::Revision::Major
CameraInfo::Revision::Minor

Major&major()constinlineconst : Get Major.

Major&major()inline : Get Major.

Revision&set( Major&const value)inline : Set Major.

Minor&minor()constinlineconst : Get Minor.

Minor&minor()inline : Get Minor.

Revision&set( Minor&const value)inline : Set Minor.

< 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( Revision&const other)constbool : Equality operator.

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

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

Public Static Attributes

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

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

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

static constexpr const char * description {R"description(Major/Minor hardware revision number. This field is deprecated and may be removed in a future version of the SDK. Please use HardwareRevisioninstead.)description"}: The description for this value.

Friends

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

Majorclass

Major hardware revision number.

This field is deprecated and may be removed in a future version of the SDK. Please use HardwareRevision instead.

Public Types

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

Public Functions

Major()=default : Default constructor.

Major(uint32_tvalue )inlineexplicitconstexpr: Constructor.

uint32_tvalue()const : Get the value.

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

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

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

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

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

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

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

Public Static Functions

Rangeuint32_t validRange()staticinlineconstexpr<>: The range of valid values for Major.

Public Static Attributes

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

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

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

static constexpr const char * description {R"description(Major hardware revision number. This field is deprecated and may be removed in a future version of the SDK. Please use HardwareRevisioninstead.)description"}: The description for this value.

Friends

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

Minorclass

Minor hardware revision number.

This field is deprecated and may be removed in a future version of the SDK. Please use HardwareRevision instead.

Public Types

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

Public Functions

Minor()=default : Default constructor.

Minor(uint32_tvalue )inlineexplicitconstexpr: Constructor.

uint32_tvalue()const : Get the value.

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

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

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

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

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

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

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

Public Static Functions

Rangeuint32_t validRange()staticinlineconstexpr<>: The range of valid values for Minor.

Public Static Attributes

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

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

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

static constexpr const char * description {R"description(Minor hardware revision number. This field is deprecated and may be removed in a future version of the SDK. Please use HardwareRevisioninstead.)description"}: The description for this value.

Friends

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

SerialNumberclass

The serial number of the camera.

Public Types

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

Public Functions

SerialNumber()=default : Default constructor.

SerialNumber(stdstringvalue:: )inlineexplicit: Constructor.

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

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

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

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

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

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

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

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

Public Static Functions

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

Public Static Attributes

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

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

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

static constexpr const char * description = { R"description(The serial number of the camera)description" }: The description for this value.

Friends

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

UserDataclass

Information about user data capabilities of the camera.

Public Functions

UserData(): Default constructor.

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

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

CameraInfo::UserData::MaxSizeBytes

< 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 UserData. These types can be provided:

CameraInfo::UserData::MaxSizeBytes

< Argstemplatetypename...> UserDatacopyWith(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 UserData 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 UserData. These types can be provided:

CameraInfo::UserData::MaxSizeBytes

MaxSizeBytes&maxSizeBytes()constinlineconst : Get MaxSizeBytes.

MaxSizeBytes&maxSizeBytes()inline : Get MaxSizeBytes.

UserData&set( MaxSizeBytes&const value)inline : Set MaxSizeBytes.

< 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( UserData&const other)constbool : Equality operator.

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

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

Public Static Attributes

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

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

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

static constexpr const char * description {R"description(Information about user data capabilities of the camera)description"}: The description for this value.

Friends

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

MaxSizeBytesclass

The maximum number of bytes of user data that can be stored in the camera.

Public Types

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

Public Functions

MaxSizeBytes()=default : Default constructor.

MaxSizeBytes(uint64_tvalue )inlineexplicitconstexpr: Constructor.

uint64_tvalue()const : Get the value.

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

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

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

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

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

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

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

Public Static Functions

Rangeuint64_t validRange()staticinlineconstexpr<>: The range of valid values for MaxSizeBytes.

Public Static Attributes

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

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

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

static constexpr const char * description {R"description(The maximum number of bytes of user data that can be stored in the camera)description"}: The description for this value.

Friends

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

C#

CameraInfostruct

Information about camera model, serial number etc.

Public Types

ModelOption:stdunderlying_typeZividCameraInfo Model ValueType::typeenumclass ::<::::::>

The model of the camera.

Values:

ZividOnePlusSmallenumerator

ZividOnePlusMediumenumerator

ZividOnePlusLargeenumerator

ZividTwoenumerator

ZividTwoL100enumerator

Zivid2PlusM130enumerator

Zivid2PlusM60enumerator

Zivid2PlusL110enumerator

Zivid2PlusMR130enumerator

Zivid2PlusMR60enumerator

Zivid2PlusLR110enumerator

Zivid3XL250enumerator

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.

CameraInfo()inline: Constructor.

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

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

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

Properties

System::String^ FirmwareVersion: The firmware version on the camera.

System::String^ HardwareRevision

Hardware revision of this camera.

This corresponds to the revision string that is printed on the product label.

ModelOptionModel : The model of the camera.

System::String^ ModelName

The model name of the camera.

This is a user-friendly display name that may contain spaces and special characters. We recommend to use Model instead if you want to programmatically check for camera model.

System::String^ SerialNumber: The serial number of the camera.

Public Static Attributes

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

Construct CameraInfo by loading from file.

Construct a new CameraInfo instance from a previously serialized string