RebarConstraint.Create
Method
Description:
This method creates a constraint for a given RebarConstrainedHandle. Will throw exception if used for Shape Driven Rebar.
This method creates a constraint for a given RebarConstrainedHandle. Will throw exception if used for Shape Driven Rebar.
Syntax
public static RebarConstraint Create(
RebarConstrainedHandle handle,
IList<Reference> targetReferences,
bool isConstraintToCover,
double offsetValue
)
Parameters
| Parameter | Type | Description |
|---|---|---|
| handle | RebarConstrainedHandle | The handle of the rebar that will be constrained. |
| targetReferences | IList | The references to which the rebar handle will be constrained. This collection must contain one or more references to faces of elements that can host rebar. |
| isConstraintToCover | Boolean | If true the RebarConstraintType will be set to ToCover, otherwise RebarConstraintType will be set to FixedDistanceToHostFace. |
| offsetValue | Double | The distance from references to the rebar handle. |
Return Value
| Type | Description |
|---|---|
| RebarConstraint | Returns the newly created RebarConstraint. |
Exceptions
| Exception | Condition |
|---|---|
| ArgumentException | Constrained rebar isn't a free form rebar element. -or- handle is no longer valid. -or- targetReferences is empty. -or- targetReferences do not represent faces from structurals that can host rebar. |
| ArgumentNullException | A non-optional argument was null |