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

Chain of DB references that lead from the head to the tail. More...

#include <allegro_db.h>

Inheritance diagram for ALLEGRO::DB_REF_CHAIN:
ALLEGRO::RESOLVABLE

Public Member Functions

 DB_REF_CHAIN (const DB_OBJ *aParent, uint32_t aHead, uint32_t aTail, const char *aDebugName)
 
 DB_REF_CHAIN (const DB_OBJ *aParent)
 
bool Resolve (const DB_OBJ_RESOLVER &aResolver) override
 
void Visit (std::function< void(const DB_OBJ &aObj)> aVisitor) const
 Visit all objects in the chain.
 
void Visit (std::function< void(DB_OBJ &aObj)> aVisitor)
 
virtual std::string DebugString () const
 

Public Attributes

std::function< const DB_REF &(const DB_OBJ &)> m_NextRefGetter
 
uint32_t m_Head
 
uint32_t m_Tail
 
std::vector< DB_OBJ * > m_Chain
 
const DB_OBJm_Parent
 
const char * m_DebugName
 

Detailed Description

Chain of DB references that lead from the head to the tail.

Definition at line 90 of file allegro_db.h.

Constructor & Destructor Documentation

◆ DB_REF_CHAIN() [1/2]

ALLEGRO::DB_REF_CHAIN::DB_REF_CHAIN ( const DB_OBJ * aParent,
uint32_t aHead,
uint32_t aTail,
const char * aDebugName )
inline

Definition at line 92 of file allegro_db.h.

References ALLEGRO::RESOLVABLE::m_DebugName, m_Head, m_Tail, and ALLEGRO::RESOLVABLE::RESOLVABLE().

Referenced by DB_REF_CHAIN().

◆ DB_REF_CHAIN() [2/2]

ALLEGRO::DB_REF_CHAIN::DB_REF_CHAIN ( const DB_OBJ * aParent)
inline

Definition at line 100 of file allegro_db.h.

References DB_REF_CHAIN().

Member Function Documentation

◆ DebugString()

std::string RESOLVABLE::DebugString ( ) const
virtualinherited

Definition at line 122 of file allegro_db.cpp.

References m_DebugName, and m_Parent.

Referenced by ALLEGRO::DB_REF_CHAIN::Resolve().

◆ Resolve()

◆ Visit() [1/2]

void DB_REF_CHAIN::Visit ( std::function< void(const DB_OBJ &aObj)> aVisitor) const

Visit all objects in the chain.

Definition at line 230 of file allegro_db.cpp.

References m_Chain.

Referenced by ALLEGRO::BRD_DB::VisitComponentPins(), ALLEGRO::BRD_DB::VisitComponents(), and ALLEGRO::BRD_DB::visitFootprintInstances().

◆ Visit() [2/2]

void DB_REF_CHAIN::Visit ( std::function< void(DB_OBJ &aObj)> aVisitor)

Definition at line 239 of file allegro_db.cpp.

References m_Chain.

Member Data Documentation

◆ m_Chain

std::vector<DB_OBJ*> ALLEGRO::DB_REF_CHAIN::m_Chain

Definition at line 120 of file allegro_db.h.

Referenced by Resolve(), Visit(), and Visit().

◆ m_DebugName

const char* ALLEGRO::RESOLVABLE::m_DebugName
inherited

◆ m_Head

uint32_t ALLEGRO::DB_REF_CHAIN::m_Head

Definition at line 116 of file allegro_db.h.

Referenced by DB_REF_CHAIN(), and Resolve().

◆ m_NextRefGetter

std::function<const DB_REF&( const DB_OBJ& )> ALLEGRO::DB_REF_CHAIN::m_NextRefGetter

Definition at line 113 of file allegro_db.h.

Referenced by Resolve().

◆ m_Parent

const DB_OBJ* ALLEGRO::RESOLVABLE::m_Parent
inherited

Definition at line 60 of file allegro_db.h.

Referenced by DebugString(), and RESOLVABLE().

◆ m_Tail

uint32_t ALLEGRO::DB_REF_CHAIN::m_Tail

Definition at line 117 of file allegro_db.h.

Referenced by DB_REF_CHAIN(), and Resolve().


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