KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Classes | Typedefs | Enumerations | Functions | Variables
PADS_SCH_BINARY Namespace Reference

Classes

struct  BUILD_COUNTS
 
struct  BUILD_RESULT
 
class  CONTROLLER_ID
 
struct  CONTROLLER_REFERENCE
 
struct  DESIGN_SETTINGS
 
struct  DIAGNOSTIC_PROPERTY_IDENTITY
 
struct  DIAGNOSTIC_PROPERTY_KEY
 
struct  MODEL_BUS
 
struct  MODEL_BUS_ENTRY
 
struct  MODEL_CONNECTION
 
struct  MODEL_CONNECTION_ENDPOINT
 
struct  MODEL_CONNECTOR_PIN
 
struct  MODEL_EMBEDDED_IMAGE
 
struct  MODEL_FIELD
 
struct  MODEL_GATE
 
struct  MODEL_GATE_PIN
 
struct  MODEL_GRAPHIC
 
struct  MODEL_JUNCTION
 
struct  MODEL_LABEL
 
struct  MODEL_NET
 
struct  MODEL_PAGE_GRAPHIC
 
struct  MODEL_PART_TYPE
 
struct  MODEL_PIN_DEFINITION
 
struct  MODEL_PLACEMENT
 
struct  MODEL_SHEET
 
struct  MODEL_SIGNAL_PIN
 
struct  MODEL_SYMBOL_DEFINITION
 
struct  MODEL_TEXT
 
struct  MODEL_TEXT_PRESENTATION
 
struct  MODEL_WORKSHEET
 
class  PADS_SCH_BINARY_BUILDER
 
class  PADS_SCH_BINARY_PARSER
 
class  PADS_SCH_BINARY_READER
 
struct  PADS_SCH_MODEL
 
class  PADS_SCH_SDB
 
struct  PARSER_DIAGNOSTIC
 
struct  PIN_REFERENCE
 
struct  PLACED_PIN_REFERENCE
 
struct  PRESERVED_CONTROLLER_PAYLOAD
 
struct  SCH_SDB_BLOCK
 
struct  SCH_SDB_OLE_ITEM
 
struct  SCH_SDB_POOL
 
struct  SOURCE_POINT
 
struct  SOURCE_PROPERTY
 
struct  SOURCE_PROVENANCE
 
struct  SOURCE_STRING
 

Typedefs

using SHEET_ID = CONTROLLER_ID<SHEET_ID_TAG>
 
using DEFINITION_ID = CONTROLLER_ID<DEFINITION_ID_TAG>
 
using PIN_ID = CONTROLLER_ID<PIN_ID_TAG>
 
using FIELD_ID = CONTROLLER_ID<FIELD_ID_TAG, uint64_t>
 
using PART_TYPE_ID = CONTROLLER_ID<PART_TYPE_ID_TAG>
 
using GATE_ID = CONTROLLER_ID<GATE_ID_TAG>
 
using PLACEMENT_ID = CONTROLLER_ID<PLACEMENT_ID_TAG>
 
using NET_ID = CONTROLLER_ID<NET_ID_TAG>
 
using BUS_ID = CONTROLLER_ID<BUS_ID_TAG>
 
using IMAGE_ID = CONTROLLER_ID<IMAGE_ID_TAG>
 
using SHEET_REFERENCE = CONTROLLER_REFERENCE<SHEET_ID>
 
using DEFINITION_REFERENCE = CONTROLLER_REFERENCE<DEFINITION_ID>
 
using PART_TYPE_REFERENCE = CONTROLLER_REFERENCE<PART_TYPE_ID>
 
using GATE_REFERENCE = CONTROLLER_REFERENCE<GATE_ID>
 
using PLACEMENT_REFERENCE = CONTROLLER_REFERENCE<PLACEMENT_ID>
 
using NET_REFERENCE = CONTROLLER_REFERENCE<NET_ID>
 

Enumerations

enum class  STRING_ENCODING_STATUS { UTF8 , CODE_PAGE , INVALID_BYTES , UNKNOWN_CODE_PAGE }
 
enum class  PROPERTY_DISPOSITION { EXACT , APPROXIMATE , PRESERVED , UNSUPPORTED }
 
enum class  FIELD_ID_DOMAIN : uint8_t { SHEET = 1 , DEFINITION = 2 , PART_TYPE = 3 , PLACEMENT = 4 }
 
