Face Engine SDK  5.17.0
A face detection, recognition and tracking engine.
fsdk::ISettingsProvider::Value Struct Reference

Configuration parameter value. More...

#include <ISettingsProvider.h>

List of all members.

Classes

union  Data
 Value data. More...

Public Types

enum  Type {
  Undefined, Int1, Int2, Int3,
  Int4, Float1, Float2, Float3,
  Float4, String
}
 Value type. More...

Public Member Functions

 Value () noexcept
 Initialize an empty value.
 Value (int x) noexcept
 Initialize an integer value.
 Value (int x, int y) noexcept
 Initialize a 2d integer value.
 Value (int x, int y, int z) noexcept
 Initialize a 3d integer value.
 Value (int x, int y, int z, int w) noexcept
 Initialize a 4d integer value.
 Value (float x) noexcept
 Initialize a float value.
 Value (float x, float y) noexcept
 Initialize a 2d float value.
 Value (float x, float y, float z) noexcept
 Initialize a 3d float value.
 Value (float x, float y, float z, float w) noexcept
 Initialize a 4d float value.
 Value (const char *string) noexcept
 Initialize a string value.
 Value (const Rect &rect) noexcept
 Initialize a rect value.
 Value (const Size &size) noexcept
 Initialize a size value.
 Value (const Point2f &point) noexcept
 Initialize a point value.
 Value (bool x) noexcept
 Initialize a bool value.
 operator bool () const noexcept
 Check if value type is not `Undefined`.
bool is (Type type) const noexcept
 Check if value type is of concrete type.
bool setString (const char *string) noexcept
 Set a string value.
bool getString (char *string) const noexcept
 Get a string value.
void setRect (const Rect &rect) noexcept
 Set a rect value.
bool getRect (Rect *rect) const noexcept
 Get a rect value.
void setSize (const Size &size) noexcept
 Set a size value.
bool getSize (Size *size) const noexcept
 Get a size value.
void setPoint2i (const Point2i &point) noexcept
 Set a Point2i value.
bool getPoint2i (Point2i *point) const noexcept
 Get a Point2i value.
void setPoint2f (const Point2f &point) noexcept
 Set a setPoint2f value.
bool getPoint2f (Point2f *point) const noexcept
 Get a Point2f value.
void setBool (bool x) noexcept
 Set a bool value.
bool getBool (bool *x) const noexcept
 Get a bool value.
void setInt (int x) noexcept
 Set an int value.
bool getInt (int *x) const noexcept
 Get an int value.
void setInt (int x, int y) noexcept
 Set a 2d int value.
bool getInt (int *x, int *y) const noexcept
 Get a 2d int value.
void setInt (int x, int y, int z) noexcept
 Set a 3d int value.
bool getInt (int *x, int *y, int *z) const noexcept
 Get a 3d int value.
void setInt (int x, int y, int z, int w) noexcept
 Set a 4d int value.
bool getInt (int *x, int *y, int *z, int *w) const noexcept
 Get a 4d int value.
void setFloat (float x) noexcept
 Set a float value.
bool getFloat (float *x) const noexcept
 Get a float value.
void setFloat (float x, float y) noexcept
 Set a 2d float value.
bool getFloat (float *x, float *y) const noexcept
 Get a 2d float value.
void setFloat (float x, float y, float z) noexcept
 Set a 3d float value.
bool getFloat (float *x, float *y, float *z) const noexcept
 Get a 3d float value.
void setFloat (float x, float y, float z, float w) noexcept
 Set a 4d float value.
bool getFloat (float *x, float *y, float *z, float *w) const noexcept
 Get a 4d float value.
float asFloat (float defaultValue=0.f) const noexcept
 Safely get a float.
Point2f asPoint2f (const Point2f &defaultValue=Point2f()) const noexcept
 Safely get a Point2f.
bool asBool (bool defaultValue=false) const noexcept
 Safely get a boolean.
int asInt (int defaultValue=0) const noexcept
 Safely get an integer.
Size asSize (const Size &defaultValue=Size()) const noexcept
 Safely get a Size.
Point2i asPoint2i (const Point2i &defaultValue=Point2i()) const noexcept
 Safely get a Point2i.
Rect asRect (const Rect &defaultValue=Rect()) const noexcept
 Safely get a Rect.
const char * asString (const char *defaultValue="") const noexcept
 Safely get a string.
 Value (const Value &other)
 Value (Value &&other)
Valueoperator= (const Value &other)
Valueoperator= (Value &&other)
void swap (Value &first, Value &second)

Public Attributes

union
fsdk::ISettingsProvider::Value::Data 
m_data
 Data storage.
enum
fsdk::ISettingsProvider::Value::Type 
m_type
 Data type..

Detailed Description

Configuration parameter value.


Member Enumeration Documentation

Value type.

Enumerator:
Undefined 

Unkown value type.

Int1 

Integer.

Int2 

2D integer.

Int3 

3D integer.

Int4 

4D integer.

Float1 

floating point.

Float2 

2D floating point.

