PIN_TABLE_DATA_MODEL Class Reference

Inheritance diagram for PIN_TABLE_DATA_MODEL:

Public Member Functions
	PIN_TABLE_DATA_MODEL (EDA_UNITS aUserUnits)
int	GetNumberRows () override
int	GetNumberCols () override
wxString	GetColLabelValue (int aCol) override
bool	IsEmptyCell (int row, int col) override
wxString	GetValue (int aRow, int aCol) override
void	SetValue (int aRow, int aCol, const wxString &aValue) override
void	RebuildRows (const LIB_PINS &aPins, bool groupByName)
void	SortRows (int aSortCol, bool ascending)
void	SortPins (LIB_PINS &aRow)
void	AppendRow (LIB_PIN *aPin)
LIB_PINS	RemoveRow (int aRow)
bool	IsEdited ()

Static Public Member Functions
static wxString	GetValue (const LIB_PINS &pins, int aCol, EDA_UNITS aUserUnits)
static int	findRow (const std::vector< LIB_PINS > &aRowSet, const wxString &aName)
static bool	compare (const LIB_PINS &lhs, const LIB_PINS &rhs, int sortCol, bool ascending, EDA_UNITS units)

Static Private Member Functions
static wxString	StringFromBool (bool aValue)
static bool	BoolFromString (wxString aValue)

Private Attributes
std::vector< LIB_PINS >	m_rows
EDA_UNITS	m_userUnits
bool	m_edited

Detailed Description

Definition at line 38 of file dialog_lib_edit_pin_table.cpp.

Constructor & Destructor Documentation

PIN_TABLE_DATA_MODEL()

PIN_TABLE_DATA_MODEL::PIN_TABLE_DATA_MODEL ( EDA_UNITS  aUserUnits )

inline

Definition at line 41 of file dialog_lib_edit_pin_table.cpp.

                                                 : m_userUnits( aUserUnits ), m_edited( false )
    {
    }

Member Function Documentation

AppendRow()

void PIN_TABLE_DATA_MODEL::AppendRow ( LIB_PIN *  aPin )

inline

Definition at line 349 of file dialog_lib_edit_pin_table.cpp.

    {
        LIB_PINS row;
        row.push_back( aPin );
        m_rows.push_back( row );

        if ( GetView() )
        {
            wxGridTableMessage msg( this, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, 1 );
            GetView()->ProcessTableMessage( msg );
        }
    }

References m_rows.

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow().

BoolFromString()

static bool PIN_TABLE_DATA_MODEL::BoolFromString ( wxString  aValue )

inlinestaticprivate

Definition at line 391 of file dialog_lib_edit_pin_table.cpp.

    {
        if( aValue == "1" )
        {
            return true;
        }
        else if( aValue == "0" )
        {
            return false;
        }
        else
        {
            wxFAIL_MSG( wxString::Format( "string \"%s\" can't be converted to boolean "
                                          "correctly, it will have been perceived as FALSE",
                                          aValue ) );
            return false;
        }
    }

References Format().

Referenced by SetValue().

compare()

static bool PIN_TABLE_DATA_MODEL::compare ( const LIB_PINS &  lhs, const LIB_PINS &  rhs, int  sortCol, bool  ascending, EDA_UNITS  units  )

inlinestatic

Definition at line 228 of file dialog_lib_edit_pin_table.cpp.

    {
        wxString lhStr = GetValue( lhs, sortCol, units );
        wxString rhStr = GetValue( rhs, sortCol, units );

        if( lhStr == rhStr )
        {
            // Secondary sort key is always COL_NUMBER
            sortCol = COL_NUMBER;
            lhStr = GetValue( lhs, sortCol, units );
            rhStr = GetValue( rhs, sortCol, units );
        }

        bool res;

        // N.B. To meet the iterator sort conditions, we cannot simply invert the truth
        // to get the opposite sort.  i.e. ~(a<b) != (a>b)
        auto cmp = [ ascending ]( const auto a, const auto b )
                   {
                       if( ascending )
                           return a < b;
                       else
                           return b < a;
                   };

        switch( sortCol )
        {
        case COL_NUMBER:
        case COL_NAME:
            res = cmp( PinNumbers::Compare( lhStr, rhStr ), 0 );
            break;
        case COL_NUMBER_SIZE:
        case COL_NAME_SIZE:
            res = cmp( ValueFromString( units, lhStr ),
                    ValueFromString( units, rhStr ) );
            break;
        case COL_LENGTH:
        case COL_POSX:
        case COL_POSY:
            res = cmp( ValueFromString( units, lhStr ), ValueFromString( units, rhStr ) );
            break;
        case COL_VISIBLE:
        default:
            res = cmp( StrNumCmp( lhStr, rhStr ), 0 );
            break;
        }

        return res;
    }