enum class  MODEL_LINE_STYLE {
  DEFAULT , SOLID , DASH , DOT ,
  DASH_DOT
}
 
enum class  MODEL_FILL_STYLE { NONE , FILLED , HATCHED }
 
enum class  MODEL_JUSTIFICATION { LEFT , CENTER , RIGHT }
 
enum class  MODEL_GRAPHIC_KIND {
  LINE , POLYLINE , RECTANGLE , CIRCLE ,
  ARC , TEXT
}
 
enum class  MODEL_ENDPOINT_KIND { INVALID , POINT , PIN }
 
enum class  MODEL_LABEL_KIND {
  LOCAL , GLOBAL , HIERARCHICAL , GROUND ,
  POWER , BUS , UNSUPPORTED
}
 
enum class  MODEL_EMBEDDED_IMAGE_TYPE { BMP , DIB , WMF , UNSUPPORTED }
 
enum class  SCH_SDB_BLOCK_KIND {
  STRING_HEAP , FIXED_CONTROLLER , SHEET , CFB_CONTAINER_ITEM ,
  FOOTER_AUX
}
 

Functions

std::optional< DIAGNOSTIC_PROPERTY_KEY > DiagnosticPropertyKey (const PARSER_DIAGNOSTIC &aDiagnostic)
 
wxString FormatParserError (const SOURCE_PROVENANCE &aSource, const wxString &aMessage)
 
PARSER_DIAGNOSTIC MakePropertyDiagnostic (SEVERITY aSeverity, const SOURCE_PROPERTY &aProperty, const wxString &aMessage)
 
PARSER_DIAGNOSTIC MakePropertyDiagnostic (SEVERITY aSeverity, const SOURCE_PROVENANCE &aSource, const wxString &aName, PROPERTY_DISPOSITION aDisposition, const wxString &aMessage)
 
constexpr FIELD_ID MakeFieldId (FIELD_ID_DOMAIN aDomain, uint32_t aOwner, uint32_t aOrdinal)
 
constexpr int64_t NormalizeCoordinate (int64_t aCoordinate)
 
constexpr int NormalizeAngle (int aAngle)
 

Variables

constexpr uint32_t FIELD_ID_MAX_ORDINAL = ( 1U << 29 ) - 1
 

Typedef Documentation

◆ BUS_ID

using PADS_SCH_BINARY::BUS_ID = CONTROLLER_ID<BUS_ID_TAG>

Definition at line 182 of file pads_sch_binary_model.h.

◆ DEFINITION_ID

using PADS_SCH_BINARY::DEFINITION_ID = CONTROLLER_ID<DEFINITION_ID_TAG>

Definition at line 175 of file pads_sch_binary_model.h.

◆ DEFINITION_REFERENCE

using PADS_SCH_BINARY::DEFINITION_REFERENCE = CONTROLLER_REFERENCE<DEFINITION_ID>

Definition at line 214 of file pads_sch_binary_model.h.

◆ FIELD_ID

using PADS_SCH_BINARY::FIELD_ID = CONTROLLER_ID<FIELD_ID_TAG, uint64_t>

Definition at line 177 of file pads_sch_binary_model.h.

◆ GATE_ID

using PADS_SCH_BINARY::GATE_ID = CONTROLLER_ID<GATE_ID_TAG>

Definition at line 179 of file pads_sch_binary_model.h.

◆ GATE_REFERENCE

using PADS_SCH_BINARY::GATE_REFERENCE = CONTROLLER_REFERENCE<GATE_ID>

Definition at line 216 of file pads_sch_binary_model.h.

◆ IMAGE_ID

using PADS_SCH_BINARY::IMAGE_ID = CONTROLLER_ID<IMAGE_ID_TAG>

Definition at line 183 of file pads_sch_binary_model.h.

◆ NET_ID

using PADS_SCH_BINARY::NET_ID = CONTROLLER_ID<NET_ID_TAG>

Definition at line 181 of file pads_sch_binary_model.h.

◆ NET_REFERENCE

using PADS_SCH_BINARY::NET_REFERENCE = CONTROLLER_REFERENCE<NET_ID>

Definition at line 218 of file pads_sch_binary_model.h.

◆ PART_TYPE_ID

using PADS_SCH_BINARY::PART_TYPE_ID = CONTROLLER_ID<PART_TYPE_ID_TAG>

