KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
EASYPC::SOURCE_SYMBOL Struct Reference

Footprints and schematic symbols alike. More...

#include <easypc_classes_library.h>

Inheritance diagram for EASYPC::SOURCE_SYMBOL:
EASYPC::SOURCE_DESIGN_ITEM EASYPC::SELF_VERSIONED EASYPC::OBJECT

Public Member Functions

LOAD_TASK Load (ARCHIVE &aAr) override
 Read this object's fields.
 
int ItemFormat (const ARCHIVE &aAr) const override
 The version this object gates on; the base is the archive's current read format.
 
void LoadOldFormat (ARCHIVE &aAr, int &aFormat) const
 An older item format, stored only while the format is still 0.
 

Static Public Member Functions

static void LoadFormatted (ARCHIVE &aAr, int &aFormat)
 An item format, stored only from object schema 2, which governs what follows.
 

Public Attributes

wxString Name
 
OBJECT * Shapes = nullptr
 free copper list
 
OBJECT * Pads = nullptr
 free pad list
 
OBJECT * Texts = nullptr
 free text list
 
OBJECT * ValuePositions = nullptr
 
int32_t OriginX = 0
 
int32_t OriginY = 0
 
int32_t Timestamp = 0
 
wxString Library
 
std::unique_ptr< OBJECT > NameOrigin
 The symbol name origin of formats below 10003, which becomes the only value position.
 
std::unique_ptr< SOURCE_DESIGN_LIST > DerivedValuePositions
 
std::unique_ptr< SOURCE_VALUE_POSITION > DerivedNamePosition
 
OBJECT * Parent = nullptr
 null is the document in a design, nothing in a library item
 
OBJECT * Attributes = nullptr
 attribute array
 
const char * ClassName = "object"
 registered class name
 
uint16_t Schema = 0
 object schema from the class tag, 0 for an embedded member
 
size_t Offset = 0
 stream offset of the tag or of an embedded member's first field
 
int Format = NEWEST_ITEM_FORMAT
 

Detailed Description

Footprints and schematic symbols alike.

Definition at line 50 of file easypc_classes_library.h.

Member Function Documentation

◆ ItemFormat()

int EASYPC::SOURCE_SYMBOL::ItemFormat ( const ARCHIVE & aAr) const
inlineoverridevirtual

The version this object gates on; the base is the archive's current read format.

Reimplemented from EASYPC::SOURCE_DESIGN_ITEM.

Definition at line 53 of file easypc_classes_library.h.

References EASYPC::SELF_VERSIONED::Format.

◆ Load()

LOAD_TASK EASYPC::SOURCE_SYMBOL::Load ( ARCHIVE & aAr)
overridevirtual

Read this object's fields.

Reimplemented from EASYPC::SOURCE_DESIGN_ITEM.

Definition at line 39 of file easypc_classes_library.cpp.

References EASYPC::ARCHIVE::Create(), DerivedNamePosition, DerivedValuePositions, EASYPC::ARCHIVE::Embedded(), EASYPC::SELF_VERSIONED::Format, EASYPC::ARCHIVE::I32(), EASYPC::ARCHIVE::InBool(), EASYPC::SOURCE_ORIGIN::Layer, Library, EASYPC::SOURCE_DESIGN_ITEM::Load(), EASYPC::SOURCE_DESIGN_ITEM::LoadOldFormat(), EASYPC::ARCHIVE::MapObject(), Name, NameOrigin, EASYPC::ARCHIVE::Object(), OriginX, OriginY, Pads, EASYPC::SOURCE_ORIGIN::Position, EASYPC::ARCHIVE::Product(), EASYPC::PRODUCT_DESIGNSPARK, EASYPC::ARCHIVE::ReadString(), Shapes, EASYPC::ARCHIVE::Skip(), EASYPC::SkipMember(), Texts, EASYPC::SOURCE_ORIGIN::TextStyle, Timestamp, and ValuePositions.

◆ LoadFormatted()

void EASYPC::SOURCE_DESIGN_ITEM::LoadFormatted ( ARCHIVE & aAr,
int & aFormat )
staticinherited

An item format, stored only from object schema 2, which governs what follows.

Definition at line 154 of file easypc_classes_styles.cpp.

References EASYPC::ARCHIVE::I32(), EASYPC::ARCHIVE::ObjectSchema(), and EASYPC::ARCHIVE::SetReadFormat().

◆ LoadOldFormat()

void EASYPC::SOURCE_DESIGN_ITEM::LoadOldFormat ( ARCHIVE & aAr,
int & aFormat ) const
inherited

An older item format, stored only while the format is still 0.

Definition at line 162 of file easypc_classes_styles.cpp.

References EASYPC::ARCHIVE::I32(), ItemFormat(), and EASYPC::ARCHIVE::SetReadFormat().

Referenced by EASYPC::SOURCE_PCB_COMPONENT::Load(), EASYPC::SOURCE_SCM_COMPONENT::Load(), and EASYPC::SOURCE_SYMBOL::Load().

Member Data Documentation

◆ Attributes

OBJECT* EASYPC::SOURCE_DESIGN_ITEM::Attributes = nullptr
inherited

attribute array

Definition at line 133 of file easypc_classes_styles.h.

Referenced by EASYPC::ConvertComponentSymbol(), Load(), and EASYPC::partAttributes().

◆ ClassName

const char* EASYPC::OBJECT::ClassName = "object"
inherited