References COL_LENGTH, COL_NAME, COL_NAME_SIZE, COL_NUMBER, COL_NUMBER_SIZE, COL_POSX, COL_POSY, COL_VISIBLE, PinNumbers::Compare(), GetValue(), StrNumCmp(), and ValueFromString().

Referenced by SortRows().

findRow()

static int PIN_TABLE_DATA_MODEL::findRow ( const std::vector< LIB_PINS > &  aRowSet, const wxString &  aName  )

inlinestatic

Definition at line 217 of file dialog_lib_edit_pin_table.cpp.

    {
        for( size_t i = 0; i < aRowSet.size(); ++i )
        {
            if( aRowSet[ i ][ 0 ] && aRowSet[ i ][ 0 ]->GetName() == aName )
                return i;
        }

        return -1;
    }

Referenced by RebuildRows().

GetColLabelValue()

wxString PIN_TABLE_DATA_MODEL::GetColLabelValue ( int  aCol )

inlineoverride

Definition at line 48 of file dialog_lib_edit_pin_table.cpp.

    {
        switch( aCol )
        {
        case COL_NUMBER:       return _( "Number" );
        case COL_NAME:         return _( "Name" );
        case COL_TYPE:         return _( "Electrical Type" );
        case COL_SHAPE:        return _( "Graphic Style" );
        case COL_ORIENTATION:  return _( "Orientation" );
        case COL_NUMBER_SIZE:  return _( "Number Text Size" );
        case COL_NAME_SIZE:    return _( "Name Text Size" );
        case COL_LENGTH:       return _( "Length" );
        case COL_POSX:         return _( "X Position" );
        case COL_POSY:         return _( "Y Position" );
        case COL_VISIBLE:      return _( "Visible" );
        default:               wxFAIL; return wxEmptyString;
        }
    }

References _, COL_LENGTH, COL_NAME, COL_NAME_SIZE, COL_NUMBER, COL_NUMBER_SIZE, COL_ORIENTATION, COL_POSX, COL_POSY, COL_SHAPE, COL_TYPE, and COL_VISIBLE.

GetNumberCols()

int PIN_TABLE_DATA_MODEL::GetNumberCols ( )

inlineoverride

Definition at line 46 of file dialog_lib_edit_pin_table.cpp.

{ return COL_COUNT; }

References COL_COUNT.

GetNumberRows()

int PIN_TABLE_DATA_MODEL::GetNumberRows ( )

inlineoverride

Definition at line 45 of file dialog_lib_edit_pin_table.cpp.

{ return (int) m_rows.size(); }

References m_rows.

GetValue() [1/2]

wxString PIN_TABLE_DATA_MODEL::GetValue ( int  aRow, int  aCol  )

inlineoverride

Definition at line 72 of file dialog_lib_edit_pin_table.cpp.

    {
        return GetValue( m_rows[ aRow ], aCol, m_userUnits );
    }

References m_rows, and m_userUnits.

Referenced by compare().

GetValue() [2/2]

static wxString PIN_TABLE_DATA_MODEL::GetValue ( const LIB_PINS &  pins, int  aCol, EDA_UNITS  aUserUnits  )

inlinestatic

Definition at line 77 of file dialog_lib_edit_pin_table.cpp.

    {
        wxString fieldValue;

        if( pins.empty() )
            return fieldValue;

        for( LIB_PIN* pin : pins )
        {
            wxString val;

            switch( aCol )
            {
            case COL_NUMBER:
                val = pin->GetNumber();
                break;
            case COL_NAME:
                val = pin->GetName();
                break;
            case COL_TYPE:
                val = PinTypeNames()[static_cast<int>( pin->GetType() )];
                break;
            case COL_SHAPE:
                val = PinShapeNames()[static_cast<int>( pin->GetShape() )];
                break;
            case COL_ORIENTATION:
                if( PinOrientationIndex( pin->GetOrientation() ) >= 0 )
                    val = PinOrientationNames()[ PinOrientationIndex( pin->GetOrientation() ) ];
                break;
            case COL_NUMBER_SIZE:
                val = StringFromValue( aUserUnits, pin->GetNumberTextSize(), true );
                break;
            case COL_NAME_SIZE:
                val = StringFromValue( aUserUnits, pin->GetNameTextSize(), true );
                break;
            case COL_LENGTH:
                val = StringFromValue( aUserUnits, pin->GetLength() );
                break;
            case COL_POSX:
                val = StringFromValue( aUserUnits, pin->GetPosition().x );
                break;
            case COL_POSY:
                val = StringFromValue( aUserUnits, pin->GetPosition().y );
                break;
            case COL_VISIBLE:
                val = StringFromBool( pin->IsVisible() );
                break;
            default:
                wxFAIL;
                break;
            }

            if( aCol == COL_NUMBER )
            {
                if( fieldValue.length() )
                    fieldValue += wxT( ", " );
                fieldValue += val;
            }
            else
            {
                if( !fieldValue.Length() )
                    fieldValue = val;
                else if( val != fieldValue )
                    fieldValue = INDETERMINATE_STATE;
            }
        }

        return fieldValue;
    }