Definition at line 178 of file pads_sch_binary_model.h.

◆ PART_TYPE_REFERENCE

using PADS_SCH_BINARY::PART_TYPE_REFERENCE = CONTROLLER_REFERENCE<PART_TYPE_ID>

Definition at line 215 of file pads_sch_binary_model.h.

◆ PIN_ID

using PADS_SCH_BINARY::PIN_ID = CONTROLLER_ID<PIN_ID_TAG>

Definition at line 176 of file pads_sch_binary_model.h.

◆ PLACEMENT_ID

using PADS_SCH_BINARY::PLACEMENT_ID = CONTROLLER_ID<PLACEMENT_ID_TAG>

Definition at line 180 of file pads_sch_binary_model.h.

◆ PLACEMENT_REFERENCE

using PADS_SCH_BINARY::PLACEMENT_REFERENCE = CONTROLLER_REFERENCE<PLACEMENT_ID>

Definition at line 217 of file pads_sch_binary_model.h.

◆ SHEET_ID

using PADS_SCH_BINARY::SHEET_ID = CONTROLLER_ID<SHEET_ID_TAG>

Definition at line 174 of file pads_sch_binary_model.h.

◆ SHEET_REFERENCE

using PADS_SCH_BINARY::SHEET_REFERENCE = CONTROLLER_REFERENCE<SHEET_ID>

Definition at line 213 of file pads_sch_binary_model.h.

Enumeration Type Documentation

◆ FIELD_ID_DOMAIN

enum class PADS_SCH_BINARY::FIELD_ID_DOMAIN : uint8_t
strong
Enumerator
SHEET 
DEFINITION 
PART_TYPE 
PLACEMENT 

Definition at line 185 of file pads_sch_binary_model.h.

◆ MODEL_EMBEDDED_IMAGE_TYPE

enum class PADS_SCH_BINARY::MODEL_EMBEDDED_IMAGE_TYPE
strong
Enumerator
BMP 
DIB 
WMF 
UNSUPPORTED 

Definition at line 694 of file pads_sch_binary_model.h.

◆ MODEL_ENDPOINT_KIND

enum class PADS_SCH_BINARY::MODEL_ENDPOINT_KIND
strong
Enumerator
INVALID 
POINT 
PIN 

Definition at line 566 of file pads_sch_binary_model.h.

◆ MODEL_FILL_STYLE

enum class PADS_SCH_BINARY::MODEL_FILL_STYLE
strong
Enumerator
NONE 
FILLED 
HATCHED 

Definition at line 284 of file pads_sch_binary_model.h.

◆ MODEL_GRAPHIC_KIND

enum class PADS_SCH_BINARY::MODEL_GRAPHIC_KIND
strong
Enumerator
LINE 
POLYLINE 
RECTANGLE 
CIRCLE 
ARC 
TEXT 

Definition at line 349 of file pads_sch_binary_model.h.

◆ MODEL_JUSTIFICATION

enum class PADS_SCH_BINARY::MODEL_JUSTIFICATION
strong
Enumerator
LEFT 
CENTER 
RIGHT 

Definition at line 292 of file pads_sch_binary_model.h.

◆ MODEL_LABEL_KIND

enum class PADS_SCH_BINARY::MODEL_LABEL_KIND
strong
Enumerator
LOCAL 
GLOBAL 
HIERARCHICAL 
GROUND 
POWER 
BUS 
UNSUPPORTED 

Definition at line 639 of file pads_sch_binary_model.h.

◆ MODEL_LINE_STYLE

enum class PADS_SCH_BINARY::MODEL_LINE_STYLE
strong
Enumerator
DEFAULT 
SOLID 
DASH 
DOT 
DASH_DOT 

Definition at line 274 of file pads_sch_binary_model.h.

◆ PROPERTY_DISPOSITION

enum class PADS_SCH_BINARY::PROPERTY_DISPOSITION
strong
Enumerator
EXACT 
APPROXIMATE 
PRESERVED 
UNSUPPORTED 

Definition at line 73 of file pads_sch_binary_model.h.

◆ SCH_SDB_BLOCK_KIND

enum class PADS_SCH_BINARY::SCH_SDB_BLOCK_KIND
strong
Enumerator
STRING_HEAP 
FIXED_CONTROLLER 
SHEET 
CFB_CONTAINER_ITEM 
FOOTER_AUX 

Definition at line 41 of file pads_sch_sdb.h.

