KiCad PCB EDA Suite
pin_type.h File Reference
#include <wx/arrstr.h>
#include <vector>

Go to the source code of this file.

Macros

#define ELECTRICAL_PINTYPES_TOTAL   ( static_cast<int>( ELECTRICAL_PINTYPE::PT_LAST_OPTION ) + 1 )
 
#define GRAPHIC_PINSHAPES_TOTAL   ( static_cast<int>( GRAPHIC_PINSHAPE::LAST_OPTION ) + 1 )
 

Enumerations

enum  ELECTRICAL_PINTYPE {
  ELECTRICAL_PINTYPE::PT_INPUT, ELECTRICAL_PINTYPE::PT_OUTPUT, ELECTRICAL_PINTYPE::PT_BIDI, ELECTRICAL_PINTYPE::PT_TRISTATE,
  ELECTRICAL_PINTYPE::PT_PASSIVE, ELECTRICAL_PINTYPE::PT_NIC, ELECTRICAL_PINTYPE::PT_UNSPECIFIED, ELECTRICAL_PINTYPE::PT_POWER_IN,
  ELECTRICAL_PINTYPE::PT_POWER_OUT, ELECTRICAL_PINTYPE::PT_OPENCOLLECTOR, ELECTRICAL_PINTYPE::PT_OPENEMITTER, ELECTRICAL_PINTYPE::PT_NC,
  ELECTRICAL_PINTYPE::PT_LAST_OPTION = PT_NC
}
 The symbol library pin object electrical types used in ERC tests. More...
 
enum  GRAPHIC_PINSHAPE {
  GRAPHIC_PINSHAPE::LINE, GRAPHIC_PINSHAPE::INVERTED, GRAPHIC_PINSHAPE::CLOCK, GRAPHIC_PINSHAPE::INVERTED_CLOCK,
  GRAPHIC_PINSHAPE::INPUT_LOW, GRAPHIC_PINSHAPE::CLOCK_LOW, GRAPHIC_PINSHAPE::OUTPUT_LOW, GRAPHIC_PINSHAPE::FALLING_EDGE_CLOCK,
  GRAPHIC_PINSHAPE::NONLOGIC, GRAPHIC_PINSHAPE::LAST_OPTION = NONLOGIC
}
 

Functions

wxString PinShapeGetText (GRAPHIC_PINSHAPE shape)
 
BITMAPS PinShapeGetBitmap (GRAPHIC_PINSHAPE shape)
 
wxString ElectricalPinTypeGetText (ELECTRICAL_PINTYPE)
 
BITMAPS ElectricalPinTypeGetBitmap (ELECTRICAL_PINTYPE)
 
wxString PinOrientationName (unsigned aPinOrientationCode)
 
int PinOrientationCode (int index)
 
int PinOrientationIndex (int code)
 
const wxArrayString & PinTypeNames ()
 
const std::vector< BITMAPS > & PinTypeIcons ()
 
const wxArrayString & PinShapeNames ()
 
const std::vector< BITMAPS > & PinShapeIcons ()
 
const wxArrayString & PinOrientationNames ()
 
const std::vector< BITMAPS > & PinOrientationIcons ()
 

Macro Definition Documentation

◆ ELECTRICAL_PINTYPES_TOTAL

#define ELECTRICAL_PINTYPES_TOTAL   ( static_cast<int>( ELECTRICAL_PINTYPE::PT_LAST_OPTION ) + 1 )

Definition at line 53 of file pin_type.h.

◆ GRAPHIC_PINSHAPES_TOTAL

#define GRAPHIC_PINSHAPES_TOTAL   ( static_cast<int>( GRAPHIC_PINSHAPE::LAST_OPTION ) + 1 )

Definition at line 70 of file pin_type.h.

Enumeration Type Documentation

◆ ELECTRICAL_PINTYPE

enum ELECTRICAL_PINTYPE
strong

The symbol library pin object electrical types used in ERC tests.

Enumerator
PT_INPUT 

usual pin input: must be connected

PT_OUTPUT 

usual output

PT_BIDI 

input or output (like port for a microprocessor)

PT_TRISTATE 

tris state bus pin

PT_PASSIVE 

pin for passive symbols: must be connected, and can be connected to any pin

PT_NIC 

not internally connected (may be connected to anything)

PT_UNSPECIFIED 

unknown electrical properties: creates always a warning when connected

PT_POWER_IN 

power input (GND, VCC for ICs). Must be connected to a power output.

PT_POWER_OUT 

output of a regulator: intended to be connected to power input pins

PT_OPENCOLLECTOR 