References COL_LENGTH, COL_NAME, COL_NAME_SIZE, COL_NUMBER, COL_NUMBER_SIZE, COL_ORIENTATION, COL_POSX, COL_POSY, COL_SHAPE, COL_TYPE, COL_VISIBLE, INDETERMINATE_STATE, pin, PinOrientationIndex(), PinOrientationNames(), PinShapeNames(), PinTypeNames(), StringFromBool(), and StringFromValue().

IsEdited()

bool PIN_TABLE_DATA_MODEL::IsEdited ( )

inline

Definition at line 377 of file dialog_lib_edit_pin_table.cpp.

    {
        return m_edited;
    }

References m_edited.

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::OnClose().

IsEmptyCell()

bool PIN_TABLE_DATA_MODEL::IsEmptyCell ( int  row, int  col  )

inlineoverride

Definition at line 67 of file dialog_lib_edit_pin_table.cpp.

    {
        return false;   // don't allow adjacent cell overflow, even if we are actually empty
    }

RebuildRows()

void PIN_TABLE_DATA_MODEL::RebuildRows ( const LIB_PINS &  aPins, bool  groupByName  )

inline

Definition at line 279 of file dialog_lib_edit_pin_table.cpp.

    {
        if ( GetView() )
        {
            // Commit any pending in-place edits before the row gets moved out from under
            // the editor.
            if( auto grid = dynamic_cast<WX_GRID*>( GetView() ) )
                grid->CommitPendingChanges( true );

            wxGridTableMessage msg( this, wxGRIDTABLE_NOTIFY_ROWS_DELETED, 0, m_rows.size() );
            GetView()->ProcessTableMessage( msg );
        }

        m_rows.clear();

        for( LIB_PIN* pin : aPins )
        {
            int      rowIndex = -1;

            if( groupByName )
                rowIndex = findRow( m_rows, pin->GetName() );

            if( rowIndex < 0 )
            {
                m_rows.emplace_back( LIB_PINS() );
                rowIndex = m_rows.size() - 1;
            }

            m_rows[ rowIndex ].push_back( pin );
        }

        int sortCol = 0;
        bool ascending = true;

        if( GetView() && GetView()->GetSortingColumn() != wxNOT_FOUND )
        {
            sortCol = GetView()->GetSortingColumn();
            ascending = GetView()->IsSortOrderAscending();
        }

        for( LIB_PINS& row : m_rows )
            SortPins( row );

        SortRows( sortCol, ascending );

        if ( GetView() )
        {
            wxGridTableMessage msg( this, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, m_rows.size() );
            GetView()->ProcessTableMessage( msg );
        }
    }

References findRow(), grid, m_rows, pin, SortPins(), and SortRows().

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::OnRebuildRows(), and DIALOG_LIB_EDIT_PIN_TABLE::TransferDataToWindow().

RemoveRow()

LIB_PINS PIN_TABLE_DATA_MODEL::RemoveRow ( int  aRow )

inline

Definition at line 362 of file dialog_lib_edit_pin_table.cpp.

    {
        LIB_PINS removedRow = m_rows[ aRow ];

        m_rows.erase( m_rows.begin() + aRow );

        if ( GetView() )
        {
            wxGridTableMessage msg( this, wxGRIDTABLE_NOTIFY_ROWS_DELETED, aRow, 1 );
            GetView()->ProcessTableMessage( msg );
        }

        return removedRow;
    }

References m_rows.

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::OnDeleteRow().

SetValue()

void PIN_TABLE_DATA_MODEL::SetValue ( int  aRow, int  aCol, const wxString &  aValue  )

inlineoverride

