base_units.h File Reference

Implementation of conversion functions that require both schematic and board internal units. More...

#include <string>
#include <eda_units.h>
#include <convert_to_biu.h>
#include <math/util.h>
#include <math/vector2d.h>

Go to the source code of this file.

Macros
#define	INDETERMINATE_STATE   _( "-- mixed values --" )
	Used for holding indeterminate values, such as with multiple selections holding different values or controls which do not wish to set a value. More...
#define	INDETERMINATE_ACTION   _( "-- leave unchanged --" )
#define	ALLOW_BOLD_THICKNESS   IsBold()

Functions
int	Mm2mils (double x)
	Convert mm to mils. More...
int	Mils2mm (double x)
	Convert mils to mm. More...
std::string	Double2Str (double aValue)
	Helper function Double2Str to print a float number without using scientific notation and no trailing 0 We want to avoid scientific notation in S-expr files (not easy to read) for floating numbers. More...
double	To_User_Unit (EDA_UNITS aUnit, double aValue)
	Function To_User_Unit convert aValue in internal units to the appropriate user units defined by aUnit. More...
wxString	AngleToStringDegrees (double aAngle)
	Function AngleToStringDegrees is a helper to convert the double aAngle (in internal unit) to a string in degrees. More...
wxString	MessageTextFromValue (EDA_UNITS aUnits, double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Function MessageTextFromValue is a helper to convert the double length aValue to a string in inches, millimeters, or unscaled units. More...
wxString	MessageTextFromValue (EDA_UNITS aUnits, int aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
wxString	MessageTextFromValue (EDA_UNITS aUnits, long long int aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
wxString	StringFromValue (EDA_UNITS aUnit, double aValue, bool aAddUnitSymbol=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Function StringFromValue returns the string from aValue according to units (inch, mm ...) for display, and the initial unit for value. More...
double	From_User_Unit (EDA_UNITS aUnit, double aValue)
	Return in internal units the value "val" given in a real unit such as "in", "mm" or "deg". More...
double	DoubleValueFromString (EDA_UNITS aUnits, const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Function DoubleValueFromString converts aTextValue to a double. More...
long long int	ValueFromString (EDA_UNITS aUnits, const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Function ValueFromString converts aTextValue in aUnits to internal units used by the application. More...
void	FetchUnitsFromString (const wxString &aTextValue, EDA_UNITS &aUnits)
	Function FetchUnitsFromString writes any unit info found in the string to aUnits. More...
wxString	GetAbbreviatedUnitsLabel (EDA_UNITS aUnit, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Get the units string for a given units type. More...
std::string	FormatInternalUnits (int aValue)
	Function FormatInternalUnits converts aValue from internal units to a string appropriate for writing to file. More...
std::string	FormatAngle (double aAngle)
	Function FormatAngle converts aAngle from board units to a string appropriate for writing to file. More...
std::string	FormatInternalUnits (const wxPoint &aPoint)
std::string	FormatInternalUnits (const wxSize &aSize)
std::string	FormatInternalUnits (const VECTOR2I &aPoint)

Detailed Description

Implementation of conversion functions that require both schematic and board internal units.

Author

Wayne Stambaugh stamb.nosp@m.augh.nosp@m.w@ver.nosp@m.izon.nosp@m..net

Definition in file base_units.h.

Macro Definition Documentation

ALLOW_BOLD_THICKNESS

#define ALLOW_BOLD_THICKNESS   IsBold()

Definition at line 57 of file base_units.h.

INDETERMINATE_ACTION

#define INDETERMINATE_ACTION   _( "-- leave unchanged --" )

Definition at line 49 of file base_units.h.

INDETERMINATE_STATE

#define INDETERMINATE_STATE   _( "-- mixed values --" )

Used for holding indeterminate values, such as with multiple selections holding different values or controls which do not wish to set a value.

Definition at line 48 of file base_units.h.

Function Documentation

AngleToStringDegrees()

wxString AngleToStringDegrees

(

double

aAngle

)

Function AngleToStringDegrees is a helper to convert the double aAngle (in internal unit) to a string in degrees.

Definition at line 456 of file base_units.cpp.

{
    wxString text;

    text.Printf( wxT( "%.3f" ), aAngle/10.0 );
    StripTrailingZeros( text, 1 );

    return text;
}

References StripTrailingZeros().

Referenced by PANEL_EDIT_OPTIONS::TransferDataToWindow().

Double2Str()

std::string Double2Str

(

double

aValue

)

Helper function Double2Str to print a float number without using scientific notation and no trailing 0 We want to avoid scientific notation in S-expr files (not easy to read) for floating numbers.

So we cannot always just use the g or the f format to print a fp number this helper function uses the f format when needed, or g when f is not well working and then removes trailing 0

Definition at line 61 of file base_units.cpp.

{
    char    buf[50];
    int     len;

    if( aValue != 0.0 && fabs( aValue ) <= 0.0001 )
    {
        // For these small values, %f works fine,
        // and %g gives an exponent
        len = sprintf( buf,  "%.16f", aValue );

        while( --len > 0 && buf[len] == '0' )
            buf[len] = '\0';

        if( buf[len] == '.' )
            buf[len] = '\0';
        else
            ++len;
    }
    else
    {
        // For these values, %g works fine, and sometimes %f
        // gives a bad value (try aValue = 1.222222222222, with %.16f format!)
        len = sprintf( buf, "%.16g", aValue );
    }

    return std::string( buf, len );
}

Referenced by GBR_TO_PCB_EXPORTER::export_non_copper_item(), GBR_TO_PCB_EXPORTER::export_via(), PCB_IO::format(), BOARD_STACKUP::FormatBoardStackup(), formatStroke(), SCH_SEXPR_PLUGIN::saveJunction(), GBR_TO_PCB_EXPORTER::writeCopperLineItem(), GBR_TO_PCB_EXPORTER::writePcbPolygon(), and GBR_TO_PCB_EXPORTER::writePcbZoneItem().

DoubleValueFromString()

double DoubleValueFromString	(	EDA_UNITS	aUnits,
		const wxString &	aTextValue,
		EDA_DATA_TYPE	aType = EDA_DATA_TYPE::DISTANCE
	)

Function DoubleValueFromString converts aTextValue to a double.

Warning

This utilizes the current locale and will break if decimal formats differ

Parameters

aUnits	The units of aTextValue.
aTextValue	A reference to a wxString object containing the string to convert.

Returns

A double representing that value in internal units

Definition at line 333 of file base_units.cpp.

{
    double dtmp = 0;

    // Acquire the 'right' decimal point separator
    const struct lconv* lc = localeconv();

    wxChar      decimal_point = lc->decimal_point[0];
    wxString    buf( aTextValue.Strip( wxString::both ) );

    // Convert the period in decimal point
    buf.Replace( wxT( "." ), wxString( decimal_point, 1 ) );

    // Find the end of the numeric part
    unsigned brk_point = 0;

    while( brk_point < buf.Len() )
    {
        wxChar ch = buf[brk_point];

        if( !( (ch >= '0' && ch <='9') || (ch == decimal_point) || (ch == '-') || (ch == '+') ) )
        {
            break;
        }

        ++brk_point;
    }

    // Extract the numeric part
    buf.Left( brk_point );

    buf.ToDouble( &dtmp );

    // Check the optional unit designator (2 ch significant)
    wxString unit( buf.Mid( brk_point ).Strip( wxString::leading ).Left( 2 ).Lower() );

    if( aUnits == EDA_UNITS::MILLIMETRES || aUnits == EDA_UNITS::MILS || aUnits == EDA_UNITS::INCHES )
    {
        if( unit == wxT( "mm" ) )
        {
            aUnits = EDA_UNITS::MILLIMETRES;
        }
        else if( unit == wxT( "mi" ) || unit == wxT( "th" ) )
        {
            aUnits = EDA_UNITS::MILS;
        }
        else if( unit == wxT( "in" ) || unit == wxT( "\"" ) )
        {
            aUnits = EDA_UNITS::INCHES;
        }
        else if( unit == "oz" ) // 1 oz = 1.37 mils
        {
            aUnits = EDA_UNITS::MILS;
            dtmp *= 1.37;
        }
    }
    else if( aUnits == EDA_UNITS::DEGREES )
    {
        if( unit == wxT( "ra" ) ) // Radians
        {
            dtmp *= 180.0f / M_PI;
        }
    }

    switch( aType )
    {
    case EDA_DATA_TYPE::VOLUME:
        dtmp = From_User_Unit( aUnits, dtmp );
        KI_FALLTHROUGH;

    case EDA_DATA_TYPE::AREA:
        dtmp = From_User_Unit( aUnits, dtmp );
        KI_FALLTHROUGH;

    case EDA_DATA_TYPE::DISTANCE:
        dtmp = From_User_Unit( aUnits, dtmp );
    }

    return dtmp;
}

References AREA, DEGREES, DISTANCE, From_User_Unit(), INCHES, KI_FALLTHROUGH, MILLIMETRES, MILS, and VOLUME.

Referenced by PCB_UNIT_RESOLVER::Convert(), PROPERTIES_FRAME::CopyPrmsFromPanelToGeneral(), PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), PANEL_PREV_3D::doIncrementOffset(), PANEL_PREV_3D::doIncrementRotation(), PANEL_PREV_3D::doIncrementScale(), LIBEVAL::COMPILER::generateUCode(), UNIT_BINDER::GetDoubleValue(), DIALOG_BOARD_REANNOTATE::GetParameters(), DIALOG_IMPORT_GFX::getPCBdefaultLineWidthMM(), DIALOG_EXPORT_STEP::GetXOrg(), DIALOG_EXPORT_IDF3::GetXRef(), DIALOG_EXPORT_3DFILE::GetXRef(), DIALOG_EXPORT_STEP::GetYOrg(), DIALOG_EXPORT_IDF3::GetYRef(), DIALOG_EXPORT_3DFILE::GetYRef(), PANEL_PREV_3D::onMouseWheelOffset(), PANEL_PREV_3D::onMouseWheelRot(), PANEL_PREV_3D::onMouseWheelScale(), rotationFromString(), TEXT_MOD_GRID_TABLE::SetValue(), DIALOG_CREATE_ARRAY::TransferDataFromWindow(), DIALOG_IMPORT_GFX::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_TRANSFORM::Transform(), PANEL_PREV_3D::updateOrientation(), DIALOG_IMPORT_GFX::updatePcbImportOffsets_mm(), and ValueFromString().

FetchUnitsFromString()

void FetchUnitsFromString	(	const wxString &	aTextValue,
		EDA_UNITS &	aUnits
	)

Function FetchUnitsFromString writes any unit info found in the string to aUnits.

Definition at line 415 of file base_units.cpp.

{
    wxString buf( aTextValue.Strip( wxString::both ) );
    unsigned brk_point = 0;

    while( brk_point < buf.Len() )
    {
        wxChar c = buf[brk_point];

        if( !( (c >= '0' && c <='9') || (c == '.') || (c == ',') || (c == '-') || (c == '+') ) )
            break;

        ++brk_point;
    }

    // Check the unit designator (2 ch significant)
    wxString unit( buf.Mid( brk_point ).Strip( wxString::leading ).Left( 2 ).Lower() );

    if( unit == wxT( "mm" ) )
        aUnits = EDA_UNITS::MILLIMETRES;
    else if( unit == wxT( "mi" ) || unit == wxT( "th" ) ) // "mils" or "thou"
        aUnits = EDA_UNITS::MILS;
    else if( unit == wxT( "in" ) || unit == wxT( "\"" ) )
        aUnits = EDA_UNITS::INCHES;
    else if( unit == wxT( "de" ) || unit == wxT( "ra" ) ) // "deg" or "rad"
        aUnits = EDA_UNITS::DEGREES;
}

References DEGREES, INCHES, MILLIMETRES, and MILS.

Referenced by PCB_PARSER::parseDIMENSION().

FormatAngle()

std::string FormatAngle

(

double

aAngle

)

Function FormatAngle converts aAngle from board units to a string appropriate for writing to file.

Note

Internal angles for board items can be either degrees or tenths of degree on how KiCad is built.

Parameters

aAngle

A angle value to convert.

Returns

A std::string object containing the converted angle.

Definition at line 557 of file base_units.cpp.

{
    char temp[50];
    int len;

    len = snprintf( temp, sizeof(temp), "%.10g", aAngle / 10.0 );

    return std::string( temp, len );
}

Referenced by DIALOG_PAD_PROPERTIES::displayPrimitivesList(), PCB_IO::format(), SCH_SEXPR_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), and SCH_SEXPR_PLUGIN::saveText().

FormatInternalUnits() [1/4]

std::string FormatInternalUnits

(

int

aValue

)

Function FormatInternalUnits converts aValue from internal units to a string appropriate for writing to file.

Note

Internal units for board items can be either deci-mils or nanometers depending on how KiCad is built.

Parameters

aValue

A coordinate value to convert.

Returns

A std::string object containing the converted value.

Definition at line 528 of file base_units.cpp.

{
    char    buf[50];
    double  engUnits = aValue;
    int     len;

    engUnits /= IU_PER_MM;

    if( engUnits != 0.0 && fabs( engUnits ) <= 0.0001 )
    {
        len = snprintf( buf, sizeof(buf), "%.10f", engUnits );

        while( --len > 0 && buf[len] == '0' )
            buf[len] = '\0';

        if( buf[len] == '.' )
            buf[len] = '\0';
        else
            ++len;
    }
    else
    {
        len = snprintf( buf, sizeof(buf), "%.10g", engUnits );
    }

    return std::string( buf, len );
}

References IU_PER_MM.

Referenced by BOOST_AUTO_TEST_CASE(), PCB_IO::format(), EDA_TEXT::Format(), BOARD_STACKUP::FormatBoardStackup(), PCB_IO::formatGeneral(), FormatInternalUnits(), PCB_IO::formatSetup(), formatStroke(), SCH_SEXPR_PLUGIN_CACHE::saveArc(), SCH_SEXPR_PLUGIN_CACHE::saveBezier(), SCH_SEXPR_PLUGIN::saveBitmap(), SCH_SEXPR_PLUGIN::saveBusEntry(), SCH_SEXPR_PLUGIN_CACHE::saveCircle(), SCH_SEXPR_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN::saveJunction(), SCH_SEXPR_PLUGIN::saveLine(), SCH_SEXPR_PLUGIN::saveNoConnect(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePolyLine(), SCH_SEXPR_PLUGIN_CACHE::saveRectangle(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), SCH_SEXPR_PLUGIN::saveText(), and SCH_SEXPR_PLUGIN_CACHE::saveText().

FormatInternalUnits() [2/4]

std::string FormatInternalUnits

(

const wxPoint &

aPoint

)

Definition at line 568 of file base_units.cpp.

{
    return FormatInternalUnits( aPoint.x ) + " " + FormatInternalUnits( aPoint.y );
}

References FormatInternalUnits().

FormatInternalUnits() [3/4]

std::string FormatInternalUnits

(

const wxSize &

aSize

)

Definition at line 580 of file base_units.cpp.

{
    return FormatInternalUnits( aSize.GetWidth() ) + " " + FormatInternalUnits( aSize.GetHeight() );
}

References FormatInternalUnits().

FormatInternalUnits() [4/4]

std::string FormatInternalUnits

(

const VECTOR2I &

aPoint

)

Definition at line 574 of file base_units.cpp.

{
    return FormatInternalUnits( aPoint.x ) + " " + FormatInternalUnits( aPoint.y );
}

References FormatInternalUnits(), VECTOR2< T >::x, and VECTOR2< T >::y.

From_User_Unit()

double From_User_Unit	(	EDA_UNITS	aUnit,
		double	aValue
	)

Return in internal units the value "val" given in a real unit such as "in", "mm" or "deg".

Definition at line 308 of file base_units.cpp.

{
    switch( aUnits )
    {
    case EDA_UNITS::MILLIMETRES:
        return MM_TO_IU( aValue );

    case EDA_UNITS::MILS:
        return MILS_TO_IU( aValue );

    case EDA_UNITS::INCHES:
        return IN_TO_IU( aValue );

    case EDA_UNITS::DEGREES:
        // Convert to "decidegrees"
        return aValue * 10;

    default:
    case EDA_UNITS::UNSCALED:
    case EDA_UNITS::PERCENT:
        return aValue;
    }
}

References DEGREES, INCHES, MILLIMETRES, MILS, PERCENT, and UNSCALED.

Referenced by DoubleValueFromString(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), and UNIT_BINDER::Validate().

GetAbbreviatedUnitsLabel()

wxString GetAbbreviatedUnitsLabel	(	EDA_UNITS	aUnit,
		EDA_DATA_TYPE	aType = EDA_DATA_TYPE::DISTANCE
	)

Get the units string for a given units type.

Parameters

aUnits	- The units requested.
aType	- The data type of the unit (e.g. distance, area, etc.)

Returns

The human readable units string.

Definition at line 467 of file base_units.cpp.

{
    switch( aUnit )
    {
    case EDA_UNITS::MILLIMETRES:
        switch( aType )
        {
        default:
            wxASSERT( 0 );
            KI_FALLTHROUGH;
        case EDA_DATA_TYPE::DISTANCE:
            return _( "mm" );
        case EDA_DATA_TYPE::AREA:
            return _( "sq. mm" );
        case EDA_DATA_TYPE::VOLUME:
            return _( "cu. mm" );
        }

    case EDA_UNITS::MILS:
        switch( aType )
        {
        default:
            wxASSERT( 0 );
            KI_FALLTHROUGH;
        case EDA_DATA_TYPE::DISTANCE:
            return _( "mils" );
        case EDA_DATA_TYPE::AREA:
            return _( "sq. mils" );
        case EDA_DATA_TYPE::VOLUME:
            return _( "cu. mils" );
        }

    case EDA_UNITS::INCHES:
        switch( aType )
        {
        default:
            wxASSERT( 0 );
            KI_FALLTHROUGH;
        case EDA_DATA_TYPE::DISTANCE:
            return _( "in" );
        case EDA_DATA_TYPE::AREA:
            return _( "sq. in" );
        case EDA_DATA_TYPE::VOLUME:
            return _( "cu. in" );
        }

    case EDA_UNITS::PERCENT:
        return _( "%" );

    case EDA_UNITS::UNSCALED:
        return wxEmptyString;

    case EDA_UNITS::DEGREES:
        return _( "deg" );

    default:
        return wxT( "??" );
    }
}

References _, AREA, DEGREES, DISTANCE, INCHES, KI_FALLTHROUGH, MILLIMETRES, MILS, PERCENT, UNSCALED, and VOLUME.

Referenced by DIALOG_PLOT::applyPlotSettings(), UNIT_BINDER::ChangeValue(), ComboBoxUnits(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), KIGFX::PREVIEW::DimensionLabel(), PANEL_PREV_3D::formatOffsetValue(), PANEL_PREV_3D::formatRotationValue(), DIMENSION_BASE::GetMsgPanelInfo(), MessageTextFromValue(), UNIT_BINDER::SetDataType(), UNIT_BINDER::SetUnits(), UNIT_BINDER::SetValue(), TEXT_MOD_GRID_TABLE::TEXT_MOD_GRID_TABLE(), UNIT_BINDER::UNIT_BINDER(), and DIMENSION_BASE::updateText().

MessageTextFromValue() [1/3]

wxString MessageTextFromValue	(	EDA_UNITS	aUnits,
		double	aValue,
		bool	aAddUnitLabel = true,
		EDA_DATA_TYPE	aType = EDA_DATA_TYPE::DISTANCE
	)

Function MessageTextFromValue is a helper to convert the double length aValue to a string in inches, millimeters, or unscaled units.

Should be used only to display a coordinate in status, but not in dialogs, files, etc., because the mantissa of the number displayed has 4 digits max for readability. The actual internal value could need up to 8 digits to be printed.

Use StringFromValue() instead where precision matters.

Parameters

aUnits	The units to show the value in. The unit string is added to the message text.
aValue	The double value to convert.
aAddUnitLabel	If true, adds the unit label to the end of the string
aType	Type of the unit being used (e.g. distance, area, etc.)

Returns

The converted string for display in user interface elements.

Definition at line 139 of file base_units.cpp.

{
    wxString      text;
    const wxChar* format;
    double        value = aValue;

    switch( aType )
    {
    case EDA_DATA_TYPE::VOLUME:
        value = To_User_Unit( aUnits, value );
        // Fall through to continue computation
        KI_FALLTHROUGH;

    case EDA_DATA_TYPE::AREA:
        value = To_User_Unit( aUnits, value );
        // Fall through to continue computation
        KI_FALLTHROUGH;

    case EDA_DATA_TYPE::DISTANCE:
        value = To_User_Unit( aUnits, value );
    }

    switch( aUnits )
    {
    default:
    case EDA_UNITS::MILLIMETRES:
#if defined( EESCHEMA )
        format = wxT( "%.2f" );
#else
        format = wxT( "%.4f" );
#endif
        break;

    case EDA_UNITS::MILS:
#if defined( EESCHEMA )
        format = wxT( "%.0f" );
#else
        format = wxT( "%.2f" );
#endif
        break;

    case EDA_UNITS::INCHES:
#if defined( EESCHEMA )
        format = wxT( "%.3f" );
#else
        format = wxT( "%.4f" );
#endif
        break;

    case EDA_UNITS::DEGREES:
        format = wxT( "%.1f" );
        break;

    case EDA_UNITS::UNSCALED:
        format = wxT( "%.0f" );
        break;
    }

    text.Printf( format, value );

    if( aAddUnitLabel )
    {
        text += " ";
        text += GetAbbreviatedUnitsLabel( aUnits, aType );
    }

    return text;
}

References AREA, DEGREES, DISTANCE, GetAbbreviatedUnitsLabel(), INCHES, KI_FALLTHROUGH, MILLIMETRES, MILS, To_User_Unit(), UNSCALED, and VOLUME.

MessageTextFromValue() [2/3]

wxString MessageTextFromValue	(	EDA_UNITS	aUnits,
		int	aValue,
		bool	aAddUnitLabel = true,
		EDA_DATA_TYPE	aType = EDA_DATA_TYPE::DISTANCE
	)

Definition at line 123 of file base_units.cpp.

{
    return MessageTextFromValue( aUnits, double( aValue ), aAddUnitLabel, aType );
}

References MessageTextFromValue().

Referenced by GRID_MENU::BuildChoiceList(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengthViolations(), DRC_TEST_PROVIDER_HOLE_SIZE::checkPad(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkewViolations(), DRC_TEST_PROVIDER_HOLE_SIZE::checkVia(), DIALOG_BOARD_REANNOTATE::CoordTowxString(), GERBVIEW_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayGridMsg(), PCB_BASE_FRAME::DisplayGridMsg(), DIALOG_PAD_PROPERTIES::displayPrimitivesList(), DRC_ENGINE::EvalRulesForItems(), formatCoord(), DIALOG_NET_INSPECTOR::formatLength(), LIB_CIRCLE::GetMsgPanelInfo(), LIB_RECTANGLE::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_ARC::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), LIB_POLYLINE::GetMsgPanelInfo(), LIB_BEZIER::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), WS_DRAW_ITEM_BASE::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), DIMENSION_BASE::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), VIA::GetMsgPanelInfo(), LEADER::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), LIB_RECTANGLE::GetSelectMenuText(), LIB_CIRCLE::GetSelectMenuText(), LIB_ARC::GetSelectMenuText(), WS_DRAW_ITEM_LINE::GetSelectMenuText(), TRACK::GetSelectMenuText(), SCH_LINE::GetSelectMenuText(), WS_DRAW_ITEM_RECT::GetSelectMenuText(), DIALOG_BOARD_REANNOTATE::MakeSampleText(), MessageTextFromValue(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_ANNULUS::Run(), DRC_TEST_PROVIDER_SILK_TO_MASK::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DIALOG_BOARD_STATISTICS::saveReportClicked(), RC_ITEM::ShowCoord(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_HOLE_CLEARANCE::testHoleAgainstHole(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZones(), PNS::MEANDER_SKEW_PLACER::TuningInfo(), PNS::MEANDER_PLACER::TuningInfo(), PNS::DP_MEANDER_PLACER::TuningInfo(), VIA_SIZE_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), DIALOG_BOARD_STATISTICS::updateDrillGrid(), SCH_BASE_FRAME::UpdateStatusBar(), GERBVIEW_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), and DIALOG_BOARD_STATISTICS::updateWidets().

MessageTextFromValue() [3/3]

wxString MessageTextFromValue	(	EDA_UNITS	aUnits,
		long long int	aValue,
		bool	aAddUnitLabel = true,
		EDA_DATA_TYPE	aType = EDA_DATA_TYPE::DISTANCE
	)

Definition at line 131 of file base_units.cpp.

{
    return MessageTextFromValue( aUnits, double( aValue ), aAddUnitLabel, aType );
}

References MessageTextFromValue().

Mils2mm()

int Mils2mm ( double  x )

inline

Convert mils to mm.

Definition at line 65 of file base_units.h.

{ return KiROUND( x * 25.4 / 1000. ); }

References KiROUND().

Referenced by DIALOG_PRINT_GENERIC::initPrintData(), PL_EDITOR_FRAME::ToPrinter(), and DIALOG_PRINT_USING_PRINTER::TransferDataToWindow().

Mm2mils()

int Mm2mils ( double  x )

inline

Convert mm to mils.

Definition at line 62 of file base_units.h.

{ return KiROUND( x * 1000./25.4 ); }

References KiROUND().

Referenced by PCB_PARSER::parsePAGE_INFO(), and SCH_SEXPR_PARSER::parsePAGE_INFO().

StringFromValue()

wxString StringFromValue	(	EDA_UNITS	aUnit,
		double	aValue,
		bool	aAddUnitSymbol = false,
		EDA_DATA_TYPE	aType = EDA_DATA_TYPE::DISTANCE
	)

Function StringFromValue returns the string from aValue according to units (inch, mm ...) for display, and the initial unit for value.

For readability, the mantissa has 3 or more digits (max 8 digits), the trailing 0 are removed if the mantissa has more than 3 digits and some trailing 0 This function should be used to display values in dialogs because a value entered in mm (for instance 2.0 mm) could need up to 8 digits mantissa if displayed in inch to avoid truncation or rounding made just by the printf function. otherwise the actual value is rounded when read from dialog and converted in internal units, and therefore modified.

Parameters

aUnit	= display units (INCHES, MILLIMETRE ..)
aValue	= value in Internal_Unit
aAddUnitSymbol	= true to add symbol unit to the string value

Returns

A wxString object containing value and optionally the symbol unit (like 2.000 mm)

Definition at line 220 of file base_units.cpp.

{
    double  value_to_print = aValue;

    switch( aType )
    {
    case EDA_DATA_TYPE::VOLUME:
        value_to_print = To_User_Unit( aUnits, value_to_print );
        KI_FALLTHROUGH;

    case EDA_DATA_TYPE::AREA:
        value_to_print = To_User_Unit( aUnits, value_to_print );
        KI_FALLTHROUGH;

    case EDA_DATA_TYPE::DISTANCE:
        value_to_print = To_User_Unit( aUnits, value_to_print );
    }


#if defined( EESCHEMA )
    wxString    stringValue = wxString::Format( wxT( "%.3f" ), value_to_print );

    // Strip trailing zeros. However, keep at least 3 digits in mantissa
    // For readability
    StripTrailingZeros( stringValue, 3 );

#else

    char    buf[50];
    int     len;

    if( value_to_print != 0.0 && fabs( value_to_print ) <= 0.0001 )
    {
        len = sprintf( buf, "%.10f", value_to_print );

        while( --len > 0 && buf[len] == '0' )
            buf[len] = '\0';

        if( buf[len]=='.' || buf[len]==',' )
            buf[len] = '\0';
        else
            ++len;
    }
    else
    {
        if( aUnits == EDA_UNITS::MILS )
            len = sprintf( buf, "%.7g", value_to_print );
        else
            len = sprintf( buf, "%.10g", value_to_print );
    }

    wxString    stringValue( buf, wxConvUTF8 );

#endif

    if( aAddUnitSymbol )
    {
        switch( aUnits )
        {
        case EDA_UNITS::MILLIMETRES:
            stringValue += wxT( " mm" );
            break;

        case EDA_UNITS::DEGREES:
            stringValue += wxT( " deg" );
            break;

        case EDA_UNITS::MILS:
            stringValue += wxT( " mils" );
            break;

        case EDA_UNITS::INCHES:
            stringValue += wxT( " in" );
            break;

        case EDA_UNITS::PERCENT:
            stringValue += wxT( "%" );
            break;

        case EDA_UNITS::UNSCALED:
            break;
        }
    }

    return stringValue;
}

References AREA, DEGREES, DISTANCE, Format(), INCHES, KI_FALLTHROUGH, MILLIMETRES, MILS, PERCENT, StripTrailingZeros(), To_User_Unit(), UNSCALED, and VOLUME.

Referenced by PANEL_SETUP_TRACKS_AND_VIAS::AppendDiffPairs(), PANEL_SETUP_TRACKS_AND_VIAS::AppendTrackWidth(), PANEL_SETUP_TRACKS_AND_VIAS::AppendViaSize(), DIALOG_PLOT::applyPlotSettings(), BuildStackupReport(), UNIT_BINDER::ChangeValue(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), PANEL_SETUP_BOARD_STACKUP::createRowData(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), SCH_PIN::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), TEXT_MOD_GRID_TABLE::GetValue(), PIN_TABLE_DATA_MODEL::GetValue(), FIELDS_GRID_TABLE< SCH_FIELD >::GetValue(), DIALOG_PLOT::init_Dialog(), DIALOG_PAD_PROPERTIES::initValues(), PCB_INSPECTION_TOOL::InspectConstraints(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PANEL_SETUP_BOARD_STACKUP::onCalculateDielectricThickness(), PANEL_SETUP_BOARD_STACKUP::onUpdateThicknessValue(), DIALOG_PAD_PROPERTIES::padValuesOK(), PCB_INSPECTION_TOOL::reportClearance(), PCB_INSPECTION_TOOL::reportZoneConnection(), UNIT_BINDER::SetDoubleValue(), UNIT_BINDER::SetValue(), EDA_POSITION_CTRL::SetValue(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), PANEL_SETUP_FEATURE_CONSTRAINTS::TransferDataToWindow(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataToWindow(), UNIT_BINDER::Validate(), and PANEL_SETUP_TRACKS_AND_VIAS::validateData().

To_User_Unit()

double To_User_Unit	(	EDA_UNITS	aUnit,
		double	aValue
	)

Function To_User_Unit convert aValue in internal units to the appropriate user units defined by aUnit.

Returns

The converted value, in double

Parameters

aUnit	The units to convert aValue to.
aValue	The value in internal units to convert.

Definition at line 91 of file base_units.cpp.

{
    switch( aUnit )
    {
    case EDA_UNITS::MILLIMETRES:
        return IU_TO_MM( aValue );

    case EDA_UNITS::MILS:
        return IU_TO_MILS( aValue );

    case EDA_UNITS::INCHES:
        return IU_TO_IN( aValue );

    case EDA_UNITS::DEGREES:
        return aValue / 10.0f;

    default:
        return aValue;
    }
}

References DEGREES, INCHES, MILLIMETRES, and MILS.

Referenced by ComboBoxUnits(), KIGFX::PREVIEW::DimensionLabel(), PL_EDITOR_FRAME::DisplayGridMsg(), DIMENSION_BASE::GetValueText(), MessageTextFromValue(), StringFromValue(), and PL_EDITOR_FRAME::UpdateStatusBar().

ValueFromString()

long long int ValueFromString	(	EDA_UNITS	aUnits,
		const wxString &	aTextValue,
		EDA_DATA_TYPE	aType = EDA_DATA_TYPE::DISTANCE
	)

Function ValueFromString converts aTextValue in aUnits to internal units used by the application.

Warning

This utilizes the current locale and will break if decimal formats differ

Parameters

aUnits	The units of aTextValue.
aTextValue	A reference to a wxString object containing the string to convert.

Returns

The string from Value, according to units (inch, mm ...) for display,

Definition at line 444 of file base_units.cpp.

{
    double value = DoubleValueFromString( aUnits, aTextValue, aType );
    return KiROUND<double, long long int>( value );
}

References DoubleValueFromString().

Referenced by GRID_MENU::BuildChoiceList(), PIN_TABLE_DATA_MODEL::compare(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), PANEL_FP_EDITOR_DEFAULTS::getGridValue(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), PANEL_SETUP_BOARD_STACKUP::GetPcbThickness(), DIALOG_ANNOTATE::GetStartNumber(), UNIT_BINDER::GetValue(), EDA_POSITION_CTRL::GetValue(), FOOTPRINT_PREVIEW_PANEL::New(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::onCellChanging(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), PANEL_SETUP_BOARD_STACKUP::onUpdateThicknessValue(), COMMON_TOOLS::Reset(), TEXT_MOD_GRID_TABLE::SetValue(), FIELDS_GRID_TABLE< SCH_FIELD >::SetValue(), PIN_TABLE_DATA_MODEL::SetValue(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), and PANEL_SETUP_TRACKS_AND_VIAS::validateData().