pin type open collector

PT_OPENEMITTER 

pin type open emitter

PT_NC 

not connected (must be left open)

PT_LAST_OPTION 

sentinel value, set to last usable enum option

Definition at line 35 of file pin_type.h.

36 {
37  PT_INPUT,
38  PT_OUTPUT,
39  PT_BIDI,
40  PT_TRISTATE,
41  PT_PASSIVE,
42  PT_NIC,
44  PT_POWER_IN,
45  PT_POWER_OUT,
48  PT_NC,
49 
51 };
power input (GND, VCC for ICs). Must be connected to a power output.
pin for passive symbols: must be connected, and can be connected to any pin
unknown electrical properties: creates always a warning when connected
not internally connected (may be connected to anything)
sentinel value, set to last usable enum option
usual pin input: must be connected
input or output (like port for a microprocessor)
not connected (must be left open)
output of a regulator: intended to be connected to power input pins

◆ GRAPHIC_PINSHAPE

enum GRAPHIC_PINSHAPE
strong
Enumerator
LINE 
INVERTED 
CLOCK 
INVERTED_CLOCK 
INPUT_LOW 
CLOCK_LOW 
OUTPUT_LOW 
FALLING_EDGE_CLOCK 
NONLOGIC 
LAST_OPTION 

this is the sentinel value, must be set to last enum value

Definition at line 55 of file pin_type.h.

Function Documentation

◆ ElectricalPinTypeGetBitmap()

BITMAPS ElectricalPinTypeGetBitmap ( ELECTRICAL_PINTYPE  )

Definition at line 247 of file pin_type.cpp.

248 {
249  auto findIt = pinTypes.find( aType );
250 
251  wxCHECK_MSG( findIt != pinTypes.end(), BITMAPS::INVALID_BITMAP,
252  "Could not find pin type in lookup map" );
253 
254  return findIt->second.bitmap;
255 }
const std::map< ELECTRICAL_PINTYPE, struct pinTypeStruct > pinTypes
Definition: pin_type.cpp:50

References INVALID_BITMAP, and pinTypes.

Referenced by LIB_PIN::GetMenuImage(), InitTables(), and PinTypeComboBox::PinTypeComboBox().

◆ ElectricalPinTypeGetText()

wxString ElectricalPinTypeGetText ( ELECTRICAL_PINTYPE  )

Definition at line 237 of file pin_type.cpp.

238 {
239  auto findIt = pinTypes.find( aType );
240 
241  wxCHECK_MSG( findIt != pinTypes.end(), wxT( "???" ), "Could not find pin type in lookup map" );
242 
243  return findIt->second.name;
244 }
const std::map< ELECTRICAL_PINTYPE, struct pinTypeStruct > pinTypes
Definition: pin_type.cpp:50

References pinTypes.

Referenced by LIB_PIN::GetElectricalTypeName(), SCH_PIN::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), InitTables(), PinTypeComboBox::PinTypeComboBox(), and ERC_TESTER::TestPinToPin().

◆ PinOrientationCode()

int PinOrientationCode ( int  index)

Definition at line 138 of file pin_type.cpp.

139 {
140  if( index >= 0 && index < (int) PIN_ORIENTATION_CNT )
141  return pin_orientation_codes[ index ];
142 
143  return PIN_RIGHT;
144 }
#define PIN_ORIENTATION_CNT
Definition: pin_type.cpp:109
static const int pin_orientation_codes[]
Definition: pin_type.cpp:89

References PIN_ORIENTATION_CNT, pin_orientation_codes, and PIN_RIGHT.

Referenced by DIALOG_PIN_PROPERTIES::OnPropertiesChange(), PIN_TABLE_DATA_MODEL::SetValue(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

◆ PinOrientationIcons()

const std::vector<BITMAPS>& PinOrientationIcons ( )

Definition at line 228 of file pin_type.cpp.

229 {
230  if( g_orientationIcons.empty() )
231  InitTables();
232 
233  return g_orientationIcons;
234 }
void InitTables()
Definition: pin_type.cpp:161
static std::vector< BITMAPS > g_orientationIcons
Definition: pin_type.cpp:39

References g_orientationIcons, and InitTables().

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), and DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES().

◆ PinOrientationIndex()

int PinOrientationIndex ( int  code)

Definition at line 147 of file pin_type.cpp.

148 {
149  size_t i;
150 
151  for( i = 0; i < PIN_ORIENTATION_CNT; i++ )
152  {
153  if( pin_orientation_codes[i] == code )
154  return (int) i;
155  }
156 
157  return wxNOT_FOUND;
158 }
#define PIN_ORIENTATION_CNT
Definition: pin_type.cpp:109
static const int pin_orientation_codes[]
Definition: pin_type.cpp:89

