Notation used in Ruby API documentation
Module: db
Description: A circuit match entry.
This class is equivalent to the class NetlistCrossReference::CircuitPairData
This object is used to describe the relationship of two circuits in a netlist match.
Upon successful match, the first and second members are the matching objects and status is 'Match'. This object is also used to describe non-matches or match errors. In this case, first or second may be nil and status further describes the case.
| [const] | const Circuit ptr | first | Gets the first object of the relation pair. | |
| [const] | const Circuit ptr | second | Gets the second object of the relation pair. | |
| [const] | NetlistCrossReference::Status | status | Gets the status of the relation. |
first | Signature: [const] const Circuit ptr first Description: Gets the first object of the relation pair. The first object is usually the one obtained from the layout-derived netlist. This member can be nil if the pair is describing a non-matching reference object. In this case, the second member is the reference object for which no match was found. |
second | Signature: [const] const Circuit ptr second Description: Gets the second object of the relation pair. The first object is usually the one obtained from the reference netlist. This member can be nil if the pair is describing a non-matching layout object. In this case, the first member is the layout-derived object for which no match was found. |
status | Signature: [const] NetlistCrossReference::Status status Description: Gets the status of the relation. This enum described the match status of the relation pair. |