Class CIDtoWID
This concrete class contains static methods to use with CID to WID designs. Use this class to access and validate data in the CID to WID designs. The operation fails with RSDException thrown.
public class CIDtoWID
extends java.lang.Object
Hierarchical Diagram
Direct Known Subclasses
None
Fields
None
Constructor
None
Methods
• parameterSameAsCircuit
static public java.lang.String parameterSameAsCircuit (artifact fiber, String parameterName)
Checks that the specified parameter on the wiring diagram fiber has the same value that appears on the circuit diagram fiber with the same circuit_id value.
Where:
fiber—Fiber artifact.
parameterName—Name of the parameter in the wiring diagram fiber to compare with the circuit diagram fiber.
Returns:
Values identical—When all of the values in parameterName in the circuit diagram are identical and match the values in the wiring diagram for the same circuit_id.
Values mismatch—When none of the values in parameterName in the circuit diagram are identical and match the values in the wiring diagram for the same circuit_id.
Mixed values found—When some of the values in parameterName in the circuit diagram are identical and match the values in the wiring diagram for the same circuit_id.
No circuit representation—When a circuit shape fiber with the same circuit_id is not found.
Fiber cannot be verified—When one of the following occurs:
◦ The circuit_id value could not be retrieved.
◦ The fiber is not a fiber artifact.
◦ The fiber does not have a wiring shape.
• parameterSameAsWiring
static public java.lang.String parameterSameAsWiring (artifact fiber, String parameterName)
Checks that the specified parameter on the circuit diagram fiber has the same value that appears on the wiring diagram fiber with the same circuit_id value.
Where:
fiber—Fiber artifact.
parameterName—Name of the parameter in the circuit diagram fiber to compare with the wiring diagram fiber.
Returns:
Values identical—When all of the values in parameterName in the wiring diagram are identical and match the values in the circuit diagram for the same circuit_id.
Values mismatch—When none of the values in parameterName in the wiring diagram are identical and match the values in the circuit diagram for the same circuit_id.
Mixed values found—When some of the values in parameterName in the wiring diagram are identical and match the values in the circuit diagram for the same circuit_id.
No wiring representation—When a wiring shape fiber with the same circuit_id is not found.
Fiber cannot be verified—When one of the following occurs:
◦ The circuit_id value could not be retrieved.
◦ The fiber is not a fiber artifact.
◦ The fiber does not have a circuit shape.
• isFullyMated
static public java.lang.String isFullyMated ()
Checks that components are fully mated.
Returns yes if the component is fully mated, no if the component is not fully mated.
• isNotFullyMated
static public java.lang.String isNotFullyMated ()
Checks for components that are not fully mated.
Returns:
true when the component is not fully mated.
false when:
◦ The component is fully mated.
◦ The artifact is not of type Component.
◦ The parameter mates_with does not exist on the component artifact.
◦ A connector identification parameter was not defined.
• getComponentMatedConnectors
static public java.util.Vector<Artifact> getComponentMatedConnectors (artifact component)
Where:
component—Component artifact
Returns a list of connectors mated to the component.
Methods Inherited
The methods inherited from other classes are:
Class | Methods Inherited |
java.lang.Object | getClass, notify, notifyAll, wait, wait, wait |
