KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Private Attributes | List of all members
ALLEGRO::FOOTPRINT_INSTANCE Struct Reference

0x2D objects More...

#include <allegro_db.h>

Inheritance diagram for ALLEGRO::FOOTPRINT_INSTANCE:
ALLEGRO::BRD_DB_OBJ ALLEGRO::DB_OBJ

Public Types

using TYPE_ID = uint8_t
 

Public Member Functions

 FOOTPRINT_INSTANCE (const BLK_0x2D_FOOTPRINT_INST &aBlk)
 
bool ResolveRefs (const DB_OBJ_RESOLVER &aResolver) override
 Called when all objects in the DB are read and can be resolved by their IDs by other objects.
 
const char * TypeName () const override
 
const COMPONENT_INST * GetComponentInstance () const
 
const wxString * GetName () const
 
TYPE_ID GetType () const override
 All blocks are denoted by a type which allows dispatch to the appropriate subclass.
 
BRD_TYPE GetBrdType () const
 
uint32_t GetKey () const
 
virtual const DB_REF & GetNext () const
 Return the reference to the next object in the default chain for this object.
 

Public Attributes

DB_REF m_ComponentInstance
 
double m_X
 
double m_Y
 
double m_Rotation
 
bool m_Mirrored
 
DB_REF_CHAIN m_Pads
 
DB_REF_CHAIN m_Graphics
 
FOOTPRINT_DEF * m_Parent
 
bool m_Valid
 
uint32_t m_Key
 
FILE_LOC m_Loc
 
DB_REF m_Next
 

Private Attributes

BRD_TYPE m_Type
 

Detailed Description

0x2D objects

Definition at line 800 of file allegro_db.h.

Member Typedef Documentation

◆ TYPE_ID

using ALLEGRO::DB_OBJ::TYPE_ID = uint8_t
inherited

Definition at line 169 of file allegro_db.h.

Constructor & Destructor Documentation

◆ FOOTPRINT_INSTANCE()

FOOTPRINT_INSTANCE::FOOTPRINT_INSTANCE ( const BLK_0x2D_FOOTPRINT_INST & aBlk)

Definition at line 1062 of file allegro_db.cpp.

References ALLEGRO::BRD_DB_OBJ::BRD_DB_OBJ(), ALLEGRO::BRD_FP_INST, ALLEGRO::BRD_PLACED_PAD, ALLEGRO::DB_NULLREF, GetPrimaryNext(), m_ComponentInstance, ALLEGRO::BLK_0x2D_FOOTPRINT_INST::m_CoordX, ALLEGRO::BLK_0x2D_FOOTPRINT_INST::m_CoordY, m_Graphics, ALLEGRO::DB_OBJ::m_Key, ALLEGRO::BLK_0x2D_FOOTPRINT_INST::m_Layer, m_Mirrored, ALLEGRO::DB_OBJ::m_Next, m_Pads, m_Parent, ALLEGRO::BLK_0x2D_FOOTPRINT_INST::m_Rotation, m_Rotation, m_X, and m_Y.

Member Function Documentation

◆ GetBrdType()

BRD_TYPE ALLEGRO::BRD_DB_OBJ::GetBrdType ( ) const
inlineinherited

Definition at line 369 of file allegro_db.h.

References m_Type.

◆ GetComponentInstance()

const COMPONENT_INST * FOOTPRINT_INSTANCE::GetComponentInstance ( ) const

Definition at line 1107 of file allegro_db.cpp.

References m_ComponentInstance.

Referenced by ALLEGRO::BRD_DB::visitFootprintInstances().

◆ GetKey()

uint32_t ALLEGRO::DB_OBJ::GetKey ( ) const
inlineinherited

Definition at line 219 of file allegro_db.h.

References m_Key.

Referenced by ALLEGRO::BOARD_BUILDER::applyConstraintSets(), ALLEGRO::BOARD_BUILDER::applyNetConstraints(), ALLEGRO::FOOTPRINT_DEF::ResolveRefs(), and ALLEGRO::BRD_DB::visitFootprintInstances().

◆ GetName()

const wxString * FOOTPRINT_INSTANCE::GetName ( ) const

Definition at line 1120 of file allegro_db.cpp.

References m_Parent.

◆ GetNext()

virtual const DB_REF & ALLEGRO::DB_OBJ::GetNext ( ) const
inlinevirtualinherited

Return the reference to the next object in the default chain for this object.

Some methods of iterating use other "nexts" in the object, fo those you should use the appropriate field instead of this method.

