ALLEGRO::NET Struct Reference

0x1B NET objects More...

#include <allegro_db.h>

Inheritance diagram for ALLEGRO::NET:

Public Types
enum class	STATUS { REGULAR , SCHEDULED , NO_RAT }
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
	NET (const BRD_DB &aBrd, const BLK_0x1B_NET &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
STATUS	GetStatus () const
const wxString *	GetLogicalPath () const
std::optional< int >	GetNetMinLineWidth () const
std::optional< int >	GetNetMaxLineWidth () const
std::optional< int >	GetNetMinNeckWidth () const
std::optional< int >	GetNetMaxNeckLength () const
TYPE	GetType () const
uint32_t	GetKey () const

Public Attributes
DB_REF	m_Next
DB_STR_REF	m_NetNameStr
DB_REF_CHAIN	m_NetAssignments
DB_REF_CHAIN	m_FieldsChain
FIELD_LIST	m_Fields
STATUS	m_Status
bool	m_Valid
TYPE	m_Type
uint32_t	m_Key
FILE_LOC	m_Loc

Detailed Description

0x1B NET objects

Definition at line 633 of file allegro_db.h.

Member Enumeration Documentation

STATUS

enum class ALLEGRO::NET::STATUS

strong

Enumerator
REGULAR
SCHEDULED
NO_RAT

Definition at line 635 of file allegro_db.h.

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

NET()

NET::NET	(	const BRD_DB &	aBrd,
		const BLK_0x1B_NET &	aBlk )

Definition at line 1263 of file allegro_db.cpp.

References ALLEGRO::DB_OBJ::DB_OBJ(), ALLEGRO::DB_OBJ::FIELD, ALLEGRO::BLK_0x1B_NET::m_Assignment, m_Fields, m_FieldsChain, ALLEGRO::BLK_0x1B_NET::m_FieldsPtr, ALLEGRO::BRD_DB::m_Header, ALLEGRO::BLK_0x1B_NET::m_Key, ALLEGRO::DB_OBJ::m_Key, m_NetAssignments, ALLEGRO::BLK_0x1B_NET::m_NetName, m_NetNameStr, ALLEGRO::BLK_0x1B_NET::m_Next, ALLEGRO::FIELD::m_Next, m_Next, ALLEGRO::NET_ASSIGN::m_Next, m_Status, ALLEGRO::DB_REF::m_TargetKey, NET(), ALLEGRO::DB_OBJ::NET_ASSIGN, and REGULAR.

Referenced by NET().

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

GetLogicalPath()

const wxString * NET::GetLogicalPath

(

)

const

Definition at line 1324 of file allegro_db.cpp.

References ALLEGRO::LOGICAL_PATH, and m_Fields.

GetName()

const wxString * NET::GetName

(

)

const

Definition at line 1312 of file allegro_db.cpp.

References m_NetNameStr.

GetNetMaxLineWidth()

std::optional< int > NET::GetNetMaxLineWidth

(

)

const

Definition at line 1336 of file allegro_db.cpp.

References m_Fields, and ALLEGRO::MAX_LINE_WIDTH.

GetNetMaxNeckLength()

std::optional< int > NET::GetNetMaxNeckLength

(

)

const

Definition at line 1348 of file allegro_db.cpp.

References m_Fields, and ALLEGRO::MAX_NECK_LENGTH.

GetNetMinLineWidth()

std::optional< int > NET::GetNetMinLineWidth

(

)

const

Definition at line 1330 of file allegro_db.cpp.

References m_Fields, and ALLEGRO::MIN_LINE_WIDTH.

Referenced by ALLEGRO::BOARD_BUILDER::applyNetConstraints().

GetNetMinNeckWidth()

std::optional< int > NET::GetNetMinNeckWidth

(

)

const

Definition at line 1342 of file allegro_db.cpp.

References m_Fields, and ALLEGRO::MIN_NECK_WIDTH.

GetStatus()

NET::STATUS NET::GetStatus

(

)

const

Definition at line 1318 of file allegro_db.cpp.

References m_Status.

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 NET::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 1300 of file allegro_db.cpp.

References m_FieldsChain, m_NetAssignments, m_NetNameStr, and m_Next.

Member Data Documentation

m_Fields

FIELD_LIST ALLEGRO::NET::m_Fields

Definition at line 652 of file allegro_db.h.

Referenced by ALLEGRO::BOARD_BUILDER::applyConstraintSets(), GetLogicalPath(), GetNetMaxLineWidth(), GetNetMaxNeckLength(), GetNetMinLineWidth(), GetNetMinNeckWidth(), and NET().

m_FieldsChain

DB_REF_CHAIN ALLEGRO::NET::m_FieldsChain

Definition at line 651 of file allegro_db.h.

Referenced by NET(), 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_NetAssignments

DB_REF_CHAIN ALLEGRO::NET::m_NetAssignments

Definition at line 649 of file allegro_db.h.

Referenced by NET(), and ResolveRefs().

m_NetNameStr

DB_STR_REF ALLEGRO::NET::m_NetNameStr

Definition at line 647 of file allegro_db.h.

Referenced by GetName(), NET(), and ResolveRefs().

m_Next

DB_REF ALLEGRO::NET::m_Next

Definition at line 646 of file allegro_db.h.

Referenced by NET(), ResolveRefs(), and ALLEGRO::BRD_DB::VisitNets().

m_Status

STATUS ALLEGRO::NET::m_Status

Definition at line 654 of file allegro_db.h.

Referenced by GetStatus(), and NET().

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