◆ STRING_ENCODING_STATUS

enum class PADS_SCH_BINARY::STRING_ENCODING_STATUS
strong
Enumerator
UTF8 
CODE_PAGE 
INVALID_BYTES 
UNKNOWN_CODE_PAGE 

Definition at line 51 of file pads_sch_binary_model.h.

Function Documentation

◆ DiagnosticPropertyKey()

std::optional< DIAGNOSTIC_PROPERTY_KEY > PADS_SCH_BINARY::DiagnosticPropertyKey ( const PARSER_DIAGNOSTIC & aDiagnostic)

Definition at line 5091 of file pads_sch_binary_parser.cpp.

References DiagnosticPropertyKey(), PADS_SCH_BINARY::PARSER_DIAGNOSTIC::property, and PADS_SCH_BINARY::PARSER_DIAGNOSTIC::source.

Referenced by BOOST_AUTO_TEST_CASE(), and DiagnosticPropertyKey().

◆ FormatParserError()

wxString PADS_SCH_BINARY::FormatParserError ( const SOURCE_PROVENANCE & aSource,
const wxString & aMessage )

Definition at line 5071 of file pads_sch_binary_parser.cpp.

References PADS_SCH_BINARY::SOURCE_PROVENANCE::absoluteOffset, PADS_SCH_BINARY::SOURCE_PROVENANCE::controller, PADS_SCH_BINARY::SOURCE_PROVENANCE::file, FormatParserError(), PADS_SCH_BINARY::SOURCE_PROVENANCE::objectClass, PADS_SCH_BINARY::SOURCE_PROVENANCE::recordIndex, PADS_SCH_BINARY::SOURCE_PROVENANCE::sheet, and PADS_SCH_BINARY::SOURCE_PROVENANCE::version.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PADS_SCH_BINARY::PADS_SCH_BINARY_BUILDER::Build(), FormatParserError(), and SCH_IO_PADS::loadBinarySchematicFile().

◆ MakeFieldId()

FIELD_ID PADS_SCH_BINARY::MakeFieldId ( FIELD_ID_DOMAIN aDomain,
uint32_t aOwner,
uint32_t aOrdinal )
constexpr

Definition at line 195 of file pads_sch_binary_model.h.

References FIELD_ID_MAX_ORDINAL.

Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ MakePropertyDiagnostic() [1/2]

PARSER_DIAGNOSTIC PADS_SCH_BINARY::MakePropertyDiagnostic ( SEVERITY aSeverity,
const SOURCE_PROPERTY & aProperty,
const wxString & aMessage )

Definition at line 5100 of file pads_sch_binary_parser.cpp.

References PADS_SCH_BINARY::SOURCE_PROPERTY::disposition, MakePropertyDiagnostic(), PADS_SCH_BINARY::SOURCE_PROPERTY::name, PADS_SCH_BINARY::SOURCE_PROPERTY::source, and PADS_SCH_BINARY::SOURCE_STRING::text.

Referenced by BOOST_AUTO_TEST_CASE(), MakePropertyDiagnostic(), and MakePropertyDiagnostic().

◆ MakePropertyDiagnostic() [2/2]

PARSER_DIAGNOSTIC PADS_SCH_BINARY::MakePropertyDiagnostic ( SEVERITY aSeverity,
const SOURCE_PROVENANCE & aSource,
const wxString & aName,
PROPERTY_DISPOSITION aDisposition,
const wxString & aMessage )

Definition at line 5107 of file pads_sch_binary_parser.cpp.

References MakePropertyDiagnostic().

◆ NormalizeAngle()

int PADS_SCH_BINARY::NormalizeAngle ( int aAngle)
constexpr

Definition at line 227 of file pads_sch_binary_model.h.

Referenced by BOOST_AUTO_TEST_CASE().

◆ NormalizeCoordinate()

int64_t PADS_SCH_BINARY::NormalizeCoordinate ( int64_t aCoordinate)
constexpr

Definition at line 222 of file pads_sch_binary_model.h.

Referenced by BOOST_AUTO_TEST_CASE().

Variable Documentation

◆ FIELD_ID_MAX_ORDINAL

uint32_t PADS_SCH_BINARY::FIELD_ID_MAX_ORDINAL = ( 1U << 29 ) - 1
constexpr

Definition at line 193 of file pads_sch_binary_model.h.

Referenced by MakeFieldId().