ArvGcFloat: Aravis Reference Manual

ArvGcFloat

ArvGcFloat — Float interface

Functions

double	arv_gc_float_get_value ()
void	arv_gc_float_set_value ()
double	arv_gc_float_get_min ()
double	arv_gc_float_get_max ()
double	arv_gc_float_get_inc ()
ArvGcRepresentation	arv_gc_float_get_representation ()
const char *	arv_gc_float_get_unit ()
ArvGcDisplayNotation	arv_gc_float_get_display_notation ()
gint64	arv_gc_float_get_display_precision ()
void	arv_gc_float_impose_min ()
void	arv_gc_float_impose_max ()

Types and Values

ArvGcFloat

Object Hierarchy

    GInterface
    ╰── ArvGcFloat

Prerequisites

ArvGcFloat requires GObject.

Known Implementations

ArvGcFloat is implemented by ArvGcConverterNode, ArvGcFloatNode, ArvGcFloatRegNode and ArvGcSwissKnifeNode.

Description

Functions

arv_gc_float_get_value ()

double
arv_gc_float_get_value (ArvGcFloat *gc_float,
                        GError **error);

arv_gc_float_set_value ()

void
arv_gc_float_set_value (ArvGcFloat *gc_float,
                        double value,
                        GError **error);

arv_gc_float_get_min ()

double
arv_gc_float_get_min (ArvGcFloat *gc_float,
                      GError **error);

Parameters

gc_float	a ArvGcFloat
error	a GError placeholder, NULL to ignore

Returns

The feature Min property, -G_MAXDOUBLE if not defined or on error

arv_gc_float_get_max ()

double
arv_gc_float_get_max (ArvGcFloat *gc_float,
                      GError **error);

Parameters

gc_float	a ArvGcFloat
error	a GError placeholder, NULL to ignore

Returns

The feature Max property, G_MAXDOUBLE if not defined or on error

arv_gc_float_get_inc ()

double
arv_gc_float_get_inc (ArvGcFloat *gc_float,
                      GError **error);

Parameters

gc_float	a ArvGcFloat
error	a GError placeholder, NULL to ignore

Returns

The feature Inc property, G_MINDOUBLE if not defined or on error

arv_gc_float_get_representation ()

ArvGcRepresentation
arv_gc_float_get_representation (ArvGcFloat *gc_float);

Get number representation format.

Parameters

gc_float

a ArvGcFloat

Returns

Number representation format as ArvGcRepresentation.

arv_gc_float_get_unit ()

const char *
arv_gc_float_get_unit (ArvGcFloat *gc_float);

arv_gc_float_get_display_notation ()

ArvGcDisplayNotation
arv_gc_float_get_display_notation (ArvGcFloat *gc_float);

Get number display notation.

Parameters

gc_float

a ArvGcFloat

Returns

Number display notation as ArvGcDisplayNotation.

Since: 0.8.0

arv_gc_float_get_display_precision ()

gint64
arv_gc_float_get_display_precision (ArvGcFloat *gc_float);

Gets number of digits to show in user interface. This number should always be positive and represent total number of digits on left and right side of decimal.

Parameters

gc_float

a ArvGcFloat

Returns

Number of digits to show.

Since: 0.8.0

arv_gc_float_impose_min ()

void
arv_gc_float_impose_min (ArvGcFloat *gc_float,
                         double minimum,
                         GError **error);

arv_gc_float_impose_max ()

void
arv_gc_float_impose_max (ArvGcFloat *gc_float,
                         double maximum,
                         GError **error);

Types and Values

ArvGcFloat

typedef struct _ArvGcFloat ArvGcFloat;