unitFormatter.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: unitFormatter.h,v $ $Revision: 1.4 $ $State: Exp $
*******************************************************************************/

#pragma once

#include <vlutil/vlString.h>
#include <matrix/vlVector.h>

#include "tdbutil/tdbUtilDefines.h"

// Set the global translation function to handle your own custom translations
typedef DtString (*DtTranslatorFunction)(const char* text, const char* module);

DT_DLL_tdbutil DtString trUtf8(const char* text, const char* module);
DT_DLL_tdbutil void setTranslatorFunction(DtTranslatorFunction);

// Pretty formatting for back-end tasks and sets

class DT_DLL_tdbutil DtUnitFormatter
{
public:
   virtual DtString formatSourceToDisplay(const DtVector& val) const;
   virtual DtString formatSourceToDisplay(double val, const DtString& unitDisplay,
                                              const DtString& source, DtString& unitLabel) const;
};

DT_DLL_tdbutil DtUnitFormatter* setUnitFormatter(DtUnitFormatter*);

// Assumes that DtVector is in geocentric
DT_DLL_tdbutil DtString formatSourceToDisplay(const DtVector& val);

// value must be in source units as defined in tdbUnits.h
DT_DLL_tdbutil DtString formatSourceToDisplay(double val, const DtString& unitDisplay,
                                              const DtString& source, DtString& unitLabel);