KiCad PCB EDA Suite
Loading...
Searching...
No Matches
ALLEGRO::XREF_OBJ Struct Reference

0x12 objects. More...

#include <allegro_db.h>

Inheritance diagram for ALLEGRO::XREF_OBJ:
ALLEGRO::DB_OBJ

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

 XREF_OBJ (const BLK_0x12_XREF &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.
 
TYPE GetType () const
 
uint32_t GetKey () const
 

Public Attributes

DB_REF m_Ptr1
 
DB_REF m_Ptr2
 
DB_REF m_Ptr3
 
bool m_Valid
 
TYPE m_Type
 
uint32_t m_Key
 
FILE_LOC m_Loc
 

Detailed Description

0x12 objects.

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

◆ XREF_OBJ()

Member Function Documentation

◆ GetKey()

uint32_t ALLEGRO::DB_OBJ::GetKey ( ) const
inlineinherited

◆ GetType()

TYPE ALLEGRO::DB_OBJ::GetType ( ) const
inlineinherited

◆ ResolveRefs()

bool XREF_OBJ::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 964 of file allegro_db.cpp.

References m_Ptr1, m_Ptr2, and m_Ptr3.

Member Data Documentation

◆ m_Key

◆ m_Loc

FILE_LOC ALLEGRO::DB_OBJ::m_Loc
inherited

Definition at line 243 of file allegro_db.h.

Referenced by DB_OBJ().

◆ m_Ptr1

DB_REF ALLEGRO::XREF_OBJ::m_Ptr1

Definition at line 587 of file allegro_db.h.

Referenced by ResolveRefs(), and XREF_OBJ().

◆ m_Ptr2

DB_REF ALLEGRO::XREF_OBJ::m_Ptr2

Definition at line 588 of file allegro_db.h.

Referenced by ResolveRefs(), and XREF_OBJ().

◆ m_Ptr3

DB_REF ALLEGRO::XREF_OBJ::m_Ptr3

Definition at line 589 of file allegro_db.h.

Referenced by ResolveRefs(), and XREF_OBJ().

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