Get Pipe Relationship Cut Status    

Returns the current cut status for each end of the specified pipe relationship.

 

Input Arguments

 

0

Collection Object Name

Relationship Name

Relationship Name

 

Return Arguments

 

1

Boolean

Pipe 1 - Cut Available?

True indicates a cut is available

2

Boolean

Pipe 1 - Cut Active?

True indicates the cut is active

3

Boolean

Pipe 2 - Cut Available?

True indicates a cut is available

4

Boolean

Pipe 2- Cut Active?

True indicates the cut is active

 

Returned Status

 

SUCCESS

The relationship properties were returned successfully.

FAILURE

The relationship could not be found.

 

Remarks

Cut status depends on the placement and orientation of the pipe segments and the constraint settings in the Pipe to Pipe Relationship Weights dialog.