KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
NETCLASS_EXPECTATION Class Reference
Inheritance diagram for NETCLASS_EXPECTATION:
KI_TEST::BOARD_EXPECTATION

Public Member Functions

void SetComment (std::string aComment)
 Set a comment to be included in the test output for this expectation, which can be used to provide more details about the expectation.
 
const std::string & GetComment () const
 

Public Attributes

std::vector< std::string > m_NetClassNames
 
std::optional< SCALAR_CONSTRAINT > m_Count
 
std::optional< SCALAR_CONSTRAINT > m_TrackWidth
 Expectation for track width constraint for all matching netclasses.
 
std::optional< SCALAR_CONSTRAINT > m_Clearance
 
std::optional< SCALAR_CONSTRAINT > m_DpGap
 
std::optional< SCALAR_CONSTRAINT > m_DpWidth
 
std::optional< SCALAR_CONSTRAINT > m_MatchingNetCount
 Expectation for number of nets matching the netclass patterns in aggregate.
 

Private Member Functions

void doSimpleCountTest (const BOARD &aBrd) const
 
std::vector< const NETCLASS * > findMatchingNetclasses (const BOARD &aBrd) const
 
void RunTest (const BOARD &aBrd) const override
 
std::string GetName () const override
 

Static Private Member Functions

static bool nameMatches (const wxString &aName, const std::string &aPattern)
 
static int CountMatchingNets (const BOARD &aBrd, const wxString &aNetClassName)
 

Private Attributes

std::string m_Comment
 

Detailed Description

Definition at line 450 of file board_expectations.cpp.

Member Function Documentation

◆ CountMatchingNets()

static int NETCLASS_EXPECTATION::CountMatchingNets ( const BOARD & aBrd,
const wxString & aNetClassName )
inlinestaticprivate

Definition at line 605 of file board_expectations.cpp.

References NETCLASS::GetName(), and BOARD::GetNetInfo().

Referenced by RunTest().

◆ doSimpleCountTest()

void NETCLASS_EXPECTATION::doSimpleCountTest ( const BOARD & aBrd) const
inlineprivate

Definition at line 465 of file board_expectations.cpp.

References BOOST_TEST_CONTEXT(), CheckConstraint(), BOARD::GetDesignSettings(), m_Count, and BOARD_DESIGN_SETTINGS::m_NetSettings.

Referenced by RunTest().

◆ findMatchingNetclasses()

std::vector< const NETCLASS * > NETCLASS_EXPECTATION::findMatchingNetclasses ( const BOARD & aBrd) const
inlineprivate

Definition at line 482 of file board_expectations.cpp.

References BOARD::GetDesignSettings(), NET_SETTINGS::GetNetclasses(), m_NetClassNames, BOARD_DESIGN_SETTINGS::m_NetSettings, name, and nameMatches().

Referenced by RunTest().

◆ GetComment()

const std::string & KI_TEST::BOARD_EXPECTATION::GetComment ( ) const
inlineinherited

Definition at line 53 of file board_expectations.h.

References m_Comment.

◆ GetName()

std::string NETCLASS_EXPECTATION::GetName ( ) const
inlineoverrideprivatevirtual

Implements KI_TEST::BOARD_EXPECTATION.

Definition at line 626 of file board_expectations.cpp.

References m_Count, m_NetClassNames, and vecToString().

◆ nameMatches()

static bool NETCLASS_EXPECTATION::nameMatches ( const wxString & aName,
const std::string & aPattern )
inlinestaticprivate

Definition at line 477 of file board_expectations.cpp.

Referenced by findMatchingNetclasses(), and RunTest().

◆ RunTest()

void NETCLASS_EXPECTATION::RunTest ( const BOARD & aBrd) const
inlineoverrideprivatevirtual

Implements KI_TEST::BOARD_EXPECTATION.

Definition at line 512 of file board_expectations.cpp.

References BOOST_TEST(), BOOST_TEST_CONTEXT(), CheckConstraint(), CountMatchingNets(), doSimpleCountTest(), findMatchingNetclasses(), m_Clearance, m_Count, m_DpGap, m_DpWidth, m_MatchingNetCount, m_NetClassNames, m_TrackWidth, and nameMatches().

◆ SetComment()

void KI_TEST::BOARD_EXPECTATION::SetComment ( std::string aComment)
inlineinherited

Set a comment to be included in the test output for this expectation, which can be used to provide more details about the expectation.

Definition at line 52 of file board_expectations.h.

References m_Comment.

Member Data Documentation

◆ m_Clearance

std::optional<SCALAR_CONSTRAINT> NETCLASS_EXPECTATION::m_Clearance

Definition at line 457 of file board_expectations.cpp.

Referenced by RunTest().

◆ m_Comment

std::string KI_TEST::BOARD_EXPECTATION::m_Comment
privateinherited

Definition at line 56 of file board_expectations.h.

Referenced by GetComment(), and SetComment().

◆ m_Count

std::optional<SCALAR_CONSTRAINT> NETCLASS_EXPECTATION::m_Count

Definition at line 454 of file board_expectations.cpp.

Referenced by doSimpleCountTest(), GetName(), and RunTest().

◆ m_DpGap

std::optional<SCALAR_CONSTRAINT> NETCLASS_EXPECTATION::m_DpGap

Definition at line 458 of file board_expectations.cpp.

Referenced by RunTest().

◆ m_DpWidth

std::optional<SCALAR_CONSTRAINT> NETCLASS_EXPECTATION::m_DpWidth

Definition at line 459 of file board_expectations.cpp.

Referenced by RunTest().

◆ m_MatchingNetCount

std::optional<SCALAR_CONSTRAINT> NETCLASS_EXPECTATION::m_MatchingNetCount

Expectation for number of nets matching the netclass patterns in aggregate.

Definition at line 462 of file board_expectations.cpp.

Referenced by RunTest().

◆ m_NetClassNames

std::vector<std::string> NETCLASS_EXPECTATION::m_NetClassNames

Definition at line 453 of file board_expectations.cpp.

Referenced by findMatchingNetclasses(), GetName(), and RunTest().

◆ m_TrackWidth

std::optional<SCALAR_CONSTRAINT> NETCLASS_EXPECTATION::m_TrackWidth

Expectation for track width constraint for all matching netclasses.

Definition at line 456 of file board_expectations.cpp.

Referenced by RunTest().

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