A single expectation about a board, which can be run as a test against a parsed BOARD. More...

#include <board_expectations.h>

Inheritance diagram for KI_TEST::BOARD_EXPECTATION:

Public Member Functions
virtual	~BOARD_EXPECTATION ()=default

virtual void	RunTest (const BOARD &aBrd) const =0

virtual std::string	GetName () const =0

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

Private Attributes
std::string	m_Comment

Detailed Description

A single expectation about a board, which can be run as a test against a parsed BOARD.

Definition at line 42 of file board_expectations.h.

Constructor & Destructor Documentation

◆ ~BOARD_EXPECTATION()

virtual KI_TEST::BOARD_EXPECTATION::~BOARD_EXPECTATION ( )

virtualdefault

Member Function Documentation

◆ GetComment()

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

inline

Definition at line 57 of file board_expectations.h.

References m_Comment.

◆ GetName()

virtual std::string KI_TEST::BOARD_EXPECTATION::GetName ( ) const

pure virtual

Implemented in ITEM_EVAL_EXPECTATION, LAYER_EXPECTATION, NET_EXPECTATION, and NETCLASS_EXPECTATION.

◆ RunTest()

virtual void KI_TEST::BOARD_EXPECTATION::RunTest ( const BOARD & aBrd ) const

pure virtual

Implemented in ITEM_EVAL_EXPECTATION, LAYER_EXPECTATION, NET_EXPECTATION, and NETCLASS_EXPECTATION.

◆ SetComment()

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

inline

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

private

Definition at line 60 of file board_expectations.h.

Referenced by GetComment(), and SetComment().

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

board_expectations.h

Public Member Functions

Private Attributes