KiCad PCB EDA Suite
eeschema/cross-probing.cpp File Reference
#include <fctsys.h>
#include <pgm_base.h>
#include <kiface_i.h>
#include <kiway_express.h>
#include <macros.h>
#include <eda_dde.h>
#include <class_drawpanel.h>
#include <schframe.h>
#include <general.h>
#include <eeschema_id.h>
#include <lib_draw_item.h>
#include <lib_pin.h>
#include <sch_component.h>
#include <sch_sheet.h>

Go to the source code of this file.

Functions

std::string FormatProbeItem (EDA_ITEM *aItem, SCH_COMPONENT *aPart)
 

Function Documentation

std::string FormatProbeItem ( EDA_ITEM aItem,
SCH_COMPONENT aPart 
)

Definition at line 115 of file eeschema/cross-probing.cpp.

References SCH_COMPONENT::GetField(), LIB_PIN::GetNumber(), EDA_TEXT::GetText(), EDA_ITEM::GetTimeStamp(), LIB_FIELD_T, LIB_PIN_T, REFERENCE, SCH_COMPONENT_T, SCH_FIELD_T, SCH_SHEET_T, StrPrintf(), TO_UTF8, and EDA_ITEM::Type().

Referenced by SCH_EDIT_FRAME::SendMessageToPCBNEW().

116 {
117  // Cross probing to Pcbnew if a pin or a component is found
118  switch( aItem->Type() )
119  {
120  case SCH_FIELD_T:
121  case LIB_FIELD_T:
122  if( aPart )
123  return StrPrintf( "$PART: %s",
124  TO_UTF8( aPart->GetField( REFERENCE )->GetText() ) );
125  break;
126 
127  case SCH_COMPONENT_T:
128  aPart = (SCH_COMPONENT*) aItem;
129  return StrPrintf( "$PART: %s", TO_UTF8( aPart->GetField( REFERENCE )->GetText() ) );
130 
131  case SCH_SHEET_T:
132  {
133  SCH_SHEET* sheet = (SCH_SHEET*)aItem;
134  return StrPrintf( "$SHEET: %8.8lX", (unsigned long) sheet->GetTimeStamp() );
135  }
136 
137  case LIB_PIN_T:
138  {
139  if( !aPart )
140  break;
141 
142  LIB_PIN* pin = (LIB_PIN*) aItem;
143 
144  if( !pin->GetNumber().IsEmpty() )
145  {
146  return StrPrintf( "$PIN: %s $PART: %s", TO_UTF8( pin->GetNumber() ),
147  TO_UTF8( aPart->GetField( REFERENCE )->GetText() ) );
148  }
149  else
150  {
151  return StrPrintf( "$PART: %s", TO_UTF8( aPart->GetField( REFERENCE )->GetText() ) );
152  }
153  }
154  break;
155 
156  default:
157  break;
158  }
159 
160  return "";
161 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
Field Reference of part, i.e. "IC21".
const wxString & GetNumber() const
Definition: lib_pin.h:191
int StrPrintf(std::string *result, const char *format,...)
Function StrPrintf is like sprintf() but the output is appended to a std::string instead of to a char...
Definition: richio.cpp:75
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes...
Definition: macros.h:47
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:130
time_t GetTimeStamp() const
Definition: base_struct.h:218
Class SCH_SHEET is the sheet symbol placed in a schematic, and is the entry point for a sub schematic...
Definition: sch_sheet.h:216
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69