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

COMPONENT_INST 0x07 objects. More...

#include <allegro_db.h>

Inheritance diagram for ALLEGRO::COMPONENT_INST:
ALLEGRO::BRD_DB_OBJ ALLEGRO::DB_OBJ

Public Types

using TYPE_ID = uint8_t
 

Public Member Functions

 COMPONENT_INST (const BLK_0x07_COMPONENT_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 * GetParentComponent () const
 
const wxString * GetRefDesStr () const
 
const COMPONENT_INST * GetNextInstance () const
 
const FUNCTION_INSTANCE & GetFunctionInstance () const
 
const PLACED_PAD & GetFirstPad () 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_STR_REF m_TextStr
 
DB_REF m_FunctionInst
 
DB_REF_CHAIN m_X03Chain
 
DB_REF_CHAIN m_Pads
 
COMPONENT * m_ParentComponent = nullptr
 
bool m_Valid
 
uint32_t m_Key
 
FILE_LOC m_Loc
 
DB_REF m_Next
 

Private Attributes

BRD_TYPE m_Type
 

Detailed Description

COMPONENT_INST 0x07 objects.

These represent instances of COMPONENTs placed on the board.

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

◆ COMPONENT_INST()

COMPONENT_INST::COMPONENT_INST ( const BLK_0x07_COMPONENT_INST & aBlk)

Definition at line 779 of file allegro_db.cpp.

References ALLEGRO::BRD_COMPONENT_INST, ALLEGRO::BRD_DB_OBJ::BRD_DB_OBJ(), m_FunctionInst, ALLEGRO::DB_OBJ::m_Key, ALLEGRO::DB_OBJ::m_Next, m_Pads, m_TextStr, m_X03Chain, and pad.

Referenced by GetNextInstance().

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.

◆ GetFirstPad()

const PLACED_PAD & ALLEGRO::COMPONENT_INST::GetFirstPad ( ) const

◆ GetFunctionInstance()

const FUNCTION_INSTANCE & COMPONENT_INST::GetFunctionInstance ( ) const

Definition at line 813 of file allegro_db.cpp.

References m_FunctionInst, and THROW_IO_ERROR.

Referenced by ALLEGRO::BRD_DB::VisitComponents(), and 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().

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

◆ GetNextInstance()

const COMPONENT_INST * COMPONENT_INST::GetNextInstance ( ) const

Definition at line 824 of file allegro_db.cpp.

References ALLEGRO::BRD_COMPONENT_INST, COMPONENT_INST(), ALLEGRO::DB_OBJ::m_Key, and ALLEGRO::DB_OBJ::m_Next.

◆ GetParentComponent()

const COMPONENT * ALLEGRO::COMPONENT_INST::GetParentComponent ( ) const
inline

Definition at line 539 of file allegro_db.h.

References m_ParentComponent.

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

◆ GetRefDesStr()

const wxString * COMPONENT_INST::GetRefDesStr ( ) const

Definition at line 807 of file allegro_db.cpp.

References m_TextStr.

◆ 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 COMPONENT_INST::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 794 of file allegro_db.cpp.

References m_FunctionInst, ALLEGRO::DB_OBJ::m_Next, m_Pads, and m_TextStr.

◆ TypeName()

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

Reimplemented from ALLEGRO::DB_OBJ.

Definition at line 530 of file allegro_db.h.

Member Data Documentation

◆ m_FunctionInst

DB_REF ALLEGRO::COMPONENT_INST::m_FunctionInst

Definition at line 533 of file allegro_db.h.

Referenced by COMPONENT_INST(), GetFunctionInstance(), 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_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::COMPONENT_INST::m_Pads

Definition at line 535 of file allegro_db.h.

Referenced by COMPONENT_INST(), ResolveRefs(), and ALLEGRO::BRD_DB::VisitComponentPins().

◆ m_ParentComponent

COMPONENT* ALLEGRO::COMPONENT_INST::m_ParentComponent = nullptr

Definition at line 537 of file allegro_db.h.

Referenced by GetParentComponent().

◆ m_TextStr

DB_STR_REF ALLEGRO::COMPONENT_INST::m_TextStr

Definition at line 532 of file allegro_db.h.

Referenced by COMPONENT_INST(), GetRefDesStr(), and ResolveRefs().

◆ 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_X03Chain

DB_REF_CHAIN ALLEGRO::COMPONENT_INST::m_X03Chain

Definition at line 534 of file allegro_db.h.

Referenced by COMPONENT_INST().

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