Zivid::FrameInfo::SoftwareVersion::ZividStudio::Comments Class Reference

Comments More...

#include <Zivid/FrameInfo.h>

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

Public Member Functions
	Comments ()=default
	Default constructor More...
	Comments (ValueType value) noexcept(std::is_nothrow_move_constructible< ValueType >::value)
	Constructor More...
const ValueType &	value () 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 Comments &other) const
	Comparison operator More...
bool	operator!= (const Comments &other) const
	Comparison operator More...
bool	operator< (const Comments &other) const
	Comparison operator More...
bool	operator> (const Comments &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/Comments" }
	The full path for this value More...
static constexpr const char *	name { "Comments" }
	The name of this value More...
static constexpr const char *	description { R"description(Comments)description" }
	The description for this value More...

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

Detailed Description

Comments

Member Typedef Documentation

ValueType

using Zivid::FrameInfo::SoftwareVersion::ZividStudio::Comments::ValueType = std::string

The type of the underlying value

Constructor & Destructor Documentation

Comments() [1/2]

Zivid::FrameInfo::SoftwareVersion::ZividStudio::Comments::Comments ( )

default

Default constructor

Comments() [2/2]

Zivid::FrameInfo::SoftwareVersion::ZividStudio::Comments::Comments ( ValueType  value )

inlineexplicitnoexcept

Constructor

Member Function Documentation

operator!=()

bool Zivid::FrameInfo::SoftwareVersion::ZividStudio::Comments::operator!= ( const Comments &  other ) const

inline

Comparison operator

operator<()

bool Zivid::FrameInfo::SoftwareVersion::ZividStudio::Comments::operator< ( const Comments &  other ) const

inline

Comparison operator

operator==()

bool Zivid::FrameInfo::SoftwareVersion::ZividStudio::Comments::operator== ( const Comments &  other ) const

inline

Comparison operator

operator>()

bool Zivid::FrameInfo::SoftwareVersion::ZividStudio::Comments::operator> ( const Comments &  other ) const

inline

Comparison operator

setFromString()

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

inline

Set the value from string

toString()

std::string Zivid::FrameInfo::SoftwareVersion::ZividStudio::Comments::toString ( ) const

inline

Get the value as string

value()

const ValueType& Zivid::FrameInfo::SoftwareVersion::ZividStudio::Comments::value ( ) const

inline

Get the value

Friends And Related Function Documentation

operator<<

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

friend

Operator to serialize the value to a stream

operator>>

std::istream& operator>> ( std::istream &  stream, Comments &  value  )

friend

Operator to set the value from a stream

Member Data Documentation

description

constexpr const char* Zivid::FrameInfo::SoftwareVersion::ZividStudio::Comments::description { R"description(Comments)description" }

staticconstexpr

The description for this value

isContainer

constexpr bool Zivid::FrameInfo::SoftwareVersion::ZividStudio::Comments::isContainer { false }

staticconstexpr

Check if it contains child members

name

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

staticconstexpr

The name of this value

path

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

staticconstexpr

The full path for this value

---

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

• Zivid/FrameInfo.h