Float3 

3D floating point.

Float4 

4D floating point.

String 

Short string.


Constructor & Destructor Documentation

Initialize an empty value.

Value type will be set to `Undefined`.

Initialize an integer value.

Parameters:
xinteger value.
fsdk::ISettingsProvider::Value::Value ( int  x,
int  y 
)

Initialize a 2d integer value.

Parameters:
x1st value.
y2nd value.
fsdk::ISettingsProvider::Value::Value ( int  x,
int  y,
int  z 
)

Initialize a 3d integer value.

Parameters:
x1st value.
y2nd value.
z3rd value.
fsdk::ISettingsProvider::Value::Value ( int  x,
int  y,
int  z,
int  w 
)

Initialize a 4d integer value.

Parameters:
x1st value.
y2nd value.
z3rd value.
w4th value.

Initialize a float value.

Parameters:
xfloat value.
fsdk::ISettingsProvider::Value::Value ( float  x,
float  y 
)

Initialize a 2d float value.

Parameters:
x1st value.
y2nd value.
fsdk::ISettingsProvider::Value::Value ( float  x,
float  y,
float  z 
)

Initialize a 3d float value.

Parameters:
x1st value.
y2nd value.
z3rd value.
fsdk::ISettingsProvider::Value::Value ( float  x,
float  y,
float  z,
float  w 
)

Initialize a 4d float value.

Parameters:
x1st value.
y2nd value.
z3rd value.
w4th value.
fsdk::ISettingsProvider::Value::Value ( const char *  string)

Initialize a string value.

Note:
Only short strings (<64 chars) are supported.
Parameters:
stringstring value.
fsdk::ISettingsProvider::Value::Value ( const Rect &  rect)

Initialize a rect value.

Parameters:
rectrect value.

Initialize a size value.

Parameters:
sizesize value.

Initialize a point value.

Parameters:
pointpoint value.

Initialize a bool value.

Parameters:
xbool value.

Member Function Documentation

bool fsdk::ISettingsProvider::Value::asBool ( bool  defaultValue = false) const

Safely get a boolean.

If actual value type is convertible to bool, the value is returned; if not a fallback value is returned.

Parameters:
defaultValuefallback value (optional).
Returns:
value.
float fsdk::ISettingsProvider::Value::asFloat ( float  defaultValue = 0.f) const

Safely get a float.

If actual value type is float, the value is returned; if not a fallback value is returned.

Parameters:
defaultValuefallback value (optional).
Returns:
value.
int fsdk::ISettingsProvider::Value::asInt ( int  defaultValue = 0) const

Safely get an integer.

If actual value type is Int, the value is returned; if not a fallback value is returned.

Parameters:
defaultValuefallback value (optional).
Returns:
value.

Safely get a Point2f.

If actual value type is convertible to Point2f, the value is returned; if not a fallback value is returned.

Parameters:
defaultValuefallback value (optional).
Returns:
value.

Safely get a Point2i.

If actual value type is convertible to Point2i, the value is returned; if not a fallback value is returned.

Parameters:
defaultValuefallback value (optional).
Returns:
value.
Rect fsdk::ISettingsProvider::Value::asRect ( const Rect &  defaultValue = Rect()) const

Safely get a Rect.

If actual value type is convertible to Rect, the value is returned; if not a fallback value is returned.

Parameters:
defaultValuefallback value (optional).
Returns:
value.
Size fsdk::ISettingsProvider::Value::asSize ( const Size defaultValue = Size()) const

Safely get a Size.

If actual value type is convertible to Size, the value is returned; if not a fallback value is returned.

Parameters:
defaultValuefallback value (optional).
Returns:
value.
const char* fsdk::ISettingsProvider::Value::asString ( const char *  defaultValue = "") const

Safely get a string.

If actual value type is String, the value is returned; if not a fallback value is returned.

Note:
Doesn't allocate or copy memory.
Parameters:
defaultValuefallback value (optional).
Returns:
value.
bool fsdk::ISettingsProvider::Value::getBool ( bool *  x) const

Get a bool value.

Parameters:
[out]xthe value.
Note:
function fails if actual value type is not convertible to bool; in this case `x` isn't modified.
Returns:
true if succeeded; false otherwise.
bool fsdk::ISettingsProvider::Value::getFloat ( float *  x) const

Get a float value.

Parameters:
[out]xthe value.
Note:
function fails if actual value type is not a float; in this case 'x' isn't modified.
Returns:
true if succeeded; false otherwise.
bool fsdk::ISettingsProvider::Value::getFloat ( float *  x,
float *  y 
) const

Get a 2d float value.

Parameters:
[out]x1st value.
[out]y2nd value.
Note:
function fails if actual value type is not a 2d float; in this case output parameters aren't modified.
Returns:
true if succeeded; false otherwise.
bool fsdk::ISettingsProvider::Value::getFloat ( float *  x,
float *  y,
float *  z 
) const

Get a 3d float value.

