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

COMPONENT 0x06 objects. More...

#include <allegro_db.h>

Inheritance diagram for ALLEGRO::COMPONENT:
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

 COMPONENT (const BRD_DB &aBrd, const BLK_0x06_COMPONENT &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_INST & GetComponentInstance () const
 
const wxString * GetComponentDeviceType () const
 
TYPE GetType () const
 
uint32_t GetKey () const
 

Public Attributes

DB_REF m_Next
 
DB_STR_REF m_CompDeviceType
 
DB_STR_REF m_SymbolName
 
DB_REF_CHAIN m_Instances
 
DB_REF m_PtrFunctionSlot
 
DB_REF m_PtrPinNumber
 
DB_REF m_Fields
 
bool m_Valid
 
TYPE m_Type
 
uint32_t m_Key
 
FILE_LOC m_Loc
 

Detailed Description

COMPONENT 0x06 objects.

One per component definition (symbol) in the library.

Definition at line 440 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

◆ COMPONENT()

COMPONENT::COMPONENT ( const BRD_DB & aBrd,
const BLK_0x06_COMPONENT & aBlk )

Definition at line 708 of file allegro_db.cpp.

References COMPONENT(), ALLEGRO::DB_OBJ::COMPONENT_INST, ALLEGRO::DB_OBJ::DB_OBJ(), ALLEGRO::BLK_0x06_COMPONENT::m_CompDeviceType, m_CompDeviceType, ALLEGRO::BLK_0x06_COMPONENT::m_Fields, m_Fields, ALLEGRO::BLK_0x06_COMPONENT::m_FirstInstPtr, ALLEGRO::BRD_DB::m_Header, m_Instances, ALLEGRO::BLK_0x06_COMPONENT::m_Key, ALLEGRO::DB_OBJ::m_Key, ALLEGRO::BLK_0x06_COMPONENT::m_Next, m_Next, ALLEGRO::COMPONENT_INST::m_Next, ALLEGRO::BLK_0x06_COMPONENT::m_PtrFunctionSlot, m_PtrFunctionSlot, ALLEGRO::BLK_0x06_COMPONENT::m_PtrPinNumber, m_PtrPinNumber, ALLEGRO::BLK_0x06_COMPONENT::m_SymbolName, m_SymbolName, and ALLEGRO::DB_REF::m_TargetKey.

Referenced by COMPONENT().

Member Function Documentation

◆ GetComponentDeviceType()

const wxString * COMPONENT::GetComponentDeviceType ( ) const

Definition at line 759 of file allegro_db.cpp.

References m_CompDeviceType.

◆ GetComponentInstance()

const COMPONENT_INST & ALLEGRO::COMPONENT::GetComponentInstance ( ) const

References ALLEGRO::DB_OBJ::COMPONENT_INST.

◆ GetKey()

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

Definition at line 234 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().

◆ GetType()

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

Definition at line 232 of file allegro_db.h.

References m_Type.

Referenced by CheckTypeIs(), CheckTypeIsOneOf(), ALLEGRO::FIELD_LIST::GetOptField(), ALLEGRO::FIELD_LIST::GetOptFieldExpectInt(), and ALLEGRO::FIELD_LIST::GetOptFieldExpectString().

◆ ResolveRefs()

bool COMPONENT::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 741 of file allegro_db.cpp.

References CheckTypeIs(), m_CompDeviceType, m_Fields, m_Instances, m_Next, m_PtrFunctionSlot, m_PtrPinNumber, and m_SymbolName.

Member Data Documentation

◆ m_CompDeviceType

DB_STR_REF ALLEGRO::COMPONENT::m_CompDeviceType

Definition at line 447 of file allegro_db.h.

Referenced by COMPONENT(), GetComponentDeviceType(), and ResolveRefs().

◆ m_Fields

DB_REF ALLEGRO::COMPONENT::m_Fields

Definition at line 452 of file allegro_db.h.

Referenced by COMPONENT(), and ResolveRefs().

◆ m_Instances

DB_REF_CHAIN ALLEGRO::COMPONENT::m_Instances

Definition at line 449 of file allegro_db.h.

Referenced by COMPONENT(), ResolveRefs(), and ALLEGRO::BRD_DB::VisitComponents().

◆ m_Key

uint32_t ALLEGRO::DB_OBJ::m_Key
inherited

Definition at line 241 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::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 243 of file allegro_db.h.

Referenced by DB_OBJ().

◆ m_Next

DB_REF ALLEGRO::COMPONENT::m_Next

Definition at line 446 of file allegro_db.h.

Referenced by COMPONENT(), ResolveRefs(), and ALLEGRO::BRD_DB::VisitComponents().

◆ m_PtrFunctionSlot

DB_REF ALLEGRO::COMPONENT::m_PtrFunctionSlot

Definition at line 450 of file allegro_db.h.

Referenced by COMPONENT(), and ResolveRefs().

◆ m_PtrPinNumber

DB_REF ALLEGRO::COMPONENT::m_PtrPinNumber

Definition at line 451 of file allegro_db.h.

Referenced by COMPONENT(), and ResolveRefs().

◆ m_SymbolName

DB_STR_REF ALLEGRO::COMPONENT::m_SymbolName

Definition at line 448 of file allegro_db.h.

Referenced by COMPONENT(), and ResolveRefs().

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

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