com.solibri.smc.api.model.components

Interface SpaceBoundary

public interface SpaceBoundary

The SpaceBoundary interface provides information about the space boundary. The space boundary defines the physical or virtual delimiter of a space as its relationship to the surrounding elements.

Since:

9.10.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SpaceBoundary.Type The type of the space boundary.

Method Summary

Modifier and Type	Method and Description
double	getArea() Returns the area of the space boundary.
Optional<Component>	getRelatedBuildingElement() Returns the related building element entity.
Optional<Space>	getSpace() Returns the relating space entity.
SpaceBoundary.Type	getType() Returns the type of the space boundary.

Method Detail

getArea

double getArea()

Returns the area of the space boundary.

Returns:

the area

Since:

9.10.2

getSpace

Optional<Space> getSpace()

Returns the relating space entity. Reference to space that is delimited by this boundary.

Returns:

an Optional having the space entity, or an empty Optional if there is no space entity specified

Since:

9.10.2

getType

SpaceBoundary.Type getType()

Returns the type of the space boundary.

Returns:

the type

Since:

9.10.2

getRelatedBuildingElement

Optional<Component> getRelatedBuildingElement()

Returns the related building element entity. Usually the relating element is a wall, a door or a window that is bounding the space. If the space boundary is between two spaces without an building element between them, then the related building element is not provided.

Returns:

an Optional having the related building element, or an empty Optional if there is no related building element

Since:

9.10.2