KiCad PCB EDA Suite
sch_item_struct.h File Reference

Base schematic object class definition. More...

#include <vector>
#include <class_base_screen.h>
#include <general.h>
#include <boost/ptr_container/ptr_vector.hpp>

Go to the source code of this file.

Classes

class  DANGLING_END_ITEM
 Class DANGLING_END_ITEM is a helper class used to store the state of schematic items that can be connected to other schematic items. More...
 
class  SCH_ITEM
 Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container class, and therefore instances of derived classes should only be found in EESCHEMA or other programs that use class SCHEMATIC and its contents. More...
 

Macros

#define FMT_IU   SCH_ITEM::FormatInternalUnits
 
#define FMT_ANGLE   SCH_ITEM::FormatAngle
 

Typedefs

typedef boost::ptr_vector< SCH_ITEMSCH_ITEMS
 
typedef SCH_ITEMS::iterator SCH_ITEMS_ITR
 
typedef std::vector< SCH_ITEMS_ITRSCH_ITEMS_ITRS
 

Enumerations

enum  DANGLING_END_T {
  UNKNOWN = 0, WIRE_START_END, WIRE_END_END, BUS_START_END,
  BUS_END_END, JUNCTION_END, PIN_END, LABEL_END,
  ENTRY_END, SHEET_LABEL_END, NO_CONNECT_END
}
 

Functions

bool sort_schematic_items (const SCH_ITEM *aItem1, const SCH_ITEM *aItem2)
 

Variables

const wxString traceFindItem
 Flag to enable find item tracing using the WXTRACE environment variable. More...
 

Detailed Description

Base schematic object class definition.

Definition in file sch_item_struct.h.

Macro Definition Documentation

#define FMT_ANGLE   SCH_ITEM::FormatAngle

Definition at line 55 of file sch_item_struct.h.

Referenced by PCB_IO::format().

#define FMT_IU   SCH_ITEM::FormatInternalUnits

Definition at line 54 of file sch_item_struct.h.

Referenced by PCB_IO::format(), NETCLASS::Format(), and EDA_TEXT::Format().

Typedef Documentation

typedef boost::ptr_vector< SCH_ITEM > SCH_ITEMS

Definition at line 46 of file sch_item_struct.h.

typedef SCH_ITEMS::iterator SCH_ITEMS_ITR

Definition at line 50 of file sch_item_struct.h.

typedef std::vector< SCH_ITEMS_ITR > SCH_ITEMS_ITRS

Definition at line 51 of file sch_item_struct.h.

Enumeration Type Documentation

Enumerator
UNKNOWN 
WIRE_START_END 
WIRE_END_END 
BUS_START_END 
BUS_END_END 
JUNCTION_END 
PIN_END 
LABEL_END 
ENTRY_END 
SHEET_LABEL_END 
NO_CONNECT_END 

Definition at line 63 of file sch_item_struct.h.

Function Documentation

bool sort_schematic_items ( const SCH_ITEM aItem1,
const SCH_ITEM aItem2 
)

Definition at line 44 of file sch_item_struct.cpp.

45 {
46  return *aItem1 < *aItem2;
47 }

Variable Documentation

const wxString traceFindItem

Flag to enable find item tracing using the WXTRACE environment variable.

This flag generates a lot of debug output.

Referenced by LIB_PIN::Matches(), SCH_TEXT::Matches(), SCH_FIELD::Matches(), SCH_SHEET_PIN::Matches(), SCH_COMPONENT::Matches(), and SCH_SHEET::Matches().