#include <allegro_db.h>

Inheritance diagram for ALLEGRO::PTR_ARRAY:

Public Types
using	TYPE_ID = uint8_t

Public Member Functions
	PTR_ARRAY (const BRD_DB &aBrd, const BLK_0x37_PTR_ARRAY &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 DB_REF &	GetNext () const override
	Return the reference to the next object in the default chain for this object.

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

Public Attributes
DB_REF	m_Parent

std::vector< DB_REF >	m_Ptrs

bool	m_Valid

uint32_t	m_Key

FILE_LOC	m_Loc

DB_REF	m_Next

Private Attributes
BRD_TYPE	m_Type

Detailed Description

0x37 PTR_ARRAY objects.

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

◆ PTR_ARRAY()

PTR_ARRAY::PTR_ARRAY	(	const BRD_DB &	aBrd,
		const BLK_0x37_PTR_ARRAY &	aBlk )

Definition at line 1426 of file allegro_db.cpp.

References ALLEGRO::BRD_DB_OBJ::BRD_DB_OBJ(), ALLEGRO::BRD_PTR_ARRAY, ALLEGRO::BLK_0x37_PTR_ARRAY::m_Count, ALLEGRO::DB_OBJ::m_Key, ALLEGRO::DB_OBJ::m_Next, m_Parent, and m_Ptrs.

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.

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

const DB_REF & ALLEGRO::PTR_ARRAY::GetNext ( ) const

inlineoverridevirtual

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 from ALLEGRO::DB_OBJ.

Definition at line 900 of file allegro_db.h.

References ALLEGRO::DB_OBJ::m_Next.

◆ 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 PTR_ARRAY::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 1438 of file allegro_db.cpp.

References ALLEGRO::DB_OBJ::m_Next, m_Parent, and m_Ptrs.

◆ TypeName()

const char * ALLEGRO::PTR_ARRAY::TypeName ( ) const

inlineoverridevirtual

Reimplemented from ALLEGRO::DB_OBJ.

Definition at line 898 of file allegro_db.h.

Member Data Documentation

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

◆ m_Parent

DB_REF ALLEGRO::PTR_ARRAY::m_Parent

Definition at line 902 of file allegro_db.h.

Referenced by PTR_ARRAY(), and ResolveRefs().

◆ m_Ptrs

std::vector<DB_REF> ALLEGRO::PTR_ARRAY::m_Ptrs

Definition at line 904 of file allegro_db.h.

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

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

Public Types

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ TYPE_ID

Constructor & Destructor Documentation

◆ PTR_ARRAY()

Member Function Documentation

◆ GetBrdType()

◆ GetKey()

◆ GetNext()

◆ GetType()

◆ ResolveRefs()

◆ TypeName()

Member Data Documentation

◆ m_Key

◆ m_Loc

◆ m_Next

◆ m_Parent

◆ m_Ptrs

◆ m_Type

◆ m_Valid