KiCad PCB EDA Suite
PNS::DEBUG_DECORATOR Class Reference

#include <pns_debug_decorator.h>

Inheritance diagram for PNS::DEBUG_DECORATOR:
PNS_PCBNEW_DEBUG_DECORATOR PNS_TEST_DEBUG_DECORATOR

Classes

struct  SRC_LOCATION_INFO
 

Public Member Functions

 DEBUG_DECORATOR ()
 
virtual ~DEBUG_DECORATOR ()
 
void SetDebugEnabled (bool aEnabled)
 
bool IsDebugEnabled () const
 
virtual void SetIteration (int iter)
 
virtual void Message (const wxString msg, const SRC_LOCATION_INFO &aSrcLoc=SRC_LOCATION_INFO())
 
virtual void NewStage (const std::string &name, int iter, const SRC_LOCATION_INFO &aSrcLoc=SRC_LOCATION_INFO())
 
virtual void BeginGroup (const std::string name, const SRC_LOCATION_INFO &aSrcLoc=SRC_LOCATION_INFO())
 
virtual void EndGroup (const SRC_LOCATION_INFO &aSrcLoc=SRC_LOCATION_INFO())
 
virtual void AddPoint (VECTOR2I aP, const KIGFX::COLOR4D &aColor, int aSize, const std::string aName, const SRC_LOCATION_INFO &aSrcLoc=SRC_LOCATION_INFO())
 
virtual void AddLine (const SHAPE_LINE_CHAIN &aLine, const KIGFX::COLOR4D &aColor, int aWidth, const std::string aName, const SRC_LOCATION_INFO &aSrcLoc=SRC_LOCATION_INFO())
 
virtual void AddSegment (SEG aS, const KIGFX::COLOR4D &aColor, const std::string aName, const SRC_LOCATION_INFO &aSrcLoc=SRC_LOCATION_INFO())
 
virtual void AddBox (BOX2I aB, const KIGFX::COLOR4D &aColor, const std::string aName, const SRC_LOCATION_INFO &aSrcLoc=SRC_LOCATION_INFO())
 
virtual void Clear ()
 

Private Attributes

bool m_debugEnabled
 

Detailed Description

Definition at line 34 of file pns_debug_decorator.h.

Constructor & Destructor Documentation

◆ DEBUG_DECORATOR()

PNS::DEBUG_DECORATOR::DEBUG_DECORATOR ( )
inline

Definition at line 37 of file pns_debug_decorator.h.

37 : m_debugEnabled( false ) {}

◆ ~DEBUG_DECORATOR()

virtual PNS::DEBUG_DECORATOR::~DEBUG_DECORATOR ( )
inlinevirtual

Definition at line 51 of file pns_debug_decorator.h.

51 {}

Member Function Documentation

◆ AddBox()

virtual void PNS::DEBUG_DECORATOR::AddBox ( BOX2I  aB,
const KIGFX::COLOR4D aColor,
const std::string  aName,
const SRC_LOCATION_INFO aSrcLoc = SRC_LOCATION_INFO() 
)
inlinevirtual

Reimplemented in PNS_PCBNEW_DEBUG_DECORATOR, and PNS_TEST_DEBUG_DECORATOR.

Definition at line 73 of file pns_debug_decorator.h.

75  {};

Referenced by PNS::SHOVE::replaceLine(), and PNS::SHOVE::runOptimizer().

◆ AddLine()

virtual void PNS::DEBUG_DECORATOR::AddLine ( const SHAPE_LINE_CHAIN aLine,
const KIGFX::COLOR4D aColor,
int  aWidth,
const std::string  aName,
const SRC_LOCATION_INFO aSrcLoc = SRC_LOCATION_INFO() 
)
inlinevirtual

◆ AddPoint()

virtual void PNS::DEBUG_DECORATOR::AddPoint ( VECTOR2I  aP,
const KIGFX::COLOR4D aColor,
int  aSize,
const std::string  aName,
const SRC_LOCATION_INFO aSrcLoc = SRC_LOCATION_INFO() 
)
inlinevirtual

Reimplemented in PNS_PCBNEW_DEBUG_DECORATOR, and PNS_TEST_DEBUG_DECORATOR.

Definition at line 64 of file pns_debug_decorator.h.

66  {};

◆ AddSegment()

virtual void PNS::DEBUG_DECORATOR::AddSegment ( SEG  aS,
const KIGFX::COLOR4D aColor,
const std::string  aName,
const SRC_LOCATION_INFO aSrcLoc = SRC_LOCATION_INFO() 
)
inlinevirtual

Reimplemented in PNS_PCBNEW_DEBUG_DECORATOR, and PNS_TEST_DEBUG_DECORATOR.

Definition at line 70 of file pns_debug_decorator.h.

72  {};

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

◆ BeginGroup()

virtual void PNS::DEBUG_DECORATOR::BeginGroup ( const std::string  name,
const SRC_LOCATION_INFO aSrcLoc = SRC_LOCATION_INFO() 
)
inlinevirtual

◆ Clear()

virtual void PNS::DEBUG_DECORATOR::Clear ( )
inlinevirtual

Reimplemented in PNS_PCBNEW_DEBUG_DECORATOR, and PNS_TEST_DEBUG_DECORATOR.

Definition at line 76 of file pns_debug_decorator.h.

76 {};

Referenced by PNS_KICAD_IFACE::EraseView().

◆ EndGroup()

virtual void PNS::DEBUG_DECORATOR::EndGroup ( const SRC_LOCATION_INFO aSrcLoc = SRC_LOCATION_INFO())
inlinevirtual

◆ IsDebugEnabled()

bool PNS::DEBUG_DECORATOR::IsDebugEnabled ( ) const
inline

Definition at line 54 of file pns_debug_decorator.h.

References m_debugEnabled.

◆ Message()

virtual void PNS::DEBUG_DECORATOR::Message ( const wxString  msg,
const SRC_LOCATION_INFO aSrcLoc = SRC_LOCATION_INFO() 
)
inlinevirtual

◆ NewStage()

virtual void PNS::DEBUG_DECORATOR::NewStage ( const std::string &  name,
int  iter,
const SRC_LOCATION_INFO aSrcLoc = SRC_LOCATION_INFO() 
)
inlinevirtual

Reimplemented in PNS_TEST_DEBUG_DECORATOR.

Definition at line 59 of file pns_debug_decorator.h.

60  {};

◆ SetDebugEnabled()

void PNS::DEBUG_DECORATOR::SetDebugEnabled ( bool  aEnabled)
inline

◆ SetIteration()

virtual void PNS::DEBUG_DECORATOR::SetIteration ( int  iter)
inlinevirtual

Reimplemented in PNS_TEST_DEBUG_DECORATOR.

Definition at line 56 of file pns_debug_decorator.h.

56 {};

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

Member Data Documentation

◆ m_debugEnabled

bool PNS::DEBUG_DECORATOR::m_debugEnabled
private

Definition at line 76 of file pns_debug_decorator.h.

Referenced by IsDebugEnabled(), and SetDebugEnabled().


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