KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 class  ELECTRICAL_PINTYPE {
  PT_INPUT , PT_OUTPUT , PT_BIDI , PT_TRISTATE ,
  PT_PASSIVE , PT_NIC , PT_UNSPECIFIED , PT_POWER_IN ,
  PT_POWER_OUT , PT_OPENCOLLECTOR , PT_OPENEMITTER , PT_NC ,
  PT_LAST_OPTION = PT_NC
}
 The symbol library pin object electrical types used in ERC tests. More...
 
enum class  GRAPHIC_PINSHAPE {
  LINE , INVERTED , CLOCK , INVERTED_CLOCK ,
  INPUT_LOW , CLOCK_LOW , OUTPUT_LOW , FALLING_EDGE_CLOCK ,
  NONLOGIC , LAST_OPTION = NONLOGIC
}
 
enum class  PIN_ORIENTATION { PIN_RIGHT = 'R' , PIN_LEFT = 'L' , PIN_UP = 'U' , PIN_DOWN = 'D' }
 The symbol library pin object orientations. More...
 

Functions

wxString PinShapeGetText (GRAPHIC_PINSHAPE shape)
 
BITMAPS PinShapeGetBitmap (GRAPHIC_PINSHAPE shape)
 
wxString ElectricalPinTypeGetText (ELECTRICAL_PINTYPE)
 
BITMAPS ElectricalPinTypeGetBitmap (ELECTRICAL_PINTYPE)
 
wxString PinOrientationName (PIN_ORIENTATION aPinOrientation)
 
BITMAPS PinOrientationGetBitmap (PIN_ORIENTATION aPinOrientation)
 
PIN_ORIENTATION PinOrientationCode (size_t index)
 
int PinOrientationIndex (PIN_ORIENTATION 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 class 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.

◆ GRAPHIC_PINSHAPE

enum class 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.

◆ PIN_ORIENTATION

enum class PIN_ORIENTATION
strong

The symbol library pin object orientations.

Enumerator
PIN_RIGHT 
PIN_LEFT 
PIN_UP 
PIN_DOWN 

Definition at line 75 of file pin_type.h.

Function Documentation

◆ ElectricalPinTypeGetBitmap()

BITMAPS ElectricalPinTypeGetBitmap ( ELECTRICAL_PINTYPE  aType)

◆ ElectricalPinTypeGetText()

◆ PinOrientationCode()

◆ PinOrientationGetBitmap()

BITMAPS PinOrientationGetBitmap ( PIN_ORIENTATION  aPinOrientation)

Definition at line 269 of file pin_type.cpp.

References g_pinOrientations, InitTables(), and INVALID_BITMAP.

Referenced by InitTables().

◆ PinOrientationIcons()

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

◆ PinOrientationIndex()

int PinOrientationIndex ( PIN_ORIENTATION  code)

◆ PinOrientationName()

wxString PinOrientationName ( PIN_ORIENTATION  aPinOrientation)

◆ PinOrientationNames()

◆ PinShapeGetBitmap()

◆ PinShapeGetText()

◆ PinShapeIcons()

◆ PinShapeNames()

◆ PinTypeIcons()

◆ PinTypeNames()