VolumeConverter

Arduino library to convert volume units.

Description

VolumeConverter is a library containing a VolumeConverter class.

It consists of setters to set a certain volume in one of the many supported units. Internally it is converted to liters. Then the user can use a getter to get the volume in one of the supported units.

Besides conversion the class also allows one to add different units and convert them.

The purpose of the library is conversion and can be used for educational programs too.

The library is open for additions, including obscure volume metrics and volume related math functions and constants. Also good examples (e.g. educational) are welcome.

Accuracy

As the library uses floats the accuracy is limited especially if one tries to add or convert the extremes of the scales. E.g. Long tons to teaspoons will loose significant digits.

Example

To convert from one less known format to another just takes two calls, example:

  VolumeConverter VC;

  VC.setCubicMeters(24.2);
  float x = VC.getGallons();

If you need to convert a lot of data between two formats, it is also possible to pre-calculate a factor so the conversion is faster. On an UNO R3 the gain goes up to 20%.

  VolumeConverter VC;

  VC.setLiters(1);  //  any non zero value will work.
  float factor = VC.getGallons() / VC.getCubicMeters();
  sum = 0;
  for (int i = 0; i < 1000; i++)
  {
    sum += i * factor;
  }

Formats

name	liters	notes
Liters	1
MilliLiters	0.001
CubicMeters	1000
LongTons	1284.16209
ShortTons	906.98184
Barrels	158.9868
Gallons	3.7854
Quarts	0.94635296
Pints	0.47317648
Cups	0.23658824
FluidOunces	0.02957353
TableSpoons	0.01478677
TeaSpoons	0.00492892

If units are missing, please open an issue.

Related

Interface

#include "VolumeConverter.h"

Internal representation is the liter as it the ISO standard.

Constructor

• VolumeConverter() sets the internal value to 0.

Setters

• void setLiters(float value = 0)
• void setMilliLiters(float value = 0)
• void setCubicMeters(float value = 0)
• void setLongTons(float value = 0)
• void setShortTons(float value = 0)
• void setBarrels(float value = 0)
• void setGallons(float value = 0)
• void setQuarts(float value = 0)
• void setPints(float value = 0)
• void setCups(float value = 0)
• void setFluidOunces(float value = 0)
• void setTableSpoons(float value = 0)
• void setTeaSpoons(float value = 0)

Adders

• void addLiters(float value = 0)
• void addMilliLiters(float value = 0)
• void addCubicMeters(float value = 0)
• void addLongTons(float value = 0)
• void addShortTons(float value = 0)
• void addBarrels(float value = 0)
• void addGallons(float value = 0)
• void addQuarts(float value = 0)
• void addPints(float value = 0)
• void addCups(float value = 0)
• void addFluidOunces(float value = 0)
• void addTableSpoons(float value = 0)
• void addTeaSpoons(float value = 0)

getters

• float getLiters()
• float getMilliLiters()
• float getCubicMeters()
• float getLongTons()
• float getShortTons()
• float getBarrels()
• float getGallons()
• float getQuarts()
• float getPints()
• float getCups()
• float getFluidOunces()
• float getTableSpoons()
• float getTeaSpoons()

Future

Must

• improve documentation

Should

• consider using double instead of float.

Could

• add more unit tests
• add more examples

won't (unless)

• use double instead of float (only if needed).
  • template, with default float?

Support

If you appreciate my libraries, you can support the development and maintenance. Improve the quality of the libraries by providing issues and Pull Requests, or donate through PayPal or GitHub sponsors.

Thank you,