ALLEGRO::COMPONENT_INST Struct Reference

COMPONENT_INST 0x07 objects. More...

#include <allegro_db.h>

Inheritance diagram for ALLEGRO::COMPONENT_INST:

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_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 COMPONENT *	GetParentComponent () const
const wxString *	GetRefDesStr () const
const COMPONENT_INST *	GetNextInstance () const
const FUNCTION_INSTANCE &	GetFunctionInstance () const
const PLACED_PAD &	GetFirstPad () const
TYPE	GetType () const
uint32_t	GetKey () const

Public Attributes
DB_REF	m_Next
DB_STR_REF	m_TextStr
DB_REF	m_FunctionInst
DB_REF	m_X03Chain
DB_REF_CHAIN	m_Pads
COMPONENT *	m_ParentComponent = nullptr
bool	m_Valid
TYPE	m_Type
uint32_t	m_Key
FILE_LOC	m_Loc

Detailed Description

COMPONENT_INST 0x07 objects.

These represent instances of COMPONENTs placed on the board.

Definition at line 464 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_INST()

COMPONENT_INST::COMPONENT_INST

(

const BLK_0x07_COMPONENT_INST &

aBlk

)

Definition at line 765 of file allegro_db.cpp.

References COMPONENT_INST(), ALLEGRO::DB_OBJ::DB_OBJ(), ALLEGRO::BLK_0x07_COMPONENT_INST::m_FirstPadPtr, m_FunctionInst, ALLEGRO::BLK_0x07_COMPONENT_INST::m_FunctionInstPtr, ALLEGRO::BLK_0x07_COMPONENT_INST::m_Key, ALLEGRO::DB_OBJ::m_Key, ALLEGRO::BLK_0x07_COMPONENT_INST::m_Next, m_Next, m_Pads, ALLEGRO::BLK_0x07_COMPONENT_INST::m_RefDesStrPtr, m_TextStr, pad, and ALLEGRO::DB_OBJ::PLACED_PAD.

Referenced by COMPONENT_INST(), and GetNextInstance().

Member Function Documentation

GetFirstPad()

const PLACED_PAD & ALLEGRO::COMPONENT_INST::GetFirstPad

(

)

const

References ALLEGRO::DB_OBJ::PLACED_PAD.

GetFunctionInstance()

const FUNCTION_INSTANCE & COMPONENT_INST::GetFunctionInstance

(

)

const

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

GetNextInstance()

const COMPONENT_INST * COMPONENT_INST::GetNextInstance

(

)

const

Definition at line 817 of file allegro_db.cpp.

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

GetParentComponent()

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

inline

Definition at line 478 of file allegro_db.h.

References ALLEGRO::DB_OBJ::COMPONENT, and m_ParentComponent.

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

GetRefDesStr()

const wxString * COMPONENT_INST::GetRefDesStr

(

)

const

Definition at line 800 of file allegro_db.cpp.

References m_TextStr.

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_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 787 of file allegro_db.cpp.

References m_FunctionInst, m_Next, m_Pads, and m_TextStr.

Member Data Documentation

m_FunctionInst

DB_REF ALLEGRO::COMPONENT_INST::m_FunctionInst

Definition at line 472 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 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_INST::m_Next

Definition at line 470 of file allegro_db.h.

Referenced by ALLEGRO::COMPONENT::COMPONENT(), COMPONENT_INST(), GetNextInstance(), and ResolveRefs().

m_Pads

DB_REF_CHAIN ALLEGRO::COMPONENT_INST::m_Pads

Definition at line 474 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 476 of file allegro_db.h.

Referenced by GetParentComponent().

m_TextStr

DB_STR_REF ALLEGRO::COMPONENT_INST::m_TextStr

Definition at line 471 of file allegro_db.h.

Referenced by COMPONENT_INST(), GetRefDesStr(), 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().

m_X03Chain

DB_REF ALLEGRO::COMPONENT_INST::m_X03Chain

Definition at line 473 of file allegro_db.h.

---

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

• allegro_db.h
• allegro_db.cpp