ALLEGRO::FUNCTION_SLOT Struct Reference

A FUNCTION_SLOT (0x0F) object represents a single function slot within a symbol. More...

#include <allegro_db.h>

Inheritance diagram for ALLEGRO::FUNCTION_SLOT:

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

Public Attributes
DB_STR_REF	m_SlotName
wxString	m_CompDeviceType
DB_REF	m_NextSlot
DB_REF	m_Component
DB_REF	m_PinName
bool	m_Valid
TYPE	m_Type
uint32_t	m_Key
FILE_LOC	m_Loc

Detailed Description

A FUNCTION_SLOT (0x0F) object represents a single function slot within a symbol.

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

FUNCTION_SLOT()

FUNCTION_SLOT::FUNCTION_SLOT

(

const BLK_0x0F_FUNCTION_SLOT &

aBlk

)

Definition at line 1167 of file allegro_db.cpp.

References ALLEGRO::DB_OBJ::DB_OBJ(), FUNCTION_SLOT(), ALLEGRO::BLK_0x0F_FUNCTION_SLOT::m_CompDeviceType, m_CompDeviceType, m_Component, ALLEGRO::DB_OBJ::m_Key, m_PinName, ALLEGRO::BLK_0x0F_FUNCTION_SLOT::m_Ptr0x06, ALLEGRO::BLK_0x0F_FUNCTION_SLOT::m_Ptr0x11, ALLEGRO::BLK_0x0F_FUNCTION_SLOT::m_SlotName, and m_SlotName.

Referenced by FUNCTION_SLOT().

Member Function Documentation

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

GetName()

const wxString * FUNCTION_SLOT::GetName

(

)

const

Definition at line 1198 of file allegro_db.cpp.

References m_SlotName.

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 FUNCTION_SLOT::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 1183 of file allegro_db.cpp.

References m_Component, m_PinName, and m_SlotName.

Member Data Documentation

m_CompDeviceType

wxString ALLEGRO::FUNCTION_SLOT::m_CompDeviceType

Definition at line 529 of file allegro_db.h.

Referenced by FUNCTION_SLOT().

m_Component

DB_REF ALLEGRO::FUNCTION_SLOT::m_Component

Definition at line 532 of file allegro_db.h.

Referenced by FUNCTION_SLOT(), 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_NextSlot

DB_REF ALLEGRO::FUNCTION_SLOT::m_NextSlot

Definition at line 531 of file allegro_db.h.

m_PinName

DB_REF ALLEGRO::FUNCTION_SLOT::m_PinName

Definition at line 533 of file allegro_db.h.

Referenced by FUNCTION_SLOT(), and ResolveRefs().

m_SlotName

DB_STR_REF ALLEGRO::FUNCTION_SLOT::m_SlotName

Definition at line 528 of file allegro_db.h.

Referenced by FUNCTION_SLOT(), GetName(), 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:

• allegro_db.h
• allegro_db.cpp