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

Public Types

enum class  ITEM_TYPE {
  ANY , BOARD_TRACK , BOARD_VIA , BOARD_FOOTPRINT ,
  FP_PAD , FP_GRAPHIC , FP_FIELD , FP_ZONE ,
  BOARD_GRAPHIC , BOARD_ZONE , BOARD_GROUP
}
 

Public Member Functions

void RunTest (const BOARD &aBrd) const override
 
std::string GetName () const override
 
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
 

Static Public Member Functions

static void reportError (const wxString &aMessage, int aOffset)
 

Public Attributes

std::optional< wxString > m_Expression
 
std::optional< ITEM_TYPE > m_ItemType
 
std::optional< SCALAR_CONSTRAINT > m_ExpectedMatches
 
std::optional< wxString > m_ParentExpr
 

Private Member Functions

std::vector< const BOARD_ITEM * > collectAllBoardItems (const BOARD &aBrd) const
 
std::vector< const BOARD_ITEM * > collectItemsOfType (const BOARD &aBrd, ITEM_TYPE aType) const
 

Private Attributes

std::string m_Comment
 

Detailed Description

Definition at line 695 of file board_expectations.cpp.

Member Enumeration Documentation

◆ ITEM_TYPE

enum class ITEM_EVAL_EXPECTATION::ITEM_TYPE
strong
Enumerator
ANY 
BOARD_TRACK 
BOARD_VIA 
BOARD_FOOTPRINT 
FP_PAD 
FP_GRAPHIC 
FP_FIELD 
FP_ZONE 
BOARD_GRAPHIC 
BOARD_ZONE 
BOARD_GROUP 

Definition at line 698 of file board_expectations.cpp.

Member Function Documentation

◆ collectAllBoardItems()

std::vector< const BOARD_ITEM * > ITEM_EVAL_EXPECTATION::collectAllBoardItems ( const BOARD & aBrd) const
inlineprivate

Definition at line 832 of file board_expectations.cpp.

References BOARD::Drawings(), BOARD::Footprints(), pad, BOARD::Tracks(), and BOARD::Zones().

Referenced by collectItemsOfType().

◆ collectItemsOfType()

std::vector< const BOARD_ITEM * > ITEM_EVAL_EXPECTATION::collectItemsOfType ( const BOARD & aBrd,
ITEM_TYPE aType ) const
inlineprivate

Definition at line 865 of file board_expectations.cpp.

References ANY, BOARD_FOOTPRINT, BOARD_GRAPHIC, BOARD_GROUP, BOARD_TRACK, BOARD_VIA, BOARD_ZONE, collectAllBoardItems(), BOARD::Drawings(), BOARD::Footprints(), FP_FIELD, FP_GRAPHIC, FP_PAD, FP_ZONE, BOARD::Groups(), pad, PCB_SHAPE_T, PCB_VIA_T, BOARD::Tracks(), and BOARD::Zones().

Referenced by RunTest().

◆ GetComment()

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

Definition at line 57 of file board_expectations.h.

References m_Comment.

◆ GetName()

std::string ITEM_EVAL_EXPECTATION::GetName ( ) const
inlineoverridevirtual

Implements KI_TEST::BOARD_EXPECTATION.

Definition at line 822 of file board_expectations.cpp.

References m_ExpectedMatches, and m_Expression.

◆ reportError()

static void ITEM_EVAL_EXPECTATION::reportError ( const wxString & aMessage,
int aOffset )
inlinestatic

Definition at line 718 of file board_expectations.cpp.

Referenced by RunTest().

◆ RunTest()

void ITEM_EVAL_EXPECTATION::RunTest ( const BOARD & aBrd) const
inlineoverridevirtual

Implements KI_TEST::BOARD_EXPECTATION.

Definition at line 723 of file board_expectations.cpp.

References ANY, BOOST_REQUIRE(), BOOST_TEST(), BOOST_TEST_CONTEXT(), BOOST_TEST_MESSAGE(), CheckConstraint(), collectItemsOfType(), LIBEVAL::COMPILER::Compile(), BOARD_ITEM::GetLayerSet(), BOARD_ITEM::GetParent(), m_ExpectedMatches, m_Expression, m_ItemType, m_ParentExpr, PROF_TIMER::msecs(), reportError(), result, LSET::Seq(), LIBEVAL::CONTEXT::SetErrorCallback(), and PCBEXPR_CONTEXT::SetItems().

◆ 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 56 of file board_expectations.h.

References m_Comment.

Member Data Documentation

◆ m_Comment

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

Definition at line 60 of file board_expectations.h.

Referenced by GetComment(), and SetComment().

◆ m_ExpectedMatches

std::optional<SCALAR_CONSTRAINT> ITEM_EVAL_EXPECTATION::m_ExpectedMatches

Definition at line 715 of file board_expectations.cpp.

Referenced by GetName(), and RunTest().

◆ m_Expression

std::optional<wxString> ITEM_EVAL_EXPECTATION::m_Expression

Definition at line 713 of file board_expectations.cpp.

Referenced by GetName(), and RunTest().

◆ m_ItemType

std::optional<ITEM_TYPE> ITEM_EVAL_EXPECTATION::m_ItemType

Definition at line 714 of file board_expectations.cpp.

Referenced by RunTest().

◆ m_ParentExpr

std::optional<wxString> ITEM_EVAL_EXPECTATION::m_ParentExpr

Definition at line 716 of file board_expectations.cpp.

Referenced by RunTest().

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