DRC_EXCLUSION Class Reference

Container for an DRC exclusion, which is a PCB_MARKER plus an optional comment. More...

#include <drc_exclusion.h>

Classes
struct	IMPL

Public Member Functions
	DRC_EXCLUSION ()
	DRC_EXCLUSION (const DRC_EXCLUSION &aOther)
DRC_EXCLUSION &	operator= (const DRC_EXCLUSION &aOther)
	~DRC_EXCLUSION ()
const kiapi::board::DrcExclusion &	ToProto () const
std::string	GetSortKey () const
wxString	GetComment () const
void	SetComment (const wxString &aComment)

Static Public Member Functions
static DRC_EXCLUSION	FromMarker (const PCB_MARKER &aMarker)
static DRC_EXCLUSION	FromProto (const kiapi::board::DrcExclusion &aMessage)
static DRC_EXCLUSION	FromLegacyStrings (const wxString &aMarkerData, const wxString &aComment)

Private Attributes
std::unique_ptr< IMPL >	m_impl

Friends
bool	operator== (const DRC_EXCLUSION &a, const DRC_EXCLUSION &b)
bool	operator!= (const DRC_EXCLUSION &a, const DRC_EXCLUSION &b)
void	to_json (nlohmann::json &aJson, const DRC_EXCLUSION &aEx)
void	from_json (const nlohmann::json &aJson, DRC_EXCLUSION &aEx)

Detailed Description

Container for an DRC exclusion, which is a PCB_MARKER plus an optional comment.

This handles serialization to protobuf for the API and to JSON (via that protobuf) for storage in settings.

Definition at line 40 of file drc_exclusion.h.

Constructor & Destructor Documentation

DRC_EXCLUSION() [1/2]

DRC_EXCLUSION::DRC_EXCLUSION

(

)

Definition at line 37 of file drc_exclusion.cpp.

References m_impl.

Referenced by DRC_EXCLUSION(), from_json, FromLegacyStrings(), FromMarker(), FromProto(), operator!=, operator=(), operator==, to_json, and ~DRC_EXCLUSION().

DRC_EXCLUSION() [2/2]

DRC_EXCLUSION::DRC_EXCLUSION

(

const DRC_EXCLUSION &

aOther

)

Definition at line 43 of file drc_exclusion.cpp.

References DRC_EXCLUSION(), and m_impl.

~DRC_EXCLUSION()

DRC_EXCLUSION::~DRC_EXCLUSION ( )

default

References DRC_EXCLUSION().

Member Function Documentation

FromLegacyStrings()

DRC_EXCLUSION DRC_EXCLUSION::FromLegacyStrings ( const wxString & aMarkerData, const wxString & aComment )

static

Definition at line 80 of file drc_exclusion.cpp.

References DRC_EXCLUSION(), PCB_MARKER::FromLegacyString(), m_impl, and SetComment().

Referenced by BOARD_DESIGN_SETTINGS::migrateSchema2to3().

FromMarker()

DRC_EXCLUSION DRC_EXCLUSION::FromMarker ( const PCB_MARKER & aMarker )

static

Definition at line 59 of file drc_exclusion.cpp.

References DRC_EXCLUSION(), MARKER_BASE::GetComment(), m_impl, PCB_MARKER::Serialize(), and SetComment().

Referenced by BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), DIALOG_DRC::ExcludeMarker(), DIALOG_DRC::OnDRCItemRClick(), BOARD::RecordDRCExclusions(), and BOARD::ResolveDRCExclusions().

FromProto()

DRC_EXCLUSION DRC_EXCLUSION::FromProto ( const kiapi::board::DrcExclusion & aMessage )

static

Definition at line 72 of file drc_exclusion.cpp.

References DRC_EXCLUSION().

Referenced by API_HANDLER_PCB::handleSetBoardDesignRules().

GetComment()

wxString DRC_EXCLUSION::GetComment

(

)

const

Definition at line 145 of file drc_exclusion.cpp.

References m_impl.

Referenced by BOOST_FIXTURE_TEST_CASE(), and DRC_BASE_FIXTURE::createAndVerifyInitialExclusionMarkers().

GetSortKey()

std::string DRC_EXCLUSION::GetSortKey

(

)

const

Definition at line 128 of file drc_exclusion.cpp.

References m_impl.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), BOARD_DESIGN_SETTINGS::migrateSchema2to3(), DRC_EXCLUSION_COMPARE::operator()(), and operator==.

operator=()

DRC_EXCLUSION & DRC_EXCLUSION::operator=

(

const DRC_EXCLUSION &

aOther

)

Definition at line 49 of file drc_exclusion.cpp.

References DRC_EXCLUSION(), and m_impl.

SetComment()

void DRC_EXCLUSION::SetComment

(

const wxString &

aComment

)

Definition at line 151 of file drc_exclusion.cpp.

References m_impl.

Referenced by FromLegacyStrings(), FromMarker(), and DIALOG_DRC::OnDRCItemRClick().

ToProto()

const kiapi::board::DrcExclusion & DRC_EXCLUSION::ToProto

(

)

const

Definition at line 97 of file drc_exclusion.cpp.

References m_impl.

Referenced by DRC_BASE_FIXTURE::createAndVerifyInitialExclusionMarkers(), and API_HANDLER_PCB::handleGetBoardDesignRules().

Friends And Related Symbol Documentation

from_json

void from_json ( const nlohmann::json & aJson, DRC_EXCLUSION & aEx )

friend

Definition at line 122 of file drc_exclusion.cpp.

References DRC_EXCLUSION(), and m_impl.

operator!=

bool operator!= ( const DRC_EXCLUSION & a, const DRC_EXCLUSION & b )

friend

Definition at line 63 of file drc_exclusion.h.

References DRC_EXCLUSION().

operator==

bool operator== ( const DRC_EXCLUSION & a, const DRC_EXCLUSION & b )

friend

Definition at line 58 of file drc_exclusion.h.

References DRC_EXCLUSION(), and GetSortKey().

to_json

void to_json ( nlohmann::json & aJson, const DRC_EXCLUSION & aEx )

friend

Definition at line 103 of file drc_exclusion.cpp.

References DRC_EXCLUSION(), and m_impl.

Member Data Documentation

m_impl

std::unique_ptr<IMPL> DRC_EXCLUSION::m_impl

private

Definition at line 70 of file drc_exclusion.h.

Referenced by DRC_EXCLUSION(), DRC_EXCLUSION(), from_json, from_json(), FromLegacyStrings(), FromMarker(), GetComment(), GetSortKey(), operator=(), SetComment(), to_json, and ToProto().

---

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

• drc_exclusion.h
• drc_exclusion.cpp