Parameters:
[out]x1st value.
[out]y2nd value.
[out]z3rd value.
Note:
function fails if actual value type is not a 3d float; in this case output parameters aren't modified.
Returns:
true if succeeded; false otherwise.
bool fsdk::ISettingsProvider::Value::getFloat ( float *  x,
float *  y,
float *  z,
float *  w 
) const

Get a 4d float value.

Parameters:
[out]x1st value.
[out]y2nd value.
[out]z3rd value.
[out]w4th value.
Note:
function fails if actual value type is not a 4d float; in this case output parameters aren't modified.
Returns:
true if succeeded; false otherwise.
bool fsdk::ISettingsProvider::Value::getInt ( int *  x) const

Get an int value.

Parameters:
[out]xthe value.
Note:
function fails if actual value type is not an int; in this case `x` isn't modified.
Returns:
true if succeeded; false otherwise.
bool fsdk::ISettingsProvider::Value::getInt ( int *  x,
int *  y 
) const

Get a 2d int value.

Parameters:
[out]x1st value.
[out]y2nd value.
Note:
function fails if actual value type is not a 2d int; in this case output parameters aren't modified.
Returns:
true if succeeded; false otherwise.
bool fsdk::ISettingsProvider::Value::getInt ( int *  x,
int *  y,
int *  z 
) const

Get a 3d int value.

Parameters:
[out]x1st value.
[out]y2nd value.
[out]z3rd value.
Note:
function fails if actual value type is not a 3d int; in this case output parameters aren't modified.
Returns:
true if succeeded; false otherwise.
bool fsdk::ISettingsProvider::Value::getInt ( int *  x,
int *  y,
int *  z,
int *  w 
) const

Get a 4d int value.

Parameters:
[out]x1st value.
[out]y2nd value.
[out]z3rd value.
[out]w4th value.
Note:
function fails if actual value type is not a 4d int; in this case output parameters aren't modified.
Returns:
true if succeeded; false otherwise.

Get a Point2f value.

Parameters:
[out]pointthe value.
Note:
function fails if actual value type is not convertible to Point2f; in this case `point` isn't modified.
Returns:
true if succeeded; false otherwise.

Get a Point2i value.

Parameters:
[out]pointthe value.
Note:
function fails if actual value type is not convertible to Point2i; in this case `point` isn't modified.
Returns:
true if succeeded; false otherwise.
bool fsdk::ISettingsProvider::Value::getRect ( Rect *  rect) const

Get a rect value.

Parameters:
[out]rectthe value.
Note:
function fails if actual value type is not convertible to rect; in this case `rect` isn't modified.
Returns:
true if succeeded; false otherwise.

Get a size value.

Parameters:
[out]sizethe value.
Note:
function fails if actual value type is not convertible to size; in this case `size` isn't modified.
Returns:
true if succeeded; false otherwise.
bool fsdk::ISettingsProvider::Value::getString ( char *  string) const

Get a string value.

Parameters:
[out]stringthe value.
Note:
function fails if actual value type is not string; in this case `string` isn't modified.
Returns:
true if succeeded; false otherwise.

Check if value type is of concrete type.

Parameters:
typetype to check.
Returns:
true if value type is equal to `type`.
fsdk::ISettingsProvider::Value::operator bool ( ) const

Check if value type is not `Undefined`.

Returns:
true if value type is not `Undefined`.

Set a bool value.

Parameters:
xthe value.

Set a float value.

Parameters:
xthe value.
void fsdk::ISettingsProvider::Value::setFloat ( float  x,
float  y 
)

Set a 2d float value.

Parameters:
x1st value.
y2nd value.
void fsdk::ISettingsProvider::Value::setFloat ( float  x,
float  y,
float  z 
)

Set a 3d float value.

Parameters:
x1st value.
y2nd value.
z3rd value.
void fsdk::ISettingsProvider::Value::setFloat ( float  x,
float  y,
float  z,
float  w 
)

Set a 4d float value.

Parameters:
x1st value.
y2nd value.
z3rd value.
w4th value.

Set an int value.

Parameters:
xthe value.
void fsdk::ISettingsProvider::Value::setInt ( int  x,
int  y 
)

Set a 2d int value.

Parameters:
x1st value.
y2nd value.
void fsdk::ISettingsProvider::Value::setInt ( int  x,
int  y,
int  z 
)

Set a 3d int value.

Parameters:
x1st value.
y2nd value.
z3rd value.
void fsdk::ISettingsProvider::Value::setInt ( int  x,
int  y,
int  z,
int  w 
)

Set a 4d int value.

Parameters:
x1st value.
y2nd value.
z3rd value.
w4th value.

Set a setPoint2f value.

Parameters:
pointthe value.

Set a Point2i value.

Parameters:
pointthe value.
void fsdk::ISettingsProvider::Value::setRect ( const Rect &  rect)

Set a rect value.

Parameters:
rectthe value.

Set a size value.

Parameters:
sizethe value.
bool fsdk::ISettingsProvider::Value::setString ( const char *  string)

Set a string value.

Parameters:
stringthe value.

The documentation for this struct was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines