Notation used in Ruby API documentation
Module: db
Description: This class represents the NetlistCrossReference::Status enum
This class is equivalent to the class NetlistCrossReference::Status
| new Status ptr | new | (int i) | Creates an enum from an integer value |
| new Status ptr | new | (string s) | Creates an enum from a string value |
| [const] | bool | != | (const Status other) | Compares two enums for inequality |
| [const] | bool | < | (const Status other) | Returns true if the first enum is less (in the enum symbol order) than the second |
| [const] | bool | == | (const Status other) | Compares two enums |
| [const] | string | inspect | Converts an enum to a visual string | |
| [const] | int | to_i | Gets the integer value from the enum | |
| [const] | string | to_s | Gets the symbolic string from an enum |
| [static,const] | Status | Match | Enum constant NetlistCrossReference::Match | |
| [static,const] | Status | MatchWithWarning | Enum constant NetlistCrossReference::MatchWithWarning | |
| [static,const] | Status | Mismatch | Enum constant NetlistCrossReference::Mismatch | |
| [static,const] | Status | NoMatch | Enum constant NetlistCrossReference::NoMatch | |
| [static,const] | Status | None | Enum constant NetlistCrossReference::None | |
| [static,const] | Status | Skipped | Enum constant NetlistCrossReference::Skipped |
!= | Signature: [const] bool != (const Status other) Description: Compares two enums for inequality |
< | Signature: [const] bool < (const Status other) Description: Returns true if the first enum is less (in the enum symbol order) than the second |
== | Signature: [const] bool == (const Status other) Description: Compares two enums |
Match | Signature: [static,const] Status Match Description: Enum constant NetlistCrossReference::Match An exact match exists if this code is present. |
MatchWithWarning | Signature: [static,const] Status MatchWithWarning Description: Enum constant NetlistCrossReference::MatchWithWarning If this code is present, a match was found but a warning is issued. For nets, this means that the choice is ambiguous and one, unspecific candidate has been chosen. For devices, this means a device match was established, but parameters or the device class are not matching exactly. |
Mismatch | Signature: [static,const] Status Mismatch Description: Enum constant NetlistCrossReference::Mismatch This code means there is a match candidate, but exact identity could not be confirmed. |
NoMatch | Signature: [static,const] Status NoMatch Description: Enum constant NetlistCrossReference::NoMatch If this code is present, no match could be found. There is also 'Mismatch' which means there is a candidate, but exact identity could not be confirmed. |
None | Signature: [static,const] Status None Description: Enum constant NetlistCrossReference::None No specific status is implied if this code is present. Python specific notes: |
Skipped | Signature: [static,const] Status Skipped Description: Enum constant NetlistCrossReference::Skipped On circuits this code means that a match has not been attempted because subcircuits of this circuits were not matched. As circuit matching happens bottom-up, all subcircuits must match at least with respect to their pins to allow any parent circuit to be matched. |
inspect | Signature: [const] string inspect Description: Converts an enum to a visual string Python specific notes: |
new | Signature: [static] new Status ptr new (int i) Description: Creates an enum from an integer value Python specific notes: |
Signature: [static] new Status ptr new (string s) Description: Creates an enum from a string value Python specific notes: | |
to_i | Signature: [const] int to_i Description: Gets the integer value from the enum |
to_s | Signature: [const] string to_s Description: Gets the symbolic string from an enum Python specific notes: |