Zivid C++ API  1.8.1+6967bc1b-1
Defining the Future of 3D Machine Vision
Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::FrameInfo::SoftwareVersion::ZividStudio::FileVersion Class Reference

File version More...

#include <Zivid/FrameInfo.h>

Public Types

using ValueType = std::string
 The type of the underlying value More...
 

Public Member Functions

 FileVersion ()=default
 Default constructor More...
 
 FileVersion (ValueType value) noexcept(std::is_nothrow_move_constructible< ValueType >::value)
 Constructor More...
 
const ValueTypevalue () const
 Get the value More...
 
void setFromString (const std::string &value)
 Set the value from string More...
 
std::string toString () const
 Get the value as string More...
 
bool operator== (const FileVersion &other) const
 Comparison operator More...
 
bool operator!= (const FileVersion &other) const
 Comparison operator More...
 
bool operator< (const FileVersion &other) const
 Comparison operator More...
 
bool operator> (const FileVersion &other) const
 Comparison operator More...
 

Static Public Attributes

static constexpr bool isContainer { false }
 Check if it contains child members More...
 
static constexpr const char * path { "SoftwareVersion/ZividStudio/FileVersion" }
 The full path for this value More...
 
static constexpr const char * name { "FileVersion" }
 The name of this value More...
 
static constexpr const char * description { R"description(File version)description" }
 The description for this value More...
 

Friends

std::ostream & operator<< (std::ostream &stream, const FileVersion &value)
 Operator to serialize the value to a stream More...
 
std::istream & operator>> (std::istream &stream, FileVersion &value)
 Operator to set the value from a stream More...
 

Detailed Description

File version

Member Typedef Documentation

◆ ValueType

The type of the underlying value

Constructor & Destructor Documentation

◆ FileVersion() [1/2]

Zivid::FrameInfo::SoftwareVersion::ZividStudio::FileVersion::FileVersion ( )
default

Default constructor

◆ FileVersion() [2/2]

Zivid::FrameInfo::SoftwareVersion::ZividStudio::FileVersion::FileVersion ( ValueType  value)
inlineexplicitnoexcept

Constructor

Member Function Documentation

◆ operator!=()

bool Zivid::FrameInfo::SoftwareVersion::ZividStudio::FileVersion::operator!= ( const FileVersion other) const
inline

Comparison operator

◆ operator<()

bool Zivid::FrameInfo::SoftwareVersion::ZividStudio::FileVersion::operator< ( const FileVersion other) const
inline

Comparison operator

◆ operator==()

bool Zivid::FrameInfo::SoftwareVersion::ZividStudio::FileVersion::operator== ( const FileVersion other) const
inline

Comparison operator

◆ operator>()

bool Zivid::FrameInfo::SoftwareVersion::ZividStudio::FileVersion::operator> ( const FileVersion other) const
inline

Comparison operator

◆ setFromString()

void Zivid::FrameInfo::SoftwareVersion::ZividStudio::FileVersion::setFromString ( const std::string &  value)
inline

Set the value from string

◆ toString()

std::string Zivid::FrameInfo::SoftwareVersion::ZividStudio::FileVersion::toString ( ) const
inline

Get the value as string

◆ value()

const ValueType& Zivid::FrameInfo::SoftwareVersion::ZividStudio::FileVersion::value ( ) const
inline

Get the value

Friends And Related Function Documentation

◆ operator<<

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

Operator to serialize the value to a stream

◆ operator>>

std::istream& operator>> ( std::istream &  stream,
FileVersion value 
)
friend

Operator to set the value from a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::FrameInfo::SoftwareVersion::ZividStudio::FileVersion::description { R"description(File version)description" }
staticconstexpr

The description for this value

◆ isContainer

constexpr bool Zivid::FrameInfo::SoftwareVersion::ZividStudio::FileVersion::isContainer { false }
staticconstexpr

Check if it contains child members

◆ name

constexpr const char* Zivid::FrameInfo::SoftwareVersion::ZividStudio::FileVersion::name { "FileVersion" }
staticconstexpr

The name of this value

◆ path

constexpr const char* Zivid::FrameInfo::SoftwareVersion::ZividStudio::FileVersion::path { "SoftwareVersion/ZividStudio/FileVersion" }
staticconstexpr

The full path for this value


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