JUNCTION_HELPERS::POINT_INFO Struct Reference

A selection of information about a point in the schematic that might be eligible for turning into a junction. More...

#include <junction_helpers.h>

Public Member Functions
bool	AllowsExplicitJunction () const
	True when an explicit junction dot is permitted here, meaning a junction that is free of a bus entry or where the entry coincides with a genuine wire or bus fork.

Public Attributes
bool	isJunction
	True if the point has 3+ wires and/or 3+ buses meeting there.
bool	hasExplicitJunctionDot
	True if there is already junction dot at the point.
bool	hasBusEntry
	True if there is a bus entry at the point (either end)
bool	hasBusEntryToMultipleWires
	True if there is a bus entry at the point and it connects to more than one wire.
bool	hasBusEntryToMultipleBuses
	True if there is a bus entry at the point and three or more bus segments fork there.
bool	hasBusAtPoint
	True if there is a bus segment at the point.

Detailed Description

A selection of information about a point in the schematic that might be eligible for turning into a junction.

Definition at line 35 of file junction_helpers.h.

Member Function Documentation

AllowsExplicitJunction()

bool JUNCTION_HELPERS::POINT_INFO::AllowsExplicitJunction ( ) const

inline

True when an explicit junction dot is permitted here, meaning a junction that is free of a bus entry or where the entry coincides with a genuine wire or bus fork.

Definition at line 57 of file junction_helpers.h.

References hasBusEntry, hasBusEntryToMultipleBuses, hasBusEntryToMultipleWires, and isJunction.

Member Data Documentation

hasBusAtPoint

bool JUNCTION_HELPERS::POINT_INFO::hasBusAtPoint

True if there is a bus segment at the point.

Definition at line 53 of file junction_helpers.h.

hasBusEntry

bool JUNCTION_HELPERS::POINT_INFO::hasBusEntry

True if there is a bus entry at the point (either end)

Definition at line 44 of file junction_helpers.h.

Referenced by AllowsExplicitJunction(), and BOOST_AUTO_TEST_CASE().

hasBusEntryToMultipleBuses

bool JUNCTION_HELPERS::POINT_INFO::hasBusEntryToMultipleBuses

True if there is a bus entry at the point and three or more bus segments fork there.

Definition at line 50 of file junction_helpers.h.

Referenced by AllowsExplicitJunction().

hasBusEntryToMultipleWires

bool JUNCTION_HELPERS::POINT_INFO::hasBusEntryToMultipleWires

True if there is a bus entry at the point and it connects to more than one wire.

Definition at line 47 of file junction_helpers.h.

Referenced by AllowsExplicitJunction(), and BOOST_AUTO_TEST_CASE().

hasExplicitJunctionDot

bool JUNCTION_HELPERS::POINT_INFO::hasExplicitJunctionDot

True if there is already junction dot at the point.

Definition at line 41 of file junction_helpers.h.

isJunction

bool JUNCTION_HELPERS::POINT_INFO::isJunction

True if the point has 3+ wires and/or 3+ buses meeting there.

Definition at line 38 of file junction_helpers.h.

Referenced by AllowsExplicitJunction(), and BOOST_AUTO_TEST_CASE().

---

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

• junction_helpers.h