CompoundStructure.AddWallSweep
Method
Description:
Adds a new wall sweep or reveal to the compound structure.
Adds a new wall sweep or reveal to the compound structure.
Remarks:
A wall sweep is an object that is created by sweeping a closed 2d profile along a horizontal line that is positioned on one side (exterior or interior) of the hosting wall. A reveal is a special wall sweep with a void shape that is subtracted from the hosting wall.
The id field of the WallSweepInfo must be populated with a non-negative integer value. If there already is a sweep defined for this id, its parameters will be changed. A new sweep will be created if no existing one has matching id.
Parameters
Parameter | Type | Description |
---|---|---|
wallSweepInfo | WallSweepInfo | The wall sweep info to create a wall sweep. |
Return Value
Exceptions
Exception | Condition |
---|---|
ArgumentException | The wall sweep info does not represent a fixed wall sweep. Only fixed wall sweeps may be assigned to vertical compound structures. -or- The WallSweepInfo has an invalid id for a fixed wall sweep. |
ArgumentNullException | A non-optional argument was null |
InvalidOperationException | This operation is valid only for vertically compound structures. |