Configuration parameter value. More...

#include <ISettingsProvider.h>

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. More...

	Value (int x) noexcept
	Initialize an integer value. More...

	Value (int x, int y) noexcept
	Initialize a 2d integer value. More...

	Value (int x, int y, int z) noexcept
	Initialize a 3d integer value. More...

	Value (int x, int y, int z, int w) noexcept
	Initialize a 4d integer value. More...

	Value (float x) noexcept
	Initialize a float value. More...

	Value (float x, float y) noexcept
	Initialize a 2d float value. More...

	Value (float x, float y, float z) noexcept
	Initialize a 3d float value. More...

	Value (float x, float y, float z, float w) noexcept
	Initialize a 4d float value. More...

	Value (const char *string) noexcept
	Initialize a string value. More...

	Value (const Rect &rect) noexcept
	Initialize a rect value. More...

	Value (const Size &size) noexcept
	Initialize a size value. More...

	Value (const Point2f &point) noexcept
	Initialize a point value. More...

	Value (bool x) noexcept
	Initialize a bool value. More...

	operator bool () const noexcept
	Check if value type is not `Undefined`. More...

bool	is (Type type) const noexcept
	Check if value type is of concrete type. More...

bool	setString (const char *string) noexcept
	Set a string value. More...

bool	getString (char *string) const noexcept
	Get a string value. More...

void	setRect (const Rect &rect) noexcept
	Set a rect value. More...

bool	getRect (Rect *rect) const noexcept
	Get a rect value. More...

void	setSize (const Size &size) noexcept
	Set a size value. More...

bool	getSize (Size *size) const noexcept
	Get a size value. More...

void	setPoint2i (const Point2i &point) noexcept
	Set a Point2i value. More...

bool	getPoint2i (Point2i *point) const noexcept
	Get a Point2i value. More...

void	setPoint2f (const Point2f &point) noexcept
	Set a setPoint2f value. More...

bool	getPoint2f (Point2f *point) const noexcept
	Get a Point2f value. More...

void	setBool (bool x) noexcept
	Set a bool value. More...

bool	getBool (bool *x) const noexcept
	Get a bool value. More...

void	setInt (int x) noexcept
	Set an int value. More...

bool	getInt (int *x) const noexcept
	Get an int value. More...

void	setInt (int x, int y) noexcept
	Set a 2d int value. More...

bool	getInt (int x, int y) const noexcept
	Get a 2d int value. More...

void	setInt (int x, int y, int z) noexcept
	Set a 3d int value. More...

bool	getInt (int x, int y, int *z) const noexcept
	Get a 3d int value. More...

void	setInt (int x, int y, int z, int w) noexcept
	Set a 4d int value. More...

bool	getInt (int x, int y, int z, int w) const noexcept
	Get a 4d int value. More...

void	setFloat (float x) noexcept
	Set a float value. More...

bool	getFloat (float *x) const noexcept
	Get a float value. More...

void	setFloat (float x, float y) noexcept
	Set a 2d float value. More...

bool	getFloat (float x, float y) const noexcept
	Get a 2d float value. More...

void	setFloat (float x, float y, float z) noexcept
	Set a 3d float value. More...

bool	getFloat (float x, float y, float *z) const noexcept
	Get a 3d float value. More...

void	setFloat (float x, float y, float z, float w) noexcept
	Set a 4d float value. More...

bool	getFloat (float x, float y, float z, float w) const noexcept
	Get a 4d float value. More...

float	asFloat (float defaultValue=0.f) const noexcept
	Safely get a float. More...

Point2f	asPoint2f (const Point2f &defaultValue=Point2f()) const noexcept
	Safely get a Point2f. More...

bool	asBool (bool defaultValue=false) const noexcept
	Safely get a boolean. More...

int	asInt (int defaultValue=0) const noexcept
	Safely get an integer. More...

Size	asSize (const Size &defaultValue=Size()) const noexcept
	Safely get a Size. More...

Point2i	asPoint2i (const Point2i &defaultValue=Point2i()) const noexcept
	Safely get a Point2i. More...

Rect	asRect (const Rect &defaultValue=Rect()) const noexcept
	Safely get a Rect. More...

const char *	asString (const char *defaultValue="") const noexcept
	Safely get a string. More...

	Value (const Value &other)=delete

	Value (Value &&other)

Value &	operator= (const Value &other)=delete

Value &	operator= (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

enum fsdk::ISettingsProvider::Value::Type

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

fsdk::ISettingsProvider::Value::Value ( )

inlinenoexcept

Initialize an empty value.

Value type will be set to Undefined.

fsdk::ISettingsProvider::Value::Value ( int x )

inlinenoexcept

Initialize an integer value.

Parameters

x	integer value.

fsdk::ISettingsProvider::Value::Value	(	int	x,
		int	y
	)

inlinenoexcept

Initialize a 2d integer value.

Parameters

x	1st value.
y	2nd value.

fsdk::ISettingsProvider::Value::Value	(	int	x,
		int	y,
		int	z
	)

inlinenoexcept

Initialize a 3d integer value.

Parameters

x	1st value.
y	2nd value.
z	3rd value.

fsdk::ISettingsProvider::Value::Value	(	int	x,
		int	y,
		int	z,
		int	w
	)

inlinenoexcept

Initialize a 4d integer value.

Parameters

x	1st value.
y	2nd value.
z	3rd value.
w	4th value.

fsdk::ISettingsProvider::Value::Value ( float x )

inlinenoexcept

Initialize a float value.

Parameters

x	float value.

fsdk::ISettingsProvider::Value::Value	(	float	x,
		float	y
	)

inlinenoexcept

Initialize a 2d float value.

Parameters

x	1st value.
y	2nd value.

fsdk::ISettingsProvider::Value::Value	(	float	x,
		float	y,
		float	z
	)

inlinenoexcept

Initialize a 3d float value.

Parameters

x	1st value.
y	2nd value.
z	3rd value.

fsdk::ISettingsProvider::Value::Value	(	float	x,
		float	y,
		float	z,
		float	w
	)

inlinenoexcept

Initialize a 4d float value.

Parameters

x	1st value.
y	2nd value.
z	3rd value.
w	4th value.

fsdk::ISettingsProvider::Value::Value ( const char * string )

inlinenoexcept

Initialize a string value.

Note: Only short strings (<64 chars) are supported.

Parameters

string string value.

fsdk::ISettingsProvider::Value::Value ( const Rect & rect )

inlinenoexcept

Initialize a rect value.

Parameters

rect	rect value.

fsdk::ISettingsProvider::Value::Value ( const Size & size )

inlinenoexcept

Initialize a size value.

Parameters

size	size value.

fsdk::ISettingsProvider::Value::Value ( const Point2f & point )

inlinenoexcept

Initialize a point value.

Parameters

point point value.

fsdk::ISettingsProvider::Value::Value ( bool x )

inlinenoexcept

Initialize a bool value.

Parameters

x	bool value.

Member Function Documentation

bool fsdk::ISettingsProvider::Value::is ( Type type ) const

inlinenoexcept

Check if value type is of concrete type.

Parameters

type	type to check.

Returns: true if value type is equal to type.

fsdk::ISettingsProvider::Value::operator bool ( ) const

inlinenoexcept

Check if value type is not Undefined.

Returns: true if value type is not Undefined.

The documentation for this struct was generated from the following files:

include/fsdk/ISettingsProvider.h
include/fsdk/ISettingsProvider.inl

Classes

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation