Top | ![]() |
![]() |
![]() |
![]() |
GwySIValueFormat object represents instructions how to format numbers
representing physical quantities, including precision and units. They
are usually created based on a GwySIUnit and some data ranges with
functions such as gwy_si_unit_get_format_with_resolution()
or
gwy_si_unit_get_format_with_digits()
. Various data objects also offer
method for obtaining value formats representing reasonably their coordinates
or values, for instance gwy_data_field_get_value_format_xy()
.
GwySIValueFormat * gwy_si_unit_value_format_new (gdouble magnitude
,gint precision
,const gchar *units
);
Constructs a new value format directly.
Usually you construct value formats from a GwySIUnit using functions such
as gwy_si_unit_get_format_with_digits()
or obtain it from data object
functions.
magnitude |
Number to divide a quantity by (a power of 1000). |
|
precision |
Number of decimal places to format a quantity to. |
|
units |
Units to put after quantity divided by |
Since: 2.46
GwySIValueFormat *
gwy_si_unit_value_format_copy (GwySIValueFormat *format
);
Copies a value format structure.
Since: 2.39
void
gwy_si_unit_value_format_free (GwySIValueFormat *format
);
Frees a value format structure.
GwySIValueFormat * gwy_si_unit_value_format_clone (GwySIValueFormat *source
,GwySIValueFormat *dest
);
Clones a value format to another.
This function follows the convention of many value format updating functions that can either modify an existing format or allocate a new one.
The dest
value format. If it was NULL
, a newly allocated format
is returned, otherwise (modified) dest
itself is returned.
Since: 2.46
void gwy_si_unit_value_format_set_units (GwySIValueFormat *format
,const gchar *units
);
Sets the units field of a value format structure.
This function keeps the units
and units_gstring
fields consistent.
typedef struct { gdouble magnitude; gint precision; gchar *units; } GwySIValueFormat;
A physical quantity formatting information.
The magnitude
and precision
fields can be directly modified if necessary.
Units must be always set with gwy_si_unit_value_format_set_units()
to update
the internal representation correctly.