Reimplemented in ALLEGRO::PTR_ARRAY.

Definition at line 227 of file allegro_db.h.

References m_Next.

Referenced by GetPrimaryNext().

◆ GetType()

TYPE_ID ALLEGRO::BRD_DB_OBJ::GetType ( ) const
inlineoverridevirtualinherited

All blocks are denoted by a type which allows dispatch to the appropriate subclass.

Implements ALLEGRO::DB_OBJ.

Definition at line 364 of file allegro_db.h.

References m_Type.

◆ ResolveRefs()

bool FOOTPRINT_INSTANCE::ResolveRefs ( const DB_OBJ_RESOLVER & aResolver)
overridevirtual

Called when all objects in the DB are read and can be resolved by their IDs by other objects.

Exactly what fields a given object needs to resolve and what happens if the resolution fails is up to that object.

This can also validate that the objects found are of the expected types.

Before calling this, you cannot expect an DB_REF to have a valid target.

Returns
true if all fields in the object are resolved and valid

Implements ALLEGRO::DB_OBJ.

Definition at line 1092 of file allegro_db.cpp.

References ALLEGRO::BRD_COMPONENT_INST, CheckTypeIs(), m_ComponentInstance, m_Graphics, ALLEGRO::DB_OBJ::m_Next, and m_Pads.

◆ TypeName()

const char * ALLEGRO::FOOTPRINT_INSTANCE::TypeName ( ) const
inlineoverridevirtual

Reimplemented from ALLEGRO::DB_OBJ.

Definition at line 806 of file allegro_db.h.

Member Data Documentation

◆ m_ComponentInstance

DB_REF ALLEGRO::FOOTPRINT_INSTANCE::m_ComponentInstance

Definition at line 808 of file allegro_db.h.

Referenced by FOOTPRINT_INSTANCE(), GetComponentInstance(), and ResolveRefs().

◆ m_Graphics

DB_REF_CHAIN ALLEGRO::FOOTPRINT_INSTANCE::m_Graphics

Definition at line 818 of file allegro_db.h.

Referenced by FOOTPRINT_INSTANCE(), and ResolveRefs().

◆ m_Key

uint32_t ALLEGRO::DB_OBJ::m_Key
inherited

Definition at line 235 of file allegro_db.h.

Referenced by ALLEGRO::ARC::ARC(), ALLEGRO::COMPONENT::COMPONENT(), ALLEGRO::COMPONENT_INST::COMPONENT_INST(), ALLEGRO::CONNECTION_OBJ::CONNECTION_OBJ(), DB_OBJ(), ALLEGRO::FIELD::FIELD(), ALLEGRO::FOOTPRINT_DEF::FOOTPRINT_DEF(), ALLEGRO::FOOTPRINT_INSTANCE::FOOTPRINT_INSTANCE(), ALLEGRO::FUNCTION_INSTANCE::FUNCTION_INSTANCE(), ALLEGRO::FUNCTION_SLOT::FUNCTION_SLOT(), GetKey(), ALLEGRO::NET_ASSIGN::GetNet(), ALLEGRO::COMPONENT_INST::GetNextInstance(), ALLEGRO::GRAPHIC_SEG::GRAPHIC_SEG(), ALLEGRO::LINE::LINE(), ALLEGRO::NET::NET(), ALLEGRO::NET_ASSIGN::NET_ASSIGN(), ALLEGRO::PIN_NAME::PIN_NAME(), ALLEGRO::PIN_NUMBER::PIN_NUMBER(), ALLEGRO::PLACED_PAD::PLACED_PAD(), ALLEGRO::PTR_ARRAY::PTR_ARRAY(), ALLEGRO::RECT_OBJ::RECT_OBJ(), ALLEGRO::SHAPE::SHAPE(), ALLEGRO::TRACK::TRACK(), ALLEGRO::UNKNOWN_0x20::UNKNOWN_0x20(), ALLEGRO::VIA::VIA(), and ALLEGRO::XREF_OBJ::XREF_OBJ().

◆ m_Loc

FILE_LOC ALLEGRO::DB_OBJ::m_Loc
inherited

Definition at line 237 of file allegro_db.h.

Referenced by DB_OBJ().

◆ m_Mirrored

bool ALLEGRO::FOOTPRINT_INSTANCE::m_Mirrored

Definition at line 812 of file allegro_db.h.

Referenced by FOOTPRINT_INSTANCE().

◆ m_Next

DB_REF ALLEGRO::DB_OBJ::m_Next
inherited

Definition at line 239 of file allegro_db.h.

