ALLEGRO::FIELD Struct Reference

0x03 FIELD objects More...

#include <allegro_db.h>

Inheritance diagram for ALLEGRO::FIELD:

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
	FIELD (const BLK_0x03_FIELD &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 &	ExpectString () const
TYPE	GetType () const
uint32_t	GetKey () const

Public Attributes
uint8_t	m_SubType
DB_REF	m_Next
uint32_t	m_Hdr1
uint32_t	m_Hdr2
std::variant< wxString, uint32_t >	m_FieldValue
bool	m_Valid
TYPE	m_Type
uint32_t	m_Key
FILE_LOC	m_Loc

Detailed Description

0x03 FIELD objects

These can be of several subtypes

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

FIELD()

FIELD::FIELD

(

const BLK_0x03_FIELD &

aBlk

)

Definition at line 593 of file allegro_db.cpp.

References ALLEGRO::DB_OBJ::DB_OBJ(), FIELD(), ALLEGRO::BLK_0x03_FIELD::m_Hdr1, m_Hdr1, ALLEGRO::BLK_0x03_FIELD::m_Hdr2, m_Hdr2, ALLEGRO::DB_OBJ::m_Key, ALLEGRO::BLK_0x03_FIELD::m_Next, m_Next, ALLEGRO::BLK_0x03_FIELD::m_SubType, and m_SubType.

Referenced by FIELD().

Member Function Documentation

ExpectString()

const wxString & FIELD::ExpectString

(

)

const

Definition at line 619 of file allegro_db.cpp.

References m_FieldValue, and THROW_IO_ERROR.

Referenced by ALLEGRO::FOOTPRINT_DEF::GetLibPath().

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

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 ALLEGRO::FIELD::ResolveRefs ( const DB_OBJ_RESOLVER & aResolver )

inlineoverridevirtual

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 355 of file allegro_db.h.

Member Data Documentation

m_FieldValue

std::variant<wxString, uint32_t> ALLEGRO::FIELD::m_FieldValue

Definition at line 364 of file allegro_db.h.

Referenced by ExpectString(), ALLEGRO::FIELD_LIST::GetOptField(), ALLEGRO::FIELD_LIST::GetOptFieldExpectInt(), and ALLEGRO::FIELD_LIST::GetOptFieldExpectString().

m_Hdr1

uint32_t ALLEGRO::FIELD::m_Hdr1

Definition at line 361 of file allegro_db.h.

Referenced by FIELD(), ALLEGRO::FIELD_LIST::GetOptField(), ALLEGRO::FIELD_LIST::GetOptFieldExpectInt(), and ALLEGRO::FIELD_LIST::GetOptFieldExpectString().

m_Hdr2

uint32_t ALLEGRO::FIELD::m_Hdr2

Definition at line 362 of file allegro_db.h.

Referenced by FIELD().

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::FIELD::m_Next

Definition at line 358 of file allegro_db.h.

Referenced by FIELD(), and ALLEGRO::NET::NET().

m_SubType

uint8_t ALLEGRO::FIELD::m_SubType

Definition at line 357 of file allegro_db.h.

Referenced by FIELD(), ALLEGRO::FIELD_LIST::GetOptFieldExpectInt(), and ALLEGRO::FIELD_LIST::GetOptFieldExpectString().

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