KiCad PCB EDA Suite
Loading...
Searching...
No Matches
ALLEGRO::FOOTPRINT_INSTANCE Struct Reference

0x2D objects More...

#include <allegro_db.h>

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

Public Types

enum class  TYPE {
  ARC , FIELD , TRACK , NET_ASSIGN ,
  COMPONENT , COMPONENT_INST , PIN_NUMBER , x0e_RECT ,
  FUNCTION_SLOT , FUNCTION_INST , PIN_NAME , XREF ,
  GRAPHIC_SEG , LINE , NET , x20 ,
  SHAPE , FP_DEF , FP_INST , CONNECTION ,
  PLACED_PAD , VIA , KEEPOUT , x35 ,
  x36 , x37 , FILM_LAYER_LIST , FILM ,
  x3b , x3c
}
 

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 COMPONENT_INSTGetComponentInstance () const
 
const wxString * GetName () const
 
TYPE GetType () const
 
uint32_t GetKey () const
 

Public Attributes

DB_REF m_Next
 
DB_REF m_ComponentInstance
 
double m_X
 
double m_Y
 
double m_Rotation
 
bool m_Mirrored
 
DB_REF_CHAIN m_Pads
 
FOOTPRINT_DEFm_Parent
 
bool m_Valid
 
TYPE m_Type
 
uint32_t m_Key
 
FILE_LOC m_Loc
 

Detailed Description

0x2D objects

Definition at line 727 of file allegro_db.h.

Member Enumeration Documentation

◆ TYPE

enum class ALLEGRO::DB_OBJ::TYPE
stronginherited
Enumerator
ARC 
FIELD 
TRACK 
NET_ASSIGN 
COMPONENT 
COMPONENT_INST 
PIN_NUMBER 
x0e_RECT 
FUNCTION_SLOT 
FUNCTION_INST 
PIN_NAME 
XREF 
GRAPHIC_SEG 
LINE 
NET 
x20 
SHAPE 
FP_DEF 
FP_INST 
CONNECTION 
PLACED_PAD 
VIA 
KEEPOUT 
x35 
x36 
x37 
FILM_LAYER_LIST 
FILM 
x3b 
x3c 

Definition at line 163 of file allegro_db.h.

Constructor & Destructor Documentation

◆ FOOTPRINT_INSTANCE()

Member Function Documentation

◆ GetComponentInstance()

const COMPONENT_INST * FOOTPRINT_INSTANCE::GetComponentInstance ( ) const

◆ GetKey()

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

◆ GetName()

const wxString * FOOTPRINT_INSTANCE::GetName ( ) const

Definition at line 1158 of file allegro_db.cpp.

References m_Parent.

◆ GetType()

TYPE ALLEGRO::DB_OBJ::GetType ( ) const
inlineinherited

◆ 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 1131 of file allegro_db.cpp.

References CheckTypeIs(), m_ComponentInstance, m_Next, and m_Pads.

Member Data Documentation

◆ m_ComponentInstance

DB_REF ALLEGRO::FOOTPRINT_INSTANCE::m_ComponentInstance

Definition at line 734 of file allegro_db.h.

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

◆ m_Key

◆ m_Loc

FILE_LOC ALLEGRO::DB_OBJ::m_Loc
inherited

Definition at line 243 of file allegro_db.h.

Referenced by DB_OBJ().

◆ m_Mirrored

bool ALLEGRO::FOOTPRINT_INSTANCE::m_Mirrored

Definition at line 738 of file allegro_db.h.

◆ m_Next

DB_REF ALLEGRO::FOOTPRINT_INSTANCE::m_Next

Definition at line 733 of file allegro_db.h.

Referenced by FOOTPRINT_INSTANCE(), and ResolveRefs().

◆ m_Pads

DB_REF_CHAIN ALLEGRO::FOOTPRINT_INSTANCE::m_Pads

Definition at line 741 of file allegro_db.h.

Referenced by FOOTPRINT_INSTANCE(), and ResolveRefs().

◆ m_Parent

FOOTPRINT_DEF* ALLEGRO::FOOTPRINT_INSTANCE::m_Parent

Definition at line 744 of file allegro_db.h.

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

◆ m_Rotation

double ALLEGRO::FOOTPRINT_INSTANCE::m_Rotation

Definition at line 737 of file allegro_db.h.

◆ m_Type

TYPE ALLEGRO::DB_OBJ::m_Type
inherited

Definition at line 239 of file allegro_db.h.

Referenced by DB_OBJ(), and GetType().

◆ m_Valid

bool ALLEGRO::DB_OBJ::m_Valid
inherited

Definition at line 237 of file allegro_db.h.

Referenced by DB_OBJ().

◆ m_X

double ALLEGRO::FOOTPRINT_INSTANCE::m_X

Definition at line 735 of file allegro_db.h.

◆ m_Y

double ALLEGRO::FOOTPRINT_INSTANCE::m_Y

Definition at line 736 of file allegro_db.h.


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