ALLEGRO::DB_OBJ Struct Reference

A DB_OBJ represents one object in an Allegro database. More...

#include <allegro_db.h>

Inheritance diagram for ALLEGRO::DB_OBJ:

Classes
struct	FILE_LOC

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
	DB_OBJ (TYPE aType, uint32_t aKey)
	DB_OBJ ()
virtual	~DB_OBJ ()
virtual bool	ResolveRefs (const DB_OBJ_RESOLVER &aResolver)=0
	Called when all objects in the DB are read and can be resolved by their IDs by other objects.
TYPE	GetType () const
uint32_t	GetKey () const

Public Attributes
bool	m_Valid
TYPE	m_Type
uint32_t	m_Key
FILE_LOC	m_Loc

Detailed Description

A DB_OBJ represents one object in an Allegro database.

Definition at line 161 of file allegro_db.h.

Member Enumeration Documentation

TYPE

enum class ALLEGRO::DB_OBJ::TYPE

strong

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

DB_OBJ() [1/2]

ALLEGRO::DB_OBJ::DB_OBJ ( TYPE aType, uint32_t aKey )

inline

Definition at line 204 of file allegro_db.h.

References m_Key, m_Loc, m_Type, and m_Valid.

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(), 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::FOOTPRINT_DEF::ResolveRefs(), ALLEGRO::SHAPE::SHAPE(), ALLEGRO::TRACK::TRACK(), ALLEGRO::UNKNOWN_0x20::UNKNOWN_0x20(), ALLEGRO::VIA::VIA(), and ALLEGRO::XREF_OBJ::XREF_OBJ().

DB_OBJ() [2/2]

ALLEGRO::DB_OBJ::DB_OBJ ( )

inline

Definition at line 212 of file allegro_db.h.

References ARC, and DB_OBJ().

~DB_OBJ()

virtual ALLEGRO::DB_OBJ::~DB_OBJ ( )

inlinevirtual

Definition at line 217 of file allegro_db.h.

Member Function Documentation

GetKey()

uint32_t ALLEGRO::DB_OBJ::GetKey ( ) const

inline

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

inline

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

virtual bool ALLEGRO::DB_OBJ::ResolveRefs ( const DB_OBJ_RESOLVER & aResolver )

pure virtual

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

Implemented in ALLEGRO::ARC, ALLEGRO::COMPONENT, ALLEGRO::COMPONENT_INST, ALLEGRO::CONNECTION_OBJ, ALLEGRO::FIELD, ALLEGRO::FOOTPRINT_DEF, ALLEGRO::FOOTPRINT_INSTANCE, ALLEGRO::FUNCTION_INSTANCE, ALLEGRO::FUNCTION_SLOT, ALLEGRO::GRAPHIC_SEG, ALLEGRO::LINE, ALLEGRO::NET, ALLEGRO::NET_ASSIGN, ALLEGRO::PIN_NAME, ALLEGRO::PIN_NUMBER, ALLEGRO::PLACED_PAD, ALLEGRO::RECT_OBJ, ALLEGRO::SHAPE, ALLEGRO::TRACK, ALLEGRO::UNKNOWN_0x20, ALLEGRO::VIA, and ALLEGRO::XREF_OBJ.

Member Data Documentation

m_Key

uint32_t ALLEGRO::DB_OBJ::m_Key

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

Definition at line 243 of file allegro_db.h.

Referenced by DB_OBJ().

m_Type

TYPE ALLEGRO::DB_OBJ::m_Type

Definition at line 239 of file allegro_db.h.

Referenced by DB_OBJ(), and GetType().

m_Valid

bool ALLEGRO::DB_OBJ::m_Valid

Definition at line 237 of file allegro_db.h.

Referenced by DB_OBJ().

---

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

• allegro_db.h