•  

GetCouplerIdAtIndex Method

Gets the id of the Rebar Coupler that is applied to the bar with index barPositionIndex at the specified end.

Namespace: Autodesk.Revit.DB.Structure
Assembly: RevitAPI (in RevitAPI.dll) Version: 19.0.0.0 (19.0.0.405)
Since: 2019

Syntax

C# 
public ElementId GetCouplerIdAtIndex(
	int barPositionIndex,
	int end
)
Visual Basic 
Public Function GetCouplerIdAtIndex ( _
	barPositionIndex As Integer, _
	end As Integer _
) As ElementId
Visual C++ 
public:
ElementId^ GetCouplerIdAtIndex(
	int barPositionIndex, 
	int end
)

Parameters

barPositionIndex
Type: System Int32
An index between 0 and (NumberOfBarPositions-1).
end
Type: System Int32
0 for the start hook, 1 for the end hook.

Return Value

Returns id of the Rebar Coupler at the specified end.

Remarks

If this Rebar has Workshop Instructions set to Straight will return the same value for all barPositionIndex between 0 and (NumberOfBarPositions-1). This value will be the same as Rebar.GetCouplerId(int end).

If this Rebar has Workshop Instructions set to Bent there are different cases:

  • All bars are matched exactly with a shape. In this case will return the same value for all barPositionIndex between 0 and (NumberOfBarPositions-1). This value will be the same as Rebar.GetCouplerId(int end).
  • All bars are matched in reversed order with a shape. In this case will return the same value for all barPositionIndex between 0 and (NumberOfBarPositions-1). This value will be the same as Rebar.GetCouplerId(int end).
  • Some bars are matched in reversed order and the others are matched exactly with a shape. In this case for bars that are matched reversed will return the id of the Rebar Coupler at the opposite end. For the others bars will return the same as Rebar.GetCouplerId(int end).

Exceptions

Exception Condition
Autodesk.Revit.Exceptions ArgumentOutOfRangeException end must be 0 or 1. -or- barPositionIndex is not in the range [ 0, NumberOfBarPositions-1 ].

See Also