Description:

This struct is used to format sizes of byte arrays (streams, files, etc), in accordance with SI units (kB, MB, GB, etc). Integral values embedded in this struct are appendable to class AString.

See also: Sibling struct ByteSizeIEC

Definition at line 150 of file bytesize.hpp.

#include <bytesize.hpp>

Public Field Index:
uint16_t	MagnitudeThreshold

char	UnitSeparator
	An optional character to separate the number from the unit.

uinteger	Value
	The encapsulated value to print.

Public Method Index:
constexpr	ByteSizeSI (uinteger value, uint16_t magnitudeThreshold=800, char unitSeparator='\0') noexcept

ALIB_API double	ConvertTo (ByteSizeUnits unit)

ALIB_API std::pair< double, ByteSizeUnits >	GetMagnitude ()

Field Details:

◆ MagnitudeThreshold

uint16_t MagnitudeThreshold

The lowest value to use with the next lower possible magnitude. If for example to 900, then 0.9 GiB is preferred over 900.0 MiB.

Definition at line 153 of file bytesize.hpp.

◆ UnitSeparator

char UnitSeparator

An optional character to separate the number from the unit.

Definition at line 156 of file bytesize.hpp.

◆ Value

uinteger Value

The encapsulated value to print.

Definition at line 152 of file bytesize.hpp.

Constructor(s) / Destructor Details:

◆ ByteSizeSI()

ByteSizeSI	(	uinteger	value,
		uint16_t	magnitudeThreshold = 800,
		char	unitSeparator = '\0' )

inlineconstexprnoexcept

Constructor.

Parameters

value	The value to append/format.
magnitudeThreshold	Stored in MagnitudeThreshold. Defaults to `800`.
unitSeparator	Separation character between printed number and unit. Defaults to `0`.

Definition at line 163 of file bytesize.hpp.

Method Details:

◆ ConvertTo()

ALIB_API double ConvertTo ( ByteSizeUnits unit )

Returns a double value converted to the given unit. Note that while this class otherwise is responsible for SI units, conversions to IEC-units may be requested.

Parameters

unit	The unit to convert to.

Returns: Field Value as a double converted to unit.

◆ GetMagnitude()

ALIB_API std::pair< double, ByteSizeUnits > GetMagnitude ( )

Evaluates the magnitude of the value and returns the converted double value between 0.0 and threshold.

Returns: The Value converted to double together with the magnitude flag.

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

bytesize.hpp