Definition at line 147 of file dialog_lib_edit_pin_table.cpp.

    {
        if( aValue == INDETERMINATE_STATE )
            return;

        LIB_PINS pins = m_rows[ aRow ];

        for( LIB_PIN* pin : pins )
        {
            switch( aCol )
            {
            case COL_NUMBER:
                pin->SetNumber( aValue );
                break;

            case COL_NAME:
                pin->SetName( aValue );
                break;

            case COL_TYPE:
                if( PinTypeNames().Index( aValue ) != wxNOT_FOUND )
                    pin->SetType( (ELECTRICAL_PINTYPE) PinTypeNames().Index( aValue ) );

                break;

            case COL_SHAPE:
                if( PinShapeNames().Index( aValue ) != wxNOT_FOUND )
                    pin->SetShape( (GRAPHIC_PINSHAPE) PinShapeNames().Index( aValue ) );

                break;

            case COL_ORIENTATION:
                if( PinOrientationNames().Index( aValue ) != wxNOT_FOUND )
                    pin->SetOrientation( PinOrientationCode( PinOrientationNames().Index( aValue ) ) );
                break;

            case COL_NUMBER_SIZE:
                pin->SetNumberTextSize( ValueFromString( m_userUnits, aValue ) );
                break;

            case COL_NAME_SIZE:
                pin->SetNameTextSize( ValueFromString( m_userUnits, aValue ) );
                break;

            case COL_LENGTH:
                pin->SetLength( ValueFromString( m_userUnits, aValue ) );
                break;

            case COL_POSX:
                pin->SetPosition( wxPoint( ValueFromString( m_userUnits, aValue ),
                                           pin->GetPosition().y ) );
                break;

            case COL_POSY:
                pin->SetPosition( wxPoint( pin->GetPosition().x,
                                           ValueFromString( m_userUnits, aValue ) ) );
                break;

            case COL_VISIBLE:
                pin->SetVisible(BoolFromString( aValue ));
                break;
            default:
                wxFAIL;
                break;
            }
        }

        m_edited = true;
    }

References BoolFromString(), COL_LENGTH, COL_NAME, COL_NAME_SIZE, COL_NUMBER, COL_NUMBER_SIZE, COL_ORIENTATION, COL_POSX, COL_POSY, COL_SHAPE, COL_TYPE, COL_VISIBLE, INDETERMINATE_STATE, m_edited, m_rows, m_userUnits, pin, PinOrientationCode(), PinOrientationNames(), PinShapeNames(), PinTypeNames(), and ValueFromString().

SortPins()

void PIN_TABLE_DATA_MODEL::SortPins ( LIB_PINS &  aRow )

inline

Definition at line 340 of file dialog_lib_edit_pin_table.cpp.

    {
        std::sort( aRow.begin(), aRow.end(),
                   []( LIB_PIN* lhs, LIB_PIN* rhs ) -> bool
                   {
                       return PinNumbers::Compare( lhs->GetNumber(), rhs->GetNumber() ) < 0;
                   } );
    }

References PinNumbers::Compare(), and LIB_PIN::GetNumber().

Referenced by RebuildRows().

SortRows()

void PIN_TABLE_DATA_MODEL::SortRows ( int  aSortCol, bool  ascending  )

inline

Definition at line 331 of file dialog_lib_edit_pin_table.cpp.

    {
        std::sort( m_rows.begin(), m_rows.end(),
                   [ aSortCol, ascending, this ]( const LIB_PINS& lhs, const LIB_PINS& rhs ) -> bool
                   {
                       return compare( lhs, rhs, aSortCol, ascending, m_userUnits );
                   } );
    }

References compare(), m_rows, and m_userUnits.

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::OnColSort(), and RebuildRows().

StringFromBool()

static wxString PIN_TABLE_DATA_MODEL::StringFromBool ( bool  aValue )

inlinestaticprivate

Definition at line 383 of file dialog_lib_edit_pin_table.cpp.

    {
        if( aValue )
            return wxT( "1" );
        else
            return wxT( "0" );
    }

Referenced by GetValue().

Member Data Documentation

m_edited

bool PIN_TABLE_DATA_MODEL::m_edited

private

Definition at line 416 of file dialog_lib_edit_pin_table.cpp.

Referenced by IsEdited(), and SetValue().

m_rows

std::vector<LIB_PINS> PIN_TABLE_DATA_MODEL::m_rows

private

Definition at line 413 of file dialog_lib_edit_pin_table.cpp.

Referenced by AppendRow(), GetNumberRows(), GetValue(), RebuildRows(), RemoveRow(), SetValue(), and SortRows().

m_userUnits

EDA_UNITS PIN_TABLE_DATA_MODEL::m_userUnits

private

Definition at line 415 of file dialog_lib_edit_pin_table.cpp.

Referenced by GetValue(), SetValue(), and SortRows().

---

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

• dialog_lib_edit_pin_table.cpp