RebarFreeFormAccessorGetCouplerIdAtIndex Method

public ElementId GetCouplerIdAtIndex(
	int barPositionIndex,
	int end
)

Public Function GetCouplerIdAtIndex ( 
	barPositionIndex As Integer,
	end As Integer
) As ElementId

public:
ElementId^ GetCouplerIdAtIndex(
	int barPositionIndex, 
	int end
)

member GetCouplerIdAtIndex : 
        barPositionIndex : int * 
        end : int -> ElementId 

Parameters

barPositionIndex  Int32

An index between 0 and (NumberOfBarPositions-1).

end  Int32

0 for the start hook, 1 for the end hook.

Return Value

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).

Reference