SPICE_VALUE Class Reference

< Helper class to handle Spice way of expressing values (e.g. 10.5 Meg) Helper class to recognize Spice formatted values More...

#include <spice_value.h>

Public Types
enum	UNIT_PREFIX {   PFX_FEMTO = -15, PFX_PICO = -12, PFX_NANO = -9, PFX_MICRO = -6,   PFX_MILI = -3, PFX_NONE = 0, PFX_KILO = 3, PFX_MEGA = 6,   PFX_GIGA = 9, PFX_TERA = 12 }

Public Member Functions
	SPICE_VALUE ()
	Parses the string to create a Spice value (e.g. 100n) More...
	SPICE_VALUE (const wxString &aString)
	SPICE_VALUE (int aInt, UNIT_PREFIX aPrefix=PFX_NONE)
	SPICE_VALUE (double aDouble, UNIT_PREFIX aPrefix=PFX_NONE)
void	Normalize ()
	Normalize the value. More...
double	ToDouble () const
wxString	ToString () const
	Return string value as when converting double to string (e.g. More...
wxString	ToSpiceString () const
	Return string value in Spice format (e.g. More...
wxString	ToOrigString () const
	Return either a normal string or Spice format string, depending on the original value format. More...
bool	IsSpiceString () const
	Return true if the object was initiated with a Spice formatted string value. More...
bool	operator== (const SPICE_VALUE &aOther) const
bool	operator> (const SPICE_VALUE &aOther) const
bool	operator< (const SPICE_VALUE &aOther) const
bool	operator>= (const SPICE_VALUE &aOther) const
bool	operator<= (const SPICE_VALUE &aOther) const
SPICE_VALUE	operator- (const SPICE_VALUE &aOther) const
SPICE_VALUE	operator+ (const SPICE_VALUE &aOther) const
SPICE_VALUE	operator * (const SPICE_VALUE &aOther) const
SPICE_VALUE	operator/ (const SPICE_VALUE &aOther) const

Static Private Member Functions
static void	stripZeros (wxString &aString)
	< Remove redundant zeros from the end of a string. More...

Private Attributes
double	m_base
UNIT_PREFIX	m_prefix
	Was the value defined using the Spice notation? More...
bool	m_spiceStr

Detailed Description

< Helper class to handle Spice way of expressing values (e.g. 10.5 Meg) Helper class to recognize Spice formatted values

Definition at line 34 of file spice_value.h.

Member Enumeration Documentation

UNIT_PREFIX

enum SPICE_VALUE::UNIT_PREFIX

Enumerator
PFX_FEMTO
PFX_PICO
PFX_NANO
PFX_MICRO
PFX_MILI
PFX_NONE
PFX_KILO
PFX_MEGA
PFX_GIGA
PFX_TERA

Definition at line 37 of file spice_value.h.

    {
        PFX_FEMTO   = -15,
        PFX_PICO    = -12,
        PFX_NANO    = -9,
        PFX_MICRO   = -6,
        PFX_MILI    = -3,
        PFX_NONE    = 0,
        PFX_KILO    = 3,
        PFX_MEGA    = 6,
        PFX_GIGA    = 9,
        PFX_TERA    = 12
    };

Constructor & Destructor Documentation

SPICE_VALUE() [1/4]

SPICE_VALUE::SPICE_VALUE ( )

inline

Parses the string to create a Spice value (e.g. 100n)

Definition at line 51 of file spice_value.h.

SPICE_VALUE() [2/4]

SPICE_VALUE::SPICE_VALUE

(

const wxString &

aString

)

Definition at line 37 of file spice_value.cpp.

{
    char buf[8] = { 0, };

    if( aString.IsEmpty() )
        throw KI_PARAM_ERROR( _( "Spice value cannot be empty" ) );

    LOCALE_IO dummy;    // All numeric values should be in "C" locale(decimal separator = .)

    if( sscanf( (const char*) aString.c_str(), "%lf%7s", &m_base, buf ) == 0 )
        throw KI_PARAM_ERROR( _( "Invalid Spice value string" ) );

    if( *buf == 0 )
    {
        m_prefix = PFX_NONE;
        m_spiceStr = false;
        Normalize();
        return;
    }

    m_spiceStr = true;

    for( char* bufPtr = buf; *bufPtr; ++bufPtr )
        *bufPtr = tolower( *bufPtr );

    if( !strcmp( buf, "meg" ) )
    {
        m_prefix = PFX_MEGA;
    }
    else
    {
        switch( buf[0] )
        {
            case 'f': m_prefix = PFX_FEMTO; break;
            case 'p': m_prefix = PFX_PICO; break;
            case 'n': m_prefix = PFX_NANO; break;
            case 'u': m_prefix = PFX_MICRO; break;
            case 'm': m_prefix = PFX_MILI; break;
            case 'k': m_prefix = PFX_KILO; break;
            case 'g': m_prefix = PFX_GIGA; break;
            case 't': m_prefix = PFX_TERA; break;

            default:
                throw KI_PARAM_ERROR( _( "Invalid unit prefix" ) );
        }
    }

    Normalize();
}

References _, dummy(), m_base, m_prefix, m_spiceStr, Normalize(), PFX_FEMTO, PFX_GIGA, PFX_KILO, PFX_MEGA, PFX_MICRO, PFX_MILI, PFX_NANO, PFX_NONE, PFX_PICO, and PFX_TERA.

SPICE_VALUE() [3/4]

SPICE_VALUE::SPICE_VALUE ( int  aInt, UNIT_PREFIX  aPrefix = PFX_NONE  )

inline

Definition at line 59 of file spice_value.h.

        : m_base( aInt ), m_prefix( aPrefix ), m_spiceStr( false )
    {
        Normalize();
    }

References Normalize().

SPICE_VALUE() [4/4]

SPICE_VALUE::SPICE_VALUE ( double  aDouble, UNIT_PREFIX  aPrefix = PFX_NONE  )

inline

Definition at line 65 of file spice_value.h.

        : m_base( aDouble ), m_prefix( aPrefix ), m_spiceStr( false )
    {
        Normalize();
    }

References Normalize().

Member Function Documentation

IsSpiceString()

bool SPICE_VALUE::IsSpiceString ( ) const

inline

Return true if the object was initiated with a Spice formatted string value.

Definition at line 100 of file spice_value.h.

    {
        return m_spiceStr;
    }

References m_spiceStr.

Referenced by TUNER_SLIDER::updateValueText().

Normalize()

void SPICE_VALUE::Normalize

(

)

Normalize the value.

The unit prefix is picked so the base is (0.001 <= base < 1000).

Definition at line 88 of file spice_value.cpp.

{
    while( std::fabs( m_base ) >= 1000.0 )
    {
        m_base *= 0.001;
        m_prefix = (UNIT_PREFIX)( m_prefix + 3 );

        if( m_prefix == PFX_TERA )     // this is the biggest unit available
            break;
    }

    while( m_base != 0.0 && std::fabs( m_base ) < 1.000 )
    {
        m_base *= 1000.0;
        m_prefix = (UNIT_PREFIX)( m_prefix - 3 );

        if( m_prefix == PFX_FEMTO )     // this is the smallest unit available
            break;
    }
}

References m_base, m_prefix, PFX_FEMTO, and PFX_TERA.

Referenced by operator *(), operator+(), operator-(), operator/(), and SPICE_VALUE().

operator *()

SPICE_VALUE SPICE_VALUE::operator *

(

const SPICE_VALUE &

aOther

)

const

Definition at line 214 of file spice_value.cpp.

{
    SPICE_VALUE res( m_base * aOther.m_base, (UNIT_PREFIX)( m_prefix + aOther.m_prefix ) );
    res.m_spiceStr = m_spiceStr || aOther.m_spiceStr;
    res.Normalize();

    return res;
}

References m_base, m_prefix, m_spiceStr, and Normalize().

operator+()

SPICE_VALUE SPICE_VALUE::operator+

(

const SPICE_VALUE &

aOther

)

const

Definition at line 152 of file spice_value.cpp.

{
    int prefixDiff = m_prefix - aOther.m_prefix;
    SPICE_VALUE res;
    res.m_spiceStr = m_spiceStr || aOther.m_spiceStr;

    // Convert both numbers to a common prefix
    if( prefixDiff > 0 )
    {
        // Switch to the aOther prefix
        res.m_base =  ( m_base * std::pow( 10, prefixDiff ) ) + aOther.m_base;
        res.m_prefix = aOther.m_prefix;
    }
    else if( prefixDiff < 0 )
    {
        // Use the current prefix
        res.m_base = m_base + ( aOther.m_base * std::pow( 10, -prefixDiff ) );
        res.m_prefix = m_prefix;
    }
    else
    {
        res.m_base = m_base + aOther.m_base;
        res.m_prefix = m_prefix; // == aOther.m_prefix
    }

    res.Normalize();

    return res;
}

References m_base, m_prefix, m_spiceStr, and Normalize().

operator-()

SPICE_VALUE SPICE_VALUE::operator-

(

const SPICE_VALUE &

aOther

)

const

Definition at line 183 of file spice_value.cpp.

{
    int prefixDiff = m_prefix - aOther.m_prefix;
    SPICE_VALUE res;
    res.m_spiceStr = m_spiceStr || aOther.m_spiceStr;

    // Convert both numbers to a common prefix
    if( prefixDiff > 0 )
    {
        // Switch to the aOther prefix
        res.m_base = m_base * std::pow( 10, prefixDiff ) - aOther.m_base;
        res.m_prefix = aOther.m_prefix;
    }
    else if( prefixDiff < 0 )
    {
        // Use the current prefix
        res.m_base = m_base - aOther.m_base * std::pow( 10, -prefixDiff );
        res.m_prefix = m_prefix;
    }
    else
    {
        res.m_base = m_base - aOther.m_base;
        res.m_prefix = m_prefix; // == aOther.m_prefix
    }

    res.Normalize();

    return res;
}

References m_base, m_prefix, m_spiceStr, and Normalize().

operator/()

SPICE_VALUE SPICE_VALUE::operator/

(

const SPICE_VALUE &

aOther

)

const

Definition at line 224 of file spice_value.cpp.

{
    SPICE_VALUE res( m_base / aOther.m_base, (UNIT_PREFIX)( m_prefix - aOther.m_prefix ) );
    res.m_spiceStr = m_spiceStr || aOther.m_spiceStr;
    res.Normalize();

    return res;
}

References m_base, m_prefix, m_spiceStr, and Normalize().

operator<()

bool SPICE_VALUE::operator< ( const SPICE_VALUE &  aOther ) const

inline

Definition at line 115 of file spice_value.h.

    {
        return this->ToDouble() < aOther.ToDouble();
    }

References ToDouble().

operator<=()

bool SPICE_VALUE::operator<= ( const SPICE_VALUE &  aOther ) const

inline

Definition at line 125 of file spice_value.h.

    {
        return ( *this == aOther || *this < aOther );
    }

operator==()

bool SPICE_VALUE::operator== ( const SPICE_VALUE &  aOther ) const

inline

Definition at line 105 of file spice_value.h.

    {
        return ( m_prefix == aOther.m_prefix && m_base == aOther.m_base );
    }

References m_base, and m_prefix.

operator>()

bool SPICE_VALUE::operator> ( const SPICE_VALUE &  aOther ) const

inline

Definition at line 110 of file spice_value.h.

    {
        return this->ToDouble() > aOther.ToDouble();
    }

References ToDouble().

operator>=()

bool SPICE_VALUE::operator>= ( const SPICE_VALUE &  aOther ) const

inline

Definition at line 120 of file spice_value.h.

    {
        return ( *this == aOther || *this > aOther );
    }

stripZeros()

void SPICE_VALUE::stripZeros ( wxString &  aString )

staticprivate

< Remove redundant zeros from the end of a string.

Definition at line 234 of file spice_value.cpp.

{
    if ( aString.Find( ',' ) >= 0 || aString.Find( '.' ) >= 0 )
    {
        while( aString.EndsWith( '0' ) )
            aString.RemoveLast();

        if( aString.EndsWith( '.' ) || aString.EndsWith( ',' ) )
            aString.RemoveLast();
    }
}

Referenced by ToSpiceString(), and ToString().

ToDouble()

double SPICE_VALUE::ToDouble

(

)

const

Definition at line 110 of file spice_value.cpp.

{
    double res = m_base;

    if( m_prefix != PFX_NONE )
        res *= std::pow( 10, (int) m_prefix );

    return res;
}

References m_base, m_prefix, and PFX_NONE.

Referenced by operator<(), operator>(), DIALOG_SIM_SETTINGS::parseCommand(), and ToString().

ToOrigString()

wxString SPICE_VALUE::ToOrigString ( ) const

inline

Return either a normal string or Spice format string, depending on the original value format.

Definition at line 92 of file spice_value.h.

    {
        return m_spiceStr ? ToSpiceString() : ToString();
    }

References m_spiceStr, ToSpiceString(), and ToString().

Referenced by TUNER_SLIDER::onMaxTextEnter(), TUNER_SLIDER::onMinTextEnter(), TUNER_SLIDER::onSave(), TUNER_SLIDER::onValueTextEnter(), TUNER_SLIDER::SetMax(), TUNER_SLIDER::SetMin(), and TUNER_SLIDER::TUNER_SLIDER().

ToSpiceString()

wxString SPICE_VALUE::ToSpiceString

(

)

const

Return string value in Spice format (e.g.

123.3456789k).

Definition at line 129 of file spice_value.cpp.

{
    wxString res = wxString::FromCDouble( m_base );
    stripZeros( res );

    switch( m_prefix )
    {
        case PFX_FEMTO: res += "f"; break;
        case PFX_PICO:  res += "p"; break;
        case PFX_NANO:  res += "n"; break;
        case PFX_MICRO: res += "u"; break;
        case PFX_MILI:  res += "m"; break;
        case PFX_NONE:  break;
        case PFX_KILO:  res += "k"; break;
        case PFX_MEGA:  res += "Meg"; break;
        case PFX_GIGA:  res += "G"; break;
        case PFX_TERA:  res += "T"; break;
    }

    return res;
}

References m_base, m_prefix, PFX_FEMTO, PFX_GIGA, PFX_KILO, PFX_MEGA, PFX_MICRO, PFX_MILI, PFX_NANO, PFX_NONE, PFX_PICO, PFX_TERA, and stripZeros().

Referenced by SIM_PLOT_FRAME::onCursorUpdate(), DIALOG_SIM_SETTINGS::parseCommand(), DIALOG_SPICE_MODEL::parsePowerSource(), ToOrigString(), and TUNER_SLIDER::updateValueText().

ToString()

wxString SPICE_VALUE::ToString

(

)

const

Return string value as when converting double to string (e.g.

123456.789).

Definition at line 120 of file spice_value.cpp.

{
    wxString res( wxString::Format( "%.3f", ToDouble() ) );
    stripZeros( res );

    return res;
}

References Format(), stripZeros(), and ToDouble().

Referenced by ToOrigString(), SIM_PLOT_FRAME::updatePlot(), and TUNER_SLIDER::updateValueText().

Member Data Documentation

m_base

double SPICE_VALUE::m_base

private

Definition at line 139 of file spice_value.h.

Referenced by Normalize(), operator *(), operator+(), operator-(), operator/(), operator==(), SPICE_VALUE(), ToDouble(), and ToSpiceString().

m_prefix

UNIT_PREFIX SPICE_VALUE::m_prefix

private

Was the value defined using the Spice notation?

Definition at line 140 of file spice_value.h.

Referenced by Normalize(), operator *(), operator+(), operator-(), operator/(), operator==(), SPICE_VALUE(), ToDouble(), and ToSpiceString().

m_spiceStr

bool SPICE_VALUE::m_spiceStr

private

Definition at line 143 of file spice_value.h.

Referenced by IsSpiceString(), operator *(), operator+(), operator-(), operator/(), SPICE_VALUE(), and ToOrigString().

---

The documentation for this class was generated from the following files:

• spice_value.h
• spice_value.cpp