#include <map>
#include <lib_symbol.h>
#include <macros.h>
#include <sch_sheet_path.h>
#include <sch_symbol.h>
#include <sch_text.h>
#include <erc_settings.h>

Classes
class	SCH_REFERENCE
	A helper to define a symbol's reference designator in a schematic. More...

class	SCH_REFERENCE_LIST
	Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used more than once and its reference designator is dependent on the sheet path for the same symbol. More...

Typedefs
typedef std::function< void(ERCE_T aType, const wxString &aMsg, SCH_REFERENCE aItemA, SCH_REFERENCE aItemB)>	ANNOTATION_ERROR_HANDLER
	Define a standard error handler for annotation errors. More...

Enumerations
enum	ANNOTATE_SCOPE_T { ANNOTATE_ALL , ANNOTATE_CURRENT_SHEET , ANNOTATE_SELECTION }
	Schematic annotation scope options. More...

enum	ANNOTATE_ORDER_T { SORT_BY_X_POSITION , SORT_BY_Y_POSITION , UNSORTED }
	Schematic annotation order options. More...

enum	ANNOTATE_ALGO_T { INCREMENTAL_BY_REF , SHEET_NUMBER_X_100 , SHEET_NUMBER_X_1000 }
	Schematic annotation type options. More...

Typedef Documentation

◆ ANNOTATION_ERROR_HANDLER

typedef std::function<void( ERCE_T aType, const wxString& aMsg, SCH_REFERENCE* aItemA, SCH_REFERENCE* aItemB )> ANNOTATION_ERROR_HANDLER

Define a standard error handler for annotation errors.

Definition at line 242 of file sch_reference_list.h.

Enumeration Type Documentation

◆ ANNOTATE_ALGO_T

enum ANNOTATE_ALGO_T

Schematic annotation type options.

Enumerator
INCREMENTAL_BY_REF	Annotate incrementally using the first free reference number.
SHEET_NUMBER_X_100	Annotate using the first free reference number starting at the sheet number * 100.
SHEET_NUMBER_X_1000	Annotate using the first free reference number starting at the sheet number * 1000.

Definition at line 59 of file sch_reference_list.h.

{
 INCREMENTAL_BY_REF, 
 SHEET_NUMBER_X_100, 
 SHEET_NUMBER_X_1000, 
};

◆ ANNOTATE_ORDER_T

enum ANNOTATE_ORDER_T

Schematic annotation order options.

Enumerator
SORT_BY_X_POSITION	Annotate by X position from left to right.
SORT_BY_Y_POSITION	Annotate by Y position from top to bottom.
UNSORTED	Annotate by position of symbol in the schematic sheet object list.

Definition at line 49 of file sch_reference_list.h.

{
 SORT_BY_X_POSITION, 
 SORT_BY_Y_POSITION, 
 UNSORTED, 
};

◆ ANNOTATE_SCOPE_T

enum ANNOTATE_SCOPE_T

Schematic annotation scope options.

Enumerator
ANNOTATE_ALL	Annotate the full schematic.
ANNOTATE_CURRENT_SHEET	Annotate the current sheet.
ANNOTATE_SELECTION	Annotate the selection.

Definition at line 40 of file sch_reference_list.h.

{
 ANNOTATE_ALL, 
 ANNOTATE_CURRENT_SHEET, 
 ANNOTATE_SELECTION 
};

Classes