References PIN_ORIENTATION_CNT, and pin_orientation_codes.

Referenced by SCH_PIN::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), PIN_TABLE_DATA_MODEL::GetValue(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ PinOrientationName()

wxString PinOrientationName ( unsigned  aPinOrientationCode)

Definition at line 116 of file pin_type.cpp.

117 {
118  /* Note: The following name lists are sentence capitalized per the GNOME UI
119  * standards for list controls. Please do not change the capitalization
120  * of these strings unless the GNOME UI standards are changed.
121  */
122  const wxString pin_orientation_names[] =
123  {
124  _( "Right" ),
125  _( "Left" ),
126  _( "Up" ),
127  _( "Down" ),
128  wxT( "???" )
129  };
130 
131  if( aPinOrientationCode > PIN_ORIENTATION_CNT )
132  aPinOrientationCode = PIN_ORIENTATION_CNT;
133 
134  return pin_orientation_names[ aPinOrientationCode ];
135 }
#define PIN_ORIENTATION_CNT
Definition: pin_type.cpp:109
#define _(s)

References _, and PIN_ORIENTATION_CNT.

Referenced by SCH_PIN::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), and InitTables().

◆ PinOrientationNames()

const wxArrayString& PinOrientationNames ( )

Definition at line 219 of file pin_type.cpp.

220 {
221  if( g_orientationNames.empty() )
222  InitTables();
223 
224  return g_orientationNames;
225 }
void InitTables()
Definition: pin_type.cpp:161
static wxArrayString g_orientationNames
Definition: pin_type.cpp:40

References g_orientationNames, and InitTables().

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), PIN_TABLE_DATA_MODEL::GetValue(), and PIN_TABLE_DATA_MODEL::SetValue().

◆ PinShapeGetBitmap()

BITMAPS PinShapeGetBitmap ( GRAPHIC_PINSHAPE  shape)

Definition at line 268 of file pin_type.cpp.

269 {
270  auto findIt = pinShapes.find( aShape );
271 
272  wxCHECK_MSG( findIt != pinShapes.end(), BITMAPS::INVALID_BITMAP,
273  "Could not find pinshape in lookup map" );
274 
275  return findIt->second.bitmap;
276 }
const std::map< GRAPHIC_PINSHAPE, struct pinShapeStruct > pinShapes
Definition: pin_type.cpp:75

References INVALID_BITMAP, and pinShapes.

Referenced by InitTables(), and PinShapeComboBox::PinShapeComboBox().

◆ PinShapeGetText()

wxString PinShapeGetText ( GRAPHIC_PINSHAPE  shape)

Definition at line 258 of file pin_type.cpp.

259 {
260  auto findIt = pinShapes.find( aShape );
261 
262  wxCHECK_MSG( findIt != pinShapes.end(), wxT( "?" ), "Could not find pinshape in lookup map" );
263 
264  return findIt->second.name;
265 }
const std::map< GRAPHIC_PINSHAPE, struct pinShapeStruct > pinShapes
Definition: pin_type.cpp:75

References pinShapes.

Referenced by SCH_PIN::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), LIB_PIN::GetSelectMenuText(), InitTables(), and PinShapeComboBox::PinShapeComboBox().

◆ PinShapeIcons()

const std::vector<BITMAPS>& PinShapeIcons ( )

Definition at line 210 of file pin_type.cpp.

211 {
212  if( g_shapeIcons.empty() )
213  InitTables();
214 
215  return g_shapeIcons;
216 }
void InitTables()
Definition: pin_type.cpp:161
static std::vector< BITMAPS > g_shapeIcons
Definition: pin_type.cpp:36

References g_shapeIcons, and InitTables().

Referenced by SCH_PIN_TABLE_DATA_MODEL::BuildAttrs(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), and DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES().

◆ PinShapeNames()

◆ PinTypeIcons()

const std::vector<BITMAPS>& PinTypeIcons ( )

Definition at line 192 of file pin_type.cpp.

193 {
194  if( g_typeIcons.empty() )
195  InitTables();
196 
197  return g_typeIcons;
198 }
static std::vector< BITMAPS > g_typeIcons
Definition: pin_type.cpp:33
void InitTables()
Definition: pin_type.cpp:161

References g_typeIcons, and InitTables().

Referenced by SCH_PIN_TABLE_DATA_MODEL::BuildAttrs(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), and DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES().

◆ PinTypeNames()