Referenced by ALLEGRO::ARC::ARC(), ALLEGRO::COMPONENT::COMPONENT(), ALLEGRO::COMPONENT_INST::COMPONENT_INST(), ALLEGRO::CONNECTION_OBJ::CONNECTION_OBJ(), DB_OBJ(), ALLEGRO::FIELD::FIELD(), ALLEGRO::FOOTPRINT_DEF::FOOTPRINT_DEF(), ALLEGRO::FOOTPRINT_INSTANCE::FOOTPRINT_INSTANCE(), GetNext(), ALLEGRO::PTR_ARRAY::GetNext(), ALLEGRO::COMPONENT_INST::GetNextInstance(), ALLEGRO::GRAPHIC_SEG::GRAPHIC_SEG(), ALLEGRO::LINE::LINE(), ALLEGRO::NET::NET(), ALLEGRO::NET_ASSIGN::NET_ASSIGN(), ALLEGRO::PIN_NAME::PIN_NAME(), ALLEGRO::PIN_NUMBER::PIN_NUMBER(), ALLEGRO::PLACED_PAD::PLACED_PAD(), ALLEGRO::PTR_ARRAY::PTR_ARRAY(), ALLEGRO::RECT_OBJ::RECT_OBJ(), ALLEGRO::ARC::ResolveRefs(), ALLEGRO::COMPONENT::ResolveRefs(), ALLEGRO::COMPONENT_INST::ResolveRefs(), ALLEGRO::CONNECTION_OBJ::ResolveRefs(), ALLEGRO::FOOTPRINT_DEF::ResolveRefs(), ALLEGRO::FOOTPRINT_INSTANCE::ResolveRefs(), ALLEGRO::GRAPHIC_SEG::ResolveRefs(), ALLEGRO::LINE::ResolveRefs(), ALLEGRO::NET::ResolveRefs(), ALLEGRO::NET_ASSIGN::ResolveRefs(), ALLEGRO::PIN_NAME::ResolveRefs(), ALLEGRO::PIN_NUMBER::ResolveRefs(), ALLEGRO::PLACED_PAD::ResolveRefs(), ALLEGRO::PTR_ARRAY::ResolveRefs(), ALLEGRO::RECT_OBJ::ResolveRefs(), ALLEGRO::SHAPE::ResolveRefs(), ALLEGRO::TRACK::ResolveRefs(), ALLEGRO::UNKNOWN_0x20::ResolveRefs(), ALLEGRO::VIA::ResolveRefs(), ALLEGRO::SHAPE::SHAPE(), ALLEGRO::TRACK::TRACK(), ALLEGRO::UNKNOWN_0x20::UNKNOWN_0x20(), ALLEGRO::VIA::VIA(), ALLEGRO::BRD_DB::VisitComponents(), ALLEGRO::BRD_DB::VisitFootprintDefs(), and ALLEGRO::BRD_DB::VisitNets().

◆ m_Pads

DB_REF_CHAIN ALLEGRO::FOOTPRINT_INSTANCE::m_Pads

Definition at line 815 of file allegro_db.h.

Referenced by FOOTPRINT_INSTANCE(), and ResolveRefs().

◆ m_Parent

FOOTPRINT_DEF* ALLEGRO::FOOTPRINT_INSTANCE::m_Parent

Definition at line 821 of file allegro_db.h.

Referenced by FOOTPRINT_INSTANCE(), GetName(), and ALLEGRO::FOOTPRINT_DEF::ResolveRefs().

◆ m_Rotation

double ALLEGRO::FOOTPRINT_INSTANCE::m_Rotation

Definition at line 811 of file allegro_db.h.

Referenced by FOOTPRINT_INSTANCE().

◆ m_Type

BRD_TYPE ALLEGRO::BRD_DB_OBJ::m_Type
privateinherited

Definition at line 372 of file allegro_db.h.

Referenced by BRD_DB_OBJ(), GetBrdType(), and GetType().

◆ m_Valid

bool ALLEGRO::DB_OBJ::m_Valid
inherited

Definition at line 233 of file allegro_db.h.

Referenced by DB_OBJ().

◆ m_X

double ALLEGRO::FOOTPRINT_INSTANCE::m_X

Definition at line 809 of file allegro_db.h.

Referenced by FOOTPRINT_INSTANCE().

◆ m_Y

double ALLEGRO::FOOTPRINT_INSTANCE::m_Y

Definition at line 810 of file allegro_db.h.

Referenced by FOOTPRINT_INSTANCE().

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