Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::FrameInfo::TimeStamp Class Reference

The time of frame capture More...

#include <Zivid/FrameInfo.h>

Public Types

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

Public Member Functions

 TimeStamp ()=default
 Default constructor More...
 
constexpr TimeStamp (std::chrono::system_clock::time_point value)
 Constructor More...
 
std::chrono::system_clock::time_point value () const
 Get the value More...
 
std::string toString () const
 Get the value as string More...
 
bool operator== (const TimeStamp &other) const
 Comparison operator More...
 
bool operator!= (const TimeStamp &other) const
 Comparison operator More...
 
bool operator< (const TimeStamp &other) const
 Comparison operator More...
 
bool operator> (const TimeStamp &other) const
 Comparison operator More...
 
bool operator<= (const TimeStamp &other) const
 Comparison operator More...
 
bool operator>= (const TimeStamp &other) const
 Comparison operator More...
 

Static Public Member Functions

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

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node More...
 
static constexpr const char * path { "TimeStamp" }
 The full path for this value More...
 
static constexpr const char * name { "TimeStamp" }
 The name of this value More...
 
static constexpr const char * description { R"description(The time of frame capture)description" }
 The description for this value More...
 

Friends

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

Detailed Description

The time of frame capture

Member Typedef Documentation

◆ ValueType

using Zivid::FrameInfo::TimeStamp::ValueType = std::chrono::system_clock::time_point

The type of the underlying value

Constructor & Destructor Documentation

◆ TimeStamp() [1/2]

Zivid::FrameInfo::TimeStamp::TimeStamp ( )
default

Default constructor

◆ TimeStamp() [2/2]

constexpr Zivid::FrameInfo::TimeStamp::TimeStamp ( std::chrono::system_clock::time_point  value)
inlineexplicitconstexpr

Constructor

Member Function Documentation

◆ operator!=()

bool Zivid::FrameInfo::TimeStamp::operator!= ( const TimeStamp other) const
inline

Comparison operator

◆ operator<()

bool Zivid::FrameInfo::TimeStamp::operator< ( const TimeStamp other) const
inline

Comparison operator

◆ operator<=()

bool Zivid::FrameInfo::TimeStamp::operator<= ( const TimeStamp other) const
inline

Comparison operator

◆ operator==()

bool Zivid::FrameInfo::TimeStamp::operator== ( const TimeStamp other) const
inline

Comparison operator

◆ operator>()

bool Zivid::FrameInfo::TimeStamp::operator> ( const TimeStamp other) const
inline

Comparison operator

◆ operator>=()

bool Zivid::FrameInfo::TimeStamp::operator>= ( const TimeStamp other) const
inline

Comparison operator

◆ toString()

std::string Zivid::FrameInfo::TimeStamp::toString ( ) const

Get the value as string

◆ validRange()

static constexpr Range< std::chrono::system_clock::time_point > Zivid::FrameInfo::TimeStamp::validRange ( )
inlinestaticconstexpr

The range of valid values for TimeStamp

◆ value()

std::chrono::system_clock::time_point Zivid::FrameInfo::TimeStamp::value ( ) const

Get the value

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< TimeStamp >

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

◆ operator<<

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

Operator to serialize the value to a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::FrameInfo::TimeStamp::description { R"description(The time of frame capture)description" }
staticconstexpr

The description for this value

◆ name

constexpr const char* Zivid::FrameInfo::TimeStamp::name { "TimeStamp" }
staticconstexpr

The name of this value

◆ nodeType

constexpr DataModel::NodeType Zivid::FrameInfo::TimeStamp::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node

◆ path

constexpr const char* Zivid::FrameInfo::TimeStamp::path { "TimeStamp" }
staticconstexpr

The full path for this value


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