KiCad PCB EDA Suite
PNS::ALGO_BASE Class Reference

Base class for all P&S algorithms (shoving, walkaround, line placement, dragging, etc.). More...

#include <pns_algo_base.h>

Inheritance diagram for PNS::ALGO_BASE:
PNS::DRAG_ALGO PNS::PLACEMENT_ALGO PNS::SHOVE PNS::WALKAROUND PNS::COMPONENT_DRAGGER PNS::DRAGGER PNS::DIFF_PAIR_PLACER PNS::LINE_PLACER PNS::MEANDER_PLACER_BASE PNS::DP_MEANDER_PLACER PNS::MEANDER_PLACER PNS::MEANDER_SKEW_PLACER

Public Member Functions

 ALGO_BASE (ROUTER *aRouter)
 
virtual ~ALGO_BASE ()
 Return the instance of our router. More...
 
ROUTERRouter () const
 Return current router settings. More...
 
ROUTING_SETTINGSSettings () const
 Return the logger object, allowing to dump geometry to a file. More...
 
virtual LOGGERLogger ()
 
void SetLogger (LOGGER *aLogger)
 
void SetDebugDecorator (DEBUG_DECORATOR *aDecorator)
 Assign a debug decorator allowing this algo to draw extra graphics for visual debugging. More...
 
DEBUG_DECORATORDbg () const
 
const BOX2IVisibleViewArea () const
 

Protected Attributes

DEBUG_DECORATORm_debugDecorator
 
ROUTERm_router
 
LOGGERm_logger
 

Detailed Description

Base class for all P&S algorithms (shoving, walkaround, line placement, dragging, etc.).

Holds a bunch of objects commonly used by all algorithms (P&S settings, parent router instance, logging).

Definition at line 42 of file pns_algo_base.h.

Constructor & Destructor Documentation

◆ ALGO_BASE()

PNS::ALGO_BASE::ALGO_BASE ( ROUTER aRouter)
inline

Definition at line 45 of file pns_algo_base.h.

45  :
46  m_debugDecorator( nullptr ),
47  m_router( aRouter ),
48  m_logger( nullptr )
49  {}
LOGGER * m_logger
Definition: pns_algo_base.h:88
ROUTER * m_router
Definition: pns_algo_base.h:87
DEBUG_DECORATOR * m_debugDecorator
Definition: pns_algo_base.h:86

◆ ~ALGO_BASE()

virtual PNS::ALGO_BASE::~ALGO_BASE ( )
inlinevirtual

Return the instance of our router.

Definition at line 51 of file pns_algo_base.h.

Member Function Documentation

◆ Dbg()

◆ Logger()

LOGGER * PNS::ALGO_BASE::Logger ( )
virtual

Reimplemented in PNS::SHOVE.

Definition at line 34 of file pns_algo_base.cpp.

35 {
36  return NULL;
37 }
#define NULL

References NULL.

Referenced by PNS::LINE_PLACER::rhShoveOnly(), PNS::LINE_PLACER::rhWalkOnly(), PNS::DRAGGER::Start(), and PNS::DRAGGER::tryWalkaround().

◆ Router()

◆ SetDebugDecorator()

void PNS::ALGO_BASE::SetDebugDecorator ( DEBUG_DECORATOR aDecorator)
inline

Assign a debug decorator allowing this algo to draw extra graphics for visual debugging.

Definition at line 73 of file pns_algo_base.h.

74  {
75  m_debugDecorator = aDecorator;
76  }
DEBUG_DECORATOR * m_debugDecorator
Definition: pns_algo_base.h:86

References m_debugDecorator.

Referenced by PNS::LINE_PLACER::rhShoveOnly(), PNS::LINE_PLACER::rhWalkOnly(), PNS::SHOVE::SHOVE(), and PNS::DRAGGER::tryWalkaround().

◆ SetLogger()

void PNS::ALGO_BASE::SetLogger ( LOGGER aLogger)
inline

Definition at line 65 of file pns_algo_base.h.

66  {
67  m_logger = aLogger;
68  }
LOGGER * m_logger
Definition: pns_algo_base.h:88

References m_logger.

Referenced by PNS::LINE_PLACER::rhShoveOnly(), PNS::LINE_PLACER::rhWalkOnly(), and PNS::DRAGGER::tryWalkaround().

◆ Settings()

◆ VisibleViewArea()

const BOX2I & PNS::ALGO_BASE::VisibleViewArea ( ) const

Definition at line 39 of file pns_algo_base.cpp.

40 {
41  auto bb = m_router->VisibleViewArea();
42  return m_router->VisibleViewArea();
43 }
ROUTER * m_router
Definition: pns_algo_base.h:87
const BOX2I & VisibleViewArea() const
Definition: pns_router.h:225

References m_router, and PNS::ROUTER::VisibleViewArea().

Referenced by PNS::SHOVE::runOptimizer().

Member Data Documentation

◆ m_debugDecorator

DEBUG_DECORATOR* PNS::ALGO_BASE::m_debugDecorator
protected

Definition at line 86 of file pns_algo_base.h.

Referenced by Dbg(), and SetDebugDecorator().

◆ m_logger

LOGGER* PNS::ALGO_BASE::m_logger
protected

Definition at line 88 of file pns_algo_base.h.

Referenced by SetLogger(), and PNS::WALKAROUND::singleStep().

◆ m_router

ROUTER* PNS::ALGO_BASE::m_router
protected

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