KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Private Attributes | List of all members
ALLEGRO::NET Struct Reference

0x1B NET objects More...

#include <allegro_db.h>

Inheritance diagram for ALLEGRO::NET:
ALLEGRO::BRD_DB_OBJ ALLEGRO::DB_OBJ

Public Types

enum class  STATUS { REGULAR , SCHEDULED , NO_RAT }
 
using TYPE_ID = uint8_t
 

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 char * TypeName () const override
 
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_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
 
virtual const DB_REF & GetNext () const
 Return the reference to the next object in the default chain for this object.
 

Public Attributes

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
 
uint32_t m_Key
 
FILE_LOC m_Loc
 
DB_REF m_Next
 

Private Attributes

BRD_TYPE m_Type
 

Detailed Description

0x1B NET objects

Definition at line 704 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.

Member Enumeration Documentation

◆ STATUS

enum class ALLEGRO::NET::STATUS
strong
Enumerator
REGULAR 
SCHEDULED 
NO_RAT 

Definition at line 706 of file allegro_db.h.

Constructor & Destructor Documentation

◆ NET()

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

Definition at line 1211 of file allegro_db.cpp.

References ALLEGRO::BRD_DB_OBJ::BRD_DB_OBJ(), ALLEGRO::BRD_NET, GetPrimaryNext(), m_Fields, m_FieldsChain, ALLEGRO::DB_OBJ::m_Key, m_NetAssignments, m_NetNameStr, ALLEGRO::DB_OBJ::m_Next, m_Status, and REGULAR.

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

◆ GetLogicalPath()

const wxString * NET::GetLogicalPath ( ) const

Definition at line 1250 of file allegro_db.cpp.

References ALLEGRO::LOGICAL_PATH, and m_Fields.

◆ GetName()

const wxString * NET::GetName ( ) const

Definition at line 1238 of file allegro_db.cpp.

References m_NetNameStr.

◆ GetNetMaxLineWidth()

std::optional< int > NET::GetNetMaxLineWidth ( ) const

Definition at line 1262 of file allegro_db.cpp.

References m_Fields, and ALLEGRO::MAX_LINE_WIDTH.

◆ GetNetMaxNeckLength()

std::optional< int > NET::GetNetMaxNeckLength ( ) const

Definition at line 1274 of file allegro_db.cpp.

References m_Fields, and ALLEGRO::MAX_NECK_LENGTH.

◆ GetNetMinLineWidth()

std::optional< int > NET::GetNetMinLineWidth ( ) const

Definition at line 1256 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 1268 of file allegro_db.cpp.

References m_Fields, and ALLEGRO::MIN_NECK_WIDTH.

◆ GetNext()

virtual const DB_REF & ALLEGRO::DB_OBJ::GetNext ( ) const
inlinevirtualinherited

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 in ALLEGRO::PTR_ARRAY.

Definition at line 227 of file allegro_db.h.

References m_Next.

Referenced by GetPrimaryNext().

◆ GetStatus()

NET::STATUS NET::GetStatus ( ) const

Definition at line 1244 of file allegro_db.cpp.

References m_Status.

◆ 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 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 1226 of file allegro_db.cpp.

References m_FieldsChain, m_NetAssignments, m_NetNameStr, and ALLEGRO::DB_OBJ::m_Next.

◆ TypeName()

const char * ALLEGRO::NET::TypeName ( ) const
inlineoverridevirtual

Reimplemented from ALLEGRO::DB_OBJ.

Definition at line 717 of file allegro_db.h.

Member Data Documentation

◆ m_Fields

FIELD_LIST ALLEGRO::NET::m_Fields

Definition at line 724 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 723 of file allegro_db.h.

Referenced by NET(), and ResolveRefs().

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

DB_REF_CHAIN ALLEGRO::NET::m_NetAssignments

Definition at line 721 of file allegro_db.h.

Referenced by NET(), and ResolveRefs().

◆ m_NetNameStr

DB_STR_REF ALLEGRO::NET::m_NetNameStr

Definition at line 719 of file allegro_db.h.

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

◆ m_Next

DB_REF ALLEGRO::DB_OBJ::m_Next
inherited

Definition at line 239 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(), GetNext(), ALLEGRO::PTR_ARRAY::GetNext(), 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::ARC::ResolveRefs(), ALLEGRO::COMPONENT::ResolveRefs(), ALLEGRO::COMPONENT_INST::ResolveRefs(), ALLEGRO::CONNECTION_OBJ::ResolveRefs(), ALLEGRO::FOOTPRINT_DEF::ResolveRefs(), ALLEGRO::FOOTPRINT_INSTANCE::ResolveRefs(), ALLEGRO::GRAPHIC_SEG::ResolveRefs(), ALLEGRO::LINE::ResolveRefs(), ALLEGRO::NET::ResolveRefs(), ALLEGRO::NET_ASSIGN::ResolveRefs(), ALLEGRO::PIN_NAME::ResolveRefs(), ALLEGRO::PIN_NUMBER::ResolveRefs(), ALLEGRO::PLACED_PAD::ResolveRefs(), ALLEGRO::PTR_ARRAY::ResolveRefs(), ALLEGRO::RECT_OBJ::ResolveRefs(), ALLEGRO::SHAPE::ResolveRefs(), ALLEGRO::TRACK::ResolveRefs(), ALLEGRO::UNKNOWN_0x20::ResolveRefs(), ALLEGRO::VIA::ResolveRefs(), ALLEGRO::SHAPE::SHAPE(), ALLEGRO::TRACK::TRACK(), ALLEGRO::UNKNOWN_0x20::UNKNOWN_0x20(), ALLEGRO::VIA::VIA(), ALLEGRO::BRD_DB::VisitComponents(), ALLEGRO::BRD_DB::VisitFootprintDefs(), and ALLEGRO::BRD_DB::VisitNets().

◆ m_Status

STATUS ALLEGRO::NET::m_Status

Definition at line 726 of file allegro_db.h.

Referenced by GetStatus(), and NET().

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