KiCad PCB EDA Suite
Public Member Functions | Private Attributes | List of all members
MINOPTMAX< T > Class Template Reference

#include <minoptmax.h>

Public Member Functions

T Min () const
 
T Max () const
 
T Opt () const
 
bool HasMin () const
 
bool HasMax () const
 
bool HasOpt () const
 
void SetMin (T v)
 
void SetMax (T v)
 
void SetOpt (T v)
 
bool IsNull () const
 

Private Attributes

bool m_isNull
 
T m_min
 
T m_opt
 
T m_max
 
bool m_hasMin = false
 
bool m_hasOpt = false
 
bool m_hasMax = false
 

Detailed Description

template<class T = int>
class MINOPTMAX< T >

Definition at line 30 of file minoptmax.h.

Member Function Documentation

◆ HasMax()

template<class T = int>
bool MINOPTMAX< T >::HasMax ( ) const
inline

Definition at line 38 of file minoptmax.h.

38 { return m_hasMax; }
MINOPTMAX::m_hasMax
bool m_hasMax
Definition: minoptmax.h:54

Referenced by DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengthViolations(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkewViolations(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkViaCountViolations(), and PCB_TRACK::GetWidthConstraints().

◆ HasMin()

template<class T = int>
bool MINOPTMAX< T >::HasMin ( ) const
inline

Definition at line 37 of file minoptmax.h.

37 { return m_hasMin; }
MINOPTMAX::m_hasMin
bool m_hasMin
Definition: minoptmax.h:52

Referenced by DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengthViolations(), PNS::MEANDER_PLACER_BASE::Clearance(), PCB_VIA::GetMinAnnulus(), BOARD_CONNECTED_ITEM::GetOwnClearance(), and PCB_TRACK::GetWidthConstraints().

◆ HasOpt()

template<class T = int>
bool MINOPTMAX< T >::HasOpt ( ) const
inline

Definition at line 39 of file minoptmax.h.

39 { return m_hasOpt; }
MINOPTMAX::m_hasOpt
bool m_hasOpt
Definition: minoptmax.h:53

◆ IsNull()

template<class T = int>
bool MINOPTMAX< T >::IsNull ( ) const
inline

Definition at line 45 of file minoptmax.h.

45 { return m_isNull; }
MINOPTMAX::m_isNull
bool m_isNull
Definition: minoptmax.h:48

◆ Max()

template<class T = int>
T MINOPTMAX< T >::Max ( ) const
inline

Definition at line 34 of file minoptmax.h.

34 { return m_hasMax ? m_max : std::numeric_limits<T>::max(); };
MINOPTMAX::m_hasMax
bool m_hasMax
Definition: minoptmax.h:54

Referenced by DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengthViolations(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkewViolations(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkViaCountViolations(), and PCB_TRACK::GetWidthConstraints().

◆ Min()

template<class T = int>
T MINOPTMAX< T >::Min ( ) const
inline

Definition at line 33 of file minoptmax.h.

33 { return m_hasMin ? m_min : 0; };
MINOPTMAX::m_hasMin
bool m_hasMin
Definition: minoptmax.h:52

Referenced by DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengthViolations(), DRC_TEST_PROVIDER_HOLE_SIZE::checkPad(), DRC_TEST_PROVIDER_HOLE_SIZE::checkVia(), PNS::MEANDER_PLACER_BASE::Clearance(), DRAWING_TOOL::DrawVia(), BOARD_DESIGN_SETTINGS::GetBiggestClearanceValue(), PCB_VIA::GetMinAnnulus(), BOARD_CONNECTED_ITEM::GetOwnClearance(), PCB_TRACK::GetWidthConstraints(), PNS_KICAD_IFACE_BASE::ImportSizes(), MINOPTMAX< int >::Opt(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::Run(), DRC_TEST_PROVIDER_SILK_TO_MASK::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZones(), and ROUTER_TOOL::updateMessagePanel().

◆ Opt()

template<class T = int>
T MINOPTMAX< T >::Opt ( ) const
inline

Definition at line 35 of file minoptmax.h.

35 { return m_hasOpt ? m_opt : Min(); };
MINOPTMAX::Min
T Min() const
Definition: minoptmax.h:33
MINOPTMAX::m_hasOpt
bool m_hasOpt
Definition: minoptmax.h:53

Referenced by ROUTER_TOOL::handleLayerSwitch(), and PNS_KICAD_IFACE_BASE::ImportSizes().

◆ SetMax()

template<class T = int>
void MINOPTMAX< T >::SetMax ( T  v)
inline

Definition at line 42 of file minoptmax.h.

42 { m_isNull = false; m_max = v; m_hasMax = true; }
MINOPTMAX::m_isNull
bool m_isNull
Definition: minoptmax.h:48
MINOPTMAX::m_hasMax
bool m_hasMax
Definition: minoptmax.h:54

Referenced by DRC_RULES_PARSER::parseConstraint().

◆ SetMin()

template<class T = int>
void MINOPTMAX< T >::SetMin ( T  v)
inline

Definition at line 41 of file minoptmax.h.

41 { m_isNull = false; m_min = v; m_hasMin = true; }
MINOPTMAX::m_hasMin
bool m_hasMin
Definition: minoptmax.h:52
MINOPTMAX::m_isNull
bool m_isNull
Definition: minoptmax.h:48

Referenced by DRC_ENGINE::EvalRules(), DRC_ENGINE::loadImplicitRules(), and DRC_RULES_PARSER::parseConstraint().

◆ SetOpt()

template<class T = int>
void MINOPTMAX< T >::SetOpt ( T  v)
inline

Definition at line 43 of file minoptmax.h.

43 { m_isNull = false; m_opt = v; m_hasOpt = true; }
MINOPTMAX::m_hasOpt
bool m_hasOpt
Definition: minoptmax.h:53
MINOPTMAX::m_isNull
bool m_isNull
Definition: minoptmax.h:48

Referenced by DRC_ENGINE::loadImplicitRules(), and DRC_RULES_PARSER::parseConstraint().

Member Data Documentation

◆ m_hasMax

template<class T = int>
bool MINOPTMAX< T >::m_hasMax = false
private

Definition at line 54 of file minoptmax.h.

Referenced by MINOPTMAX< int >::HasMax(), MINOPTMAX< int >::Max(), and MINOPTMAX< int >::SetMax().

◆ m_hasMin

template<class T = int>
bool MINOPTMAX< T >::m_hasMin = false
private

Definition at line 52 of file minoptmax.h.

Referenced by MINOPTMAX< int >::HasMin(), MINOPTMAX< int >::Min(), and MINOPTMAX< int >::SetMin().

◆ m_hasOpt

template<class T = int>
bool MINOPTMAX< T >::m_hasOpt = false
private

Definition at line 53 of file minoptmax.h.

Referenced by MINOPTMAX< int >::HasOpt(), MINOPTMAX< int >::Opt(), and MINOPTMAX< int >::SetOpt().

◆ m_isNull

template<class T = int>
bool MINOPTMAX< T >::m_isNull
private

Definition at line 48 of file minoptmax.h.

Referenced by MINOPTMAX< int >::IsNull(), MINOPTMAX< int >::SetMax(), MINOPTMAX< int >::SetMin(), and MINOPTMAX< int >::SetOpt().

◆ m_max

template<class T = int>
T MINOPTMAX< T >::m_max
private

Definition at line 51 of file minoptmax.h.

Referenced by MINOPTMAX< int >::Max(), and MINOPTMAX< int >::SetMax().

◆ m_min

template<class T = int>
T MINOPTMAX< T >::m_min
private

Definition at line 49 of file minoptmax.h.

Referenced by MINOPTMAX< int >::Min(), and MINOPTMAX< int >::SetMin().

◆ m_opt

template<class T = int>
T MINOPTMAX< T >::m_opt
private

Definition at line 50 of file minoptmax.h.

Referenced by MINOPTMAX< int >::Opt(), and MINOPTMAX< int >::SetOpt().

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