registered class name

Definition at line 130 of file easypc_archive.h.

Referenced by EASYPC::ARCHIVE::drive(), EASYPC::ARCHIVE::Embedded(), EASYPC::SOURCE_DESIGN_ITEM::ItemFormat(), EASYPC::ARCHIVE::MapObject(), EASYPC::ARCHIVE::readTag(), and EASYPC::ARCHIVE::throwBadClass().

◆ DerivedNamePosition

std::unique_ptr<SOURCE_VALUE_POSITION> EASYPC::SOURCE_SYMBOL::DerivedNamePosition

Definition at line 68 of file easypc_classes_library.h.

Referenced by Load().

◆ DerivedValuePositions

std::unique_ptr<SOURCE_DESIGN_LIST> EASYPC::SOURCE_SYMBOL::DerivedValuePositions

Definition at line 67 of file easypc_classes_library.h.

Referenced by Load().

◆ Format

int EASYPC::SELF_VERSIONED::Format = NEWEST_ITEM_FORMAT
inherited

Definition at line 45 of file easypc_classes_library.h.

Referenced by EASYPC::SOURCE_PCB_COMPONENT::ItemFormat(), EASYPC::SOURCE_SCM_COMPONENT::ItemFormat(), EASYPC::SOURCE_SYMBOL::ItemFormat(), EASYPC::SOURCE_PCB_COMPONENT::Load(), EASYPC::SOURCE_SCM_COMPONENT::Load(), and EASYPC::SOURCE_SYMBOL::Load().

◆ Library

wxString EASYPC::SOURCE_SYMBOL::Library

Definition at line 63 of file easypc_classes_library.h.

Referenced by Load().

◆ Name

wxString EASYPC::SOURCE_SYMBOL::Name

Definition at line 55 of file easypc_classes_library.h.

Referenced by EASYPC_PCB::ConvertFootprint(), EASYPC::ConvertSymbol(), Load(), EASYPC::placePoint(), and EASYPC::valueLines().

◆ NameOrigin

std::unique_ptr<OBJECT> EASYPC::SOURCE_SYMBOL::NameOrigin

The symbol name origin of formats below 10003, which becomes the only value position.

Definition at line 66 of file easypc_classes_library.h.

Referenced by Load().

◆ Offset

size_t EASYPC::OBJECT::Offset = 0
inherited

stream offset of the tag or of an embedded member's first field

Definition at line 132 of file easypc_archive.h.

Referenced by EASYPC::ARCHIVE::drive(), EASYPC::SOURCE_DESIGN_ITEM::ItemFormat(), EASYPC::ARCHIVE::readTag(), and EASYPC::ARCHIVE::throwBadClass().

◆ OriginX

int32_t EASYPC::SOURCE_SYMBOL::OriginX = 0

Definition at line 60 of file easypc_classes_library.h.

Referenced by EASYPC::ConvertComponentSymbol(), EASYPC_PCB::ConvertFootprint(), EASYPC::ConvertSymbol(), Load(), and EASYPC::placePoint().

◆ OriginY

int32_t EASYPC::SOURCE_SYMBOL::OriginY = 0

Definition at line 61 of file easypc_classes_library.h.

Referenced by EASYPC::ConvertComponentSymbol(), EASYPC_PCB::ConvertFootprint(), EASYPC::ConvertSymbol(), Load(), and EASYPC::placePoint().

◆ Pads

OBJECT* EASYPC::SOURCE_SYMBOL::Pads = nullptr

free pad list

Definition at line 57 of file easypc_classes_library.h.

Referenced by EASYPC::SCH_BUILDER::buildCommonPinCopies(), EASYPC::SCH_BUILDER::buildWires(), EASYPC_PCB::ConvertFootprint(), and Load().

◆ Parent

OBJECT* EASYPC::SOURCE_DESIGN_ITEM::Parent = nullptr
inherited

null is the document in a design, nothing in a library item

Definition at line 132 of file easypc_classes_styles.h.

Referenced by ItemFormat(), Load(), and EASYPC::netOf().

◆ Schema

uint16_t EASYPC::OBJECT::Schema = 0
inherited

object schema from the class tag, 0 for an embedded member

Definition at line 131 of file easypc_archive.h.

Referenced by EASYPC::SOURCE_COMMON_SHAPE::Load(), and EASYPC::ARCHIVE::readTag().

◆ Shapes

OBJECT* EASYPC::SOURCE_SYMBOL::Shapes = nullptr

free copper list

Definition at line 56 of file easypc_classes_library.h.

Referenced by EASYPC::SCH_BUILDER::computeOffset(), EASYPC_PCB::ConvertFootprint(), and Load().

◆ Texts

OBJECT* EASYPC::SOURCE_SYMBOL::Texts = nullptr

free text list

Definition at line 58 of file easypc_classes_library.h.

Referenced by EASYPC::SCH_BUILDER::computeOffset(), EASYPC_PCB::ConvertFootprint(), and Load().

◆ Timestamp

int32_t EASYPC::SOURCE_SYMBOL::Timestamp = 0

Definition at line 62 of file easypc_classes_library.h.

Referenced by Load().

◆ ValuePositions

OBJECT* EASYPC::SOURCE_SYMBOL::ValuePositions = nullptr

Definition at line 59 of file easypc_classes_library.h.

Referenced by EASYPC_PCB::ConvertFootprint(), and Load().

The documentation for this struct was generated from the following files: