kicad/eeschema/sch_pin.h

124 lines
4.0 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2018 CERN
* Copyright (C) 2019 KiCad Developers, see change_log.txt for contributors.
* @author Jon Evans <jon@craftyjon.com>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _SCH_PIN_CONNECTION_H
#define _SCH_PIN_CONNECTION_H
#include <lib_pin.h>
#include <msgpanel.h>
#include <sch_item.h>
#include <sch_sheet_path.h>
#include <mutex>
#include <map>
class SCH_COMPONENT;
class SCH_PIN : public SCH_ITEM
{
LIB_PIN* m_libPin;
wxPoint m_position;
bool m_isDangling;
int m_textMarkupFlags; // Set of TEXT_MARKUP_FLAGS indicating which markup
// features are to be processed within the pin name
// and number.
/// The name that this pin connection will drive onto a net
std::mutex m_netmap_mutex;
std::map<const SCH_SHEET_PATH, wxString> m_net_name_map;
public:
SCH_PIN( LIB_PIN* aLibPin, SCH_COMPONENT* aParentComponent );
SCH_PIN( const SCH_PIN& aPin );
SCH_PIN& operator=( const SCH_PIN& aPin );
static inline bool ClassOf( const EDA_ITEM* aItem )
{
return aItem && SCH_PIN_T == aItem->Type();
}
wxString GetClass() const override
{
return wxT( "SCH_PIN" );
}
SCH_COMPONENT* GetParentComponent() const;
LIB_PIN* GetLibPin() const { return m_libPin; }
wxString GetDefaultNetName( const SCH_SHEET_PATH aPath );
wxString GetSelectMenuText( EDA_UNITS aUnits ) const override;
void GetMsgPanelInfo( EDA_UNITS aUnits, MSG_PANEL_ITEMS& aList ) override;
wxString GetDescription( const SCH_SHEET_PATH* aSheet );
void Print( RENDER_SETTINGS* aSettings, const wxPoint& aOffset ) override {}
void Move( const wxPoint& aMoveVector ) override {}
void MirrorY( int aYaxis_position ) override {}
void MirrorX( int aXaxis_position ) override {}
void Rotate( wxPoint aPosition ) override {}
wxPoint GetPosition() const override { return m_position; }
void SetPosition( const wxPoint& aPosition ) override { m_position = aPosition; }
const EDA_RECT GetBoundingBox() const override;
bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
int GetTextMarkupFlags() const { return m_textMarkupFlags; }
void SetTextMarkupFlags( int aFlags ) { m_textMarkupFlags = aFlags; }
bool IsDangling() const override { return m_isDangling; }
void SetIsDangling( bool isDangling ) { m_isDangling = isDangling; }
/// Returns the pin's position in global coordinates
wxPoint GetTransformedPosition() const;
bool Matches( wxFindReplaceData& aSearchData, void* aAuxData ) override;
/*
* While many of these are currently simply covers for the equivalent LIB_PIN methods,
* the new EESchema file format will soon allow us to override them at the SCH level.
*/
bool IsVisible() const { return m_libPin->IsVisible(); }
const wxString& GetName() const { return m_libPin->GetName(); }
const wxString& GetNumber() const { return m_libPin->GetNumber(); }
ELECTRICAL_PINTYPE GetType() const { return m_libPin->GetType(); }
bool IsPowerConnection() const { return m_libPin->IsPowerConnection(); }
#if defined(DEBUG)
void Show( int nestLevel, std::ostream& os ) const override {}
#endif
};
#endif