Zivid C++ API 2.18.0+1b44dbef-1
Zivid::CameraExtrinsics::Tw::X Class Reference

X component of the translation vector. More...

#include <Zivid/CameraExtrinsics.h>

Public Types

using ValueType = double
 The type of the underlying value.

Public Member Functions

 X ()=default
 Default constructor.
constexpr X (double value)
 Constructor.
double value () const
 Get the value.
std::string toString () const
 Get the value as string.
bool operator== (const X &other) const
 Comparison operator.
bool operator!= (const X &other) const
 Comparison operator.
bool operator< (const X &other) const
 Comparison operator.
bool operator> (const X &other) const
 Comparison operator.
bool operator<= (const X &other) const
 Comparison operator.
bool operator>= (const X &other) const
 Comparison operator.

Static Public Member Functions

static constexpr Range< double > validRange ()
 The range of valid values for X.

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node.
static constexpr const char * path { "Tw/X" }
 The full path for this value.
static constexpr const char * name { "X" }
 The name of this value.
static constexpr const char * description
 The description for this value.

Friends

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

Detailed Description

X component of the translation vector.

Member Typedef Documentation

◆ ValueType

The type of the underlying value.

Constructor & Destructor Documentation

◆ X() [1/2]

Zivid::CameraExtrinsics::Tw::X::X ( )
default

Default constructor.

◆ X() [2/2]

Zivid::CameraExtrinsics::Tw::X::X ( double value)
inlineexplicitconstexpr

Constructor.

Member Function Documentation

◆ operator!=()

bool Zivid::CameraExtrinsics::Tw::X::operator!= ( const X & other) const
inline

Comparison operator.

◆ operator<()

bool Zivid::CameraExtrinsics::Tw::X::operator< ( const X & other) const
inline

Comparison operator.

◆ operator<=()

bool Zivid::CameraExtrinsics::Tw::X::operator<= ( const X & other) const
inline

Comparison operator.

◆ operator==()

bool Zivid::CameraExtrinsics::Tw::X::operator== ( const X & other) const
inline

Comparison operator.

◆ operator>()

bool Zivid::CameraExtrinsics::Tw::X::operator> ( const X & other) const
inline

Comparison operator.

◆ operator>=()

bool Zivid::CameraExtrinsics::Tw::X::operator>= ( const X & other) const
inline

Comparison operator.

◆ toString()

std::string Zivid::CameraExtrinsics::Tw::X::toString ( ) const

Get the value as string.

◆ validRange()

constexpr Range< double > Zivid::CameraExtrinsics::Tw::X::validRange ( )
inlinestaticconstexpr

The range of valid values for X.

◆ value()

double Zivid::CameraExtrinsics::Tw::X::value ( ) const

Get the value.

◆ DataModel::Detail::Befriend< X >

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

◆ operator<<

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

Operator to serialize the value to a stream.

Member Data Documentation

◆ description

const char* Zivid::CameraExtrinsics::Tw::X::description
staticconstexpr
Initial value:
{
R"description(X component of the translation vector)description"
}

The description for this value.

◆ name

const char* Zivid::CameraExtrinsics::Tw::X::name { "X" }
staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::CameraExtrinsics::Tw::X::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node.

◆ path

const char* Zivid::CameraExtrinsics::Tw::X::path { "Tw/X" }
staticconstexpr

The full path for this value.


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