This field contains the actual frequency unless the classification is noFlicker
or unknownFlicker
.
More...
#include <Zivid/SceneConditions.h>
|
using | ValueType = double |
| The type of the underlying value.
|
|
This field contains the actual frequency unless the classification is noFlicker
or unknownFlicker
.
◆ ValueType
The type of the underlying value.
◆ FlickerFrequency() [1/2]
Zivid::SceneConditions::AmbientLight::FlickerFrequency::FlickerFrequency |
( |
| ) |
|
|
default |
◆ FlickerFrequency() [2/2]
Zivid::SceneConditions::AmbientLight::FlickerFrequency::FlickerFrequency |
( |
double | value | ) |
|
|
inlineexplicitconstexpr |
◆ hasValue()
bool Zivid::SceneConditions::AmbientLight::FlickerFrequency::hasValue |
( |
| ) |
const |
Check if the value is set.
◆ operator!=()
bool Zivid::SceneConditions::AmbientLight::FlickerFrequency::operator!= |
( |
const FlickerFrequency & | other | ) |
const |
|
inline |
◆ operator<()
bool Zivid::SceneConditions::AmbientLight::FlickerFrequency::operator< |
( |
const FlickerFrequency & | other | ) |
const |
|
inline |
◆ operator<=()
bool Zivid::SceneConditions::AmbientLight::FlickerFrequency::operator<= |
( |
const FlickerFrequency & | other | ) |
const |
|
inline |
◆ operator==()
bool Zivid::SceneConditions::AmbientLight::FlickerFrequency::operator== |
( |
const FlickerFrequency & | other | ) |
const |
|
inline |
◆ operator>()
bool Zivid::SceneConditions::AmbientLight::FlickerFrequency::operator> |
( |
const FlickerFrequency & | other | ) |
const |
|
inline |
◆ operator>=()
bool Zivid::SceneConditions::AmbientLight::FlickerFrequency::operator>= |
( |
const FlickerFrequency & | other | ) |
const |
|
inline |
◆ reset()
void Zivid::SceneConditions::AmbientLight::FlickerFrequency::reset |
( |
| ) |
|
Reset the node to unset state.
◆ toString()
std::string Zivid::SceneConditions::AmbientLight::FlickerFrequency::toString |
( |
| ) |
const |
◆ validRange()
static constexpr Range< double > Zivid::SceneConditions::AmbientLight::FlickerFrequency::validRange |
( |
| ) |
|
|
inlinestaticconstexpr |
◆ value()
double Zivid::SceneConditions::AmbientLight::FlickerFrequency::value |
( |
| ) |
const |
Get the value.
If this object does not contain a value (see hasValue) then this method throws an exception.
◆ DataModel::Detail::Befriend< FlickerFrequency >
◆ operator<<
std::ostream & operator<< |
( |
std::ostream & | stream, |
|
|
const FlickerFrequency & | value ) |
|
friend |
Operator to serialize the value to a stream.
◆ description
const char* Zivid::SceneConditions::AmbientLight::FlickerFrequency::description |
|
staticconstexpr |
Initial value:{
R"description(This field contains the actual frequency unless the
classification is `noFlicker` or `unknownFlicker`.
)description"
}
The description for this value.
◆ name
const char* Zivid::SceneConditions::AmbientLight::FlickerFrequency::name { "FlickerFrequency" } |
|
staticconstexpr |
◆ nodeType
◆ path
const char* Zivid::SceneConditions::AmbientLight::FlickerFrequency::path { "AmbientLight/FlickerFrequency" } |
|
staticconstexpr |
The full path for this value.
The documentation for this class was generated from the following file: