M

CompoundStructure.DeleteLayer

Description:
Deletes the specified layer from this CompoundStructure.

Remarks:
For a vertically compound structure, a layer may only be deleted if it is not associated to a region, or else it is associated to exactly one simple region, which will also be deleted. Regions associated to layers with index greater than layerIdx will have their associated layer indices decremented by one.

public bool DeleteLayer(
	int layerIdx
)

Public Function DeleteLayer ( 
	layerIdx As Integer
) As Boolean

public:
bool DeleteLayer(
	int layerIdx
)

member DeleteLayer : 
        layerIdx : int -> bool

Int32

layerIdx

Index of a layer in the CompoundStructure. The layer index is zero based. It counts from the exterior of wall and from the top of roofs, floors and ceilings.

Return Value Boolean True if the layer was successfully deleted, and false otherwise.

ArgumentException

The layer cannot be deleted.
ArgumentOutOfRangeException

The layer index is out of range.