API reference - Class NetlistCrossReference::Status

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

Public constructors

new NetlistCrossReference::Status ptrnew(int i)Creates an enum from an integer value
new NetlistCrossReference::Status ptrnew(string s)Creates an enum from a string value

Public methods

[const]bool!=(const NetlistCrossReference::Status other)Compares two enums for inequality
[const]bool<(const NetlistCrossReference::Status other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool==(const NetlistCrossReference::Status other)Compares two enums
[const]stringinspectConverts an enum to a visual string
[const]intto_iGets the integer value from the enum
[const]stringto_sGets the symbolic string from an enum

Public static methods and constants

[static,const]NetlistCrossReference::StatusMatchEnum constant NetlistCrossReference::Match
[static,const]NetlistCrossReference::StatusMatchWithWarningEnum constant NetlistCrossReference::MatchWithWarning
[static,const]NetlistCrossReference::StatusMismatchEnum constant NetlistCrossReference::Mismatch
[static,const]NetlistCrossReference::StatusNoMatchEnum constant NetlistCrossReference::NoMatch
[static,const]NetlistCrossReference::StatusNoneEnum constant NetlistCrossReference::None
[static,const]NetlistCrossReference::StatusSkippedEnum constant NetlistCrossReference::Skipped

Detailed description

!=

Signature: [const] bool != (const NetlistCrossReference::Status other)

Description: Compares two enums for inequality

<

Signature: [const] bool < (const NetlistCrossReference::Status other)

Description: Returns true if the first enum is less (in the enum symbol order) than the second

==

Signature: [const] bool == (const NetlistCrossReference::Status other)

Description: Compares two enums

Match

Signature: [static,const] NetlistCrossReference::Status Match

Description: Enum constant NetlistCrossReference::Match

An exact match exists if this code is present.

MatchWithWarning

Signature: [static,const] NetlistCrossReference::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] NetlistCrossReference::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] NetlistCrossReference::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] NetlistCrossReference::Status None

Description: Enum constant NetlistCrossReference::None

No specific status is implied if this code is present.

Python specific notes:
This attribute is available as 'None_' in Python

Skipped

Signature: [static,const] NetlistCrossReference::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:
This method is also available as 'repr(object)'

new

(1) Signature: [static] new NetlistCrossReference::Status ptr new (int i)

Description: Creates an enum from an integer value

Python specific notes:
This method is the default initializer of the object

(2) Signature: [static] new NetlistCrossReference::Status ptr new (string s)

Description: Creates an enum from a string value

Python specific notes:
This method is the default initializer of the object

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:
This method is also available as 'str(object)'