CONSTRAINT_DIAGNOSIS Struct Reference

The outcome of a constraint solve, in plain data so callers need not know planegcs. More...

#include <board_constraint_adapter.h>

Public Member Functions
bool	IsWellConstrained () const
bool	IsUnderConstrained () const
bool	IsOverConstrained () const

Public Attributes
bool	solved = false
	Solver reached Success or Converged.
int	freeDof = -1
	Remaining degrees of freedom (-1 if not diagnosed).
std::vector< KIID >	conflicting
	Constraints the solver reports as over-constraining.
std::vector< KIID >	redundant
	Constraints the solver reports as redundant.

Detailed Description

The outcome of a constraint solve, in plain data so callers need not know planegcs.

Definition at line 52 of file board_constraint_adapter.h.

Member Function Documentation

IsOverConstrained()

bool CONSTRAINT_DIAGNOSIS::IsOverConstrained ( ) const

inline

Definition at line 61 of file board_constraint_adapter.h.

References conflicting.

Referenced by BOOST_AUTO_TEST_CASE(), and diagnoseSingleCluster().

IsUnderConstrained()

bool CONSTRAINT_DIAGNOSIS::IsUnderConstrained ( ) const

inline

Definition at line 60 of file board_constraint_adapter.h.

References freeDof.

Referenced by diagnoseSingleCluster().

IsWellConstrained()

bool CONSTRAINT_DIAGNOSIS::IsWellConstrained ( ) const

inline

Definition at line 59 of file board_constraint_adapter.h.

References freeDof, and solved.

Referenced by BOOST_AUTO_TEST_CASE().

Member Data Documentation

conflicting

std::vector<KIID> CONSTRAINT_DIAGNOSIS::conflicting

Constraints the solver reports as over-constraining.

Definition at line 56 of file board_constraint_adapter.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOARD_CONSTRAINT_ADAPTER::Diagnose(), diagnoseSingleCluster(), and IsOverConstrained().

freeDof

int CONSTRAINT_DIAGNOSIS::freeDof = -1

Remaining degrees of freedom (-1 if not diagnosed).

Definition at line 55 of file board_constraint_adapter.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOARD_CONSTRAINT_ADAPTER::Diagnose(), diagnoseSingleCluster(), IsUnderConstrained(), and IsWellConstrained().

redundant

std::vector<KIID> CONSTRAINT_DIAGNOSIS::redundant

Constraints the solver reports as redundant.

Definition at line 57 of file board_constraint_adapter.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOARD_CONSTRAINT_ADAPTER::Diagnose(), and diagnoseSingleCluster().

solved

bool CONSTRAINT_DIAGNOSIS::solved = false

Solver reached Success or Converged.

Definition at line 54 of file board_constraint_adapter.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), IsWellConstrained(), and SolveCluster().

---

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

• board_constraint_adapter.h