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

A via span from top_layer to bottom_layer inclusive, in stack order. More...

#include <easypc_classes_styles.h>

Inheritance diagram for EASYPC::SOURCE_LAYER_SPAN:
EASYPC::SOURCE_LAYER EASYPC::SOURCE_DESIGN_ITEM EASYPC::OBJECT

Public Member Functions

LOAD_TASK Load (ARCHIVE &aAr) override
 Read this object's fields.
 
int32_t EffectiveUsage () const
 The usage of the layer's type, or its own for a layer set.
 
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

SOURCE_LAYER * TopLayer = nullptr
 
SOURCE_LAYER * BottomLayer = nullptr
 
wxString Name
 
LAYER_SIDE Side = LAYER_SIDE::TOP
 
wxString TypeName
 below v3000 the type is stored by name
 
SOURCE_LAYER_TYPE * Type = nullptr
 null for the layer sets
 
int32_t Usage = 0
 
bool Displayed = true
 
OBJECT * Net = nullptr
 net of a power plane
 
OBJECT * Terminals = nullptr
 copper terminal array
 
std::unique_ptr< SOURCE_LAYER_TYPE > ConvertedType
 The type made from type_name.
 
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
 

Detailed Description

A via span from top_layer to bottom_layer inclusive, in stack order.

Definition at line 263 of file easypc_classes_styles.h.

Member Function Documentation

◆ EffectiveUsage()

int32_t EASYPC::SOURCE_LAYER::EffectiveUsage ( ) const
inlineinherited

The usage of the layer's type, or its own for a layer set.

Definition at line 246 of file easypc_classes_styles.h.

References Type, and Usage.

◆ ItemFormat()

int EASYPC::SOURCE_DESIGN_ITEM::ItemFormat ( const ARCHIVE & aAr) const
overridevirtualinherited

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

Reimplemented from EASYPC::OBJECT.

Reimplemented in EASYPC::SOURCE_PCB_COMPONENT, EASYPC::SOURCE_SCM_COMPONENT, and EASYPC::SOURCE_SYMBOL.

Definition at line 126 of file easypc_classes_styles.cpp.

References _, EASYPC::OBJECT::ClassName, EASYPC::ARCHIVE::CurrentReadFormat(), EASYPC::OBJECT::Offset, EASYPC::ARCHIVE::OrphanFormat(), Parent, EASYPC::ARCHIVE::ParentWalkDepth(), and THROW_IO_ERROR.

Referenced by EASYPC::SOURCE_AREA::Load(), EASYPC::SOURCE_ATTRIBUTE_NAME::Load(), EASYPC::SOURCE_BOARD::Load(), EASYPC::SOURCE_BUS::Load(), EASYPC::SOURCE_COMPONENT_INSTANCE::Load(), EASYPC::SOURCE_CONNECT_POINT::Load(), EASYPC::SOURCE_DEFAULTS::Load(), Load(), EASYPC::SOURCE_DESIGN_SPACINGS::Load(), EASYPC::SOURCE_FREE_COPPER::Load(), EASYPC::SOURCE_FREE_PAD::Load(), EASYPC::SOURCE_FREE_TEXT::Load(), EASYPC::SOURCE_GATE::Load(), EASYPC::SOURCE_GATE_MAP::Load(), EASYPC::SOURCE_GATE_PIN::Load(), EASYPC::SOURCE_GROUP::Load(), EASYPC::SOURCE_LAYER::Load(), EASYPC::SOURCE_LAYER_TYPE::Load(), EASYPC::SOURCE_LINE_STYLE::Load(), EASYPC::SOURCE_NET::Load(), EASYPC::SOURCE_NET_CLASS::Load(), EASYPC::SOURCE_ORIGIN::Load(), EASYPC::SOURCE_PAD_INSTANCE::Load(), EASYPC::SOURCE_PAD_STYLE::Load(), EASYPC::SOURCE_PAD_STYLE_EXCEPTION::Load(), EASYPC::SOURCE_PIN_NAME::Load(), EASYPC::SOURCE_PIN_NAME_INSTANCE::Load(), EASYPC::SOURCE_SHAPE_ITEM::Load(), EASYPC::SOURCE_SPACINGS::Load(), EASYPC::SOURCE_SYMBOL_INSTANCE::Load(), EASYPC::SOURCE_TEXT_STYLE::Load(), EASYPC::SOURCE_VALUE_POSITION::Load(), EASYPC::SOURCE_VIA::Load(), LoadOldFormat(), and EASYPC::SOURCE_TEXT_POSITION::LoadRemainder().

◆ Load()

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

Read this object's fields.

Reimplemented from EASYPC::SOURCE_LAYER.

Definition at line 407 of file easypc_classes_styles.cpp.

References BottomLayer, EASYPC::SOURCE_LAYER::Load(), EASYPC::ARCHIVE::ObjectAs(), and TopLayer.

◆ 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().

◆ BottomLayer

SOURCE_LAYER* EASYPC::SOURCE_LAYER_SPAN::BottomLayer = nullptr

Definition at line 268 of file easypc_classes_styles.h.

Referenced by Load().

◆ 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().

◆ ConvertedType

std::unique_ptr<SOURCE_LAYER_TYPE> EASYPC::SOURCE_LAYER::ConvertedType
inherited

The type made from type_name.

Definition at line 258 of file easypc_classes_styles.h.

Referenced by Load().

◆ Displayed

bool EASYPC::SOURCE_LAYER::Displayed = true
inherited

Definition at line 253 of file easypc_classes_styles.h.

Referenced by Load().

◆ Name

wxString EASYPC::SOURCE_LAYER::Name
inherited

Definition at line 248 of file easypc_classes_styles.h.

Referenced by Load(), and EASYPC_PCB::LAYER_MAPPER::PadLayers().

◆ Net

OBJECT* EASYPC::SOURCE_LAYER::Net = nullptr
inherited

net of a power plane

Definition at line 254 of file easypc_classes_styles.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().

◆ 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().

◆ Side

LAYER_SIDE EASYPC::SOURCE_LAYER::Side = LAYER_SIDE::TOP
inherited

Definition at line 249 of file easypc_classes_styles.h.

Referenced by Load(), and EASYPC_PCB::LAYER_MAPPER::PadLayers().

◆ Terminals

OBJECT* EASYPC::SOURCE_LAYER::Terminals = nullptr
inherited

copper terminal array

Definition at line 255 of file easypc_classes_styles.h.

Referenced by Load().

◆ TopLayer

SOURCE_LAYER* EASYPC::SOURCE_LAYER_SPAN::TopLayer = nullptr

Definition at line 267 of file easypc_classes_styles.h.

Referenced by Load().

◆ Type

SOURCE_LAYER_TYPE* EASYPC::SOURCE_LAYER::Type = nullptr
inherited

null for the layer sets

Definition at line 251 of file easypc_classes_styles.h.

Referenced by EffectiveUsage(), EASYPC_PCB::LAYER_MAPPER::GrowByLayer(), and Load().

◆ TypeName

wxString EASYPC::SOURCE_LAYER::TypeName
inherited

below v3000 the type is stored by name

Definition at line 250 of file easypc_classes_styles.h.

Referenced by Load().

◆ Usage

int32_t EASYPC::SOURCE_LAYER::Usage = 0
inherited

Definition at line 252 of file easypc_classes_styles.h.

Referenced by EffectiveUsage(), Load(), and EASYPC_PCB::LAYER_MAPPER::PadLayers().

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