CompoundStructure.CreateSingleLayerCompoundStructure(Double, MaterialFunctionAssignment, Double, ElementId)
Method
Description:
Creates a vertically compound CompoundStructure with one layer.
Creates a vertically compound CompoundStructure with one layer.
Remarks:
It is not verified that materialId corresponds to a valid MaterialElem.
It is not verified that materialId corresponds to a valid MaterialElem.
Syntax
public static CompoundStructure CreateSingleLayerCompoundStructure(
double sampleHeight,
MaterialFunctionAssignment layerFunction,
double width,
ElementId materialId
)
Parameters
Parameter | Type | Description |
---|---|---|
sampleHeight | Double | The sample height of this vertically compound structure. |
layerFunction | MaterialFunctionAssignment | The function of the single layer. |
width | Double | The width of the single layer. |
materialId | ElementId | The ElementId of the material for the single layer. |
Return Value
Type | Description |
---|---|
CompoundStructure | The newly created compound structure. |
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | A non-optional argument was null |
ArgumentOutOfRangeException | The given value for sampleHeight must be greater than 0 and no more than 30000 feet. -or- The given value for width must be greater than 0 and no more than 30000 feet. -or- A value passed for an enumeration argument is not a member of that enumeration |