Package com.solibri.smc.api.model

Enum Relation.Type

java.lang.Object
java.lang.Enum<Relation.Type>
com.solibri.smc.api.model.Relation.Type
All Implemented Interfaces:
Serializable, Comparable<Relation.Type>, java.lang.constant.Constable
Enclosing interface:
Relation
public static enum Relation.Type
extends Enum<Relation.Type>
Represents the types of supported relations.
Since:
9.10.2

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant Description
    BOUNDED_BY
    Defines a relation between a space and the space boundaries.
    CONNECTED_TO
    Defines a relation from a port to an element.
    CONNECTS
    Defines a relation between connected elements.
    CONNECTS_PATH_ELEMENTS
    Defines a relation between two elements, which have a path information.
    CONTAINS
    Defines a relation between a spatial level and a component.
    CONTAINS_REFERENCED
    Defines a relation between a space and a contained component.
    COVERS_ELEMENTS
    Defines a relation between a component that covers other components and the covered components.
    DECOMPOSES
    Defines a decomposition or composition relation between components depending on the direction of the relation.
    DEFINES_BY_TYPE
    Defines a relation between an object type and objects.
    FILLS
    Defines a relation between an opening and a component that fills the opening.
    GROUPS
    Defines a relation between a grouping element and the grouped elements.
    NEAREST_SPACES
    Defines a relation between a component and its nearest spaces.
    OCCUPIES_SPACES
    Defines a relation between an occupant and spaces.
    PARTIALLY_VOIDS
    Defines a relation between an element and an opening that creates a recess in the element.
    PROVIDES
    Defines a general containment relation from a component to the provided component.
    SERVES
    Defines a relation between a system and the site or building that it serves.
    VOIDS
    Defines a relation between an opening and an element into which it creates a void.

  • Method Summary

    Modifier and Type Method Description
    static Relation.Type valueOf​(String name)
    Returns the enum constant of this type with the specified name.
    static Relation.Type[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • BOUNDED_BY

      public static final Relation.Type BOUNDED_BY
      Defines a relation between a space and the space boundaries.

      Corresponds to IfcRelSpaceBoundary.

      Since:
      9.10.3

    • CONNECTED_TO

      public static final Relation.Type CONNECTED_TO
      Defines a relation from a port to an element.

      Corresponds to IfcRelConnectsPortToElement.

      Since:
      9.10.3

    • CONNECTS

      public static final Relation.Type CONNECTS
      Defines a relation between connected elements.

      Corresponds to IfcRelConnectsElements.

      Since:
      9.10.3

    • CONNECTS_PATH_ELEMENTS

      public static final Relation.Type CONNECTS_PATH_ELEMENTS
      Defines a relation between two elements, which have a path information.

      Corresponds to IfcRelConnectsPathElements.

      Since:
      9.10.3

    • CONTAINS

      public static final Relation.Type CONTAINS
      Defines a relation between a spatial level and a component.

      Corresponds to IfcRelContainedInSpatialStructure.

      Since:
      9.10.3

    • CONTAINS_REFERENCED

      public static final Relation.Type CONTAINS_REFERENCED
      Defines a relation between a space and a contained component.
      Since:
      9.10.3

    • COVERS_ELEMENTS

      public static final Relation.Type COVERS_ELEMENTS
      Defines a relation between a component that covers other components and the covered components.

      Corresponds to IfcRelCoversBldgElements.

      Since:
      9.10.3

    • DECOMPOSES

      public static final Relation.Type DECOMPOSES
      Defines a decomposition or composition relation between components depending on the direction of the relation.

      Corresponds to IfcRelDecomposes.

      Since:
      9.10.3

    • DEFINES_BY_TYPE

      public static final Relation.Type DEFINES_BY_TYPE
      Defines a relation between an object type and objects.

      Corresponds to IfcRelDefinesByType.

      Since:
      9.10.3

    • FILLS

      public static final Relation.Type FILLS
      Defines a relation between an opening and a component that fills the opening.

      Corresponds to IfcRelFillsElement.

      Since:
      9.10.3

    • GROUPS

      public static final Relation.Type GROUPS
      Defines a relation between a grouping element and the grouped elements.

      Corresponds to IfcGroup.

      Since:
      9.10.3

    • OCCUPIES_SPACES

      public static final Relation.Type OCCUPIES_SPACES
      Defines a relation between an occupant and spaces.

      Corresponds to IfcRelOccupiesSpaces.

      Since:
      9.10.3

    • PARTIALLY_VOIDS

      public static final Relation.Type PARTIALLY_VOIDS
      Defines a relation between an element and an opening that creates a recess in the element.
      Since:
      9.10.3

    • PROVIDES

      public static final Relation.Type PROVIDES
      Defines a general containment relation from a component to the provided component.
      Since:
      9.10.3

    • NEAREST_SPACES

      public static final Relation.Type NEAREST_SPACES
      Defines a relation between a component and its nearest spaces.

      Corresponds to the user defined Nearest Spaces relation.

      Since:
      9.10.3

    • SERVES

      public static final Relation.Type SERVES
      Defines a relation between a system and the site or building that it serves.

      Corresponds to IfcRelServicesBuildings.

      Since:
      9.10.3

    • VOIDS

      public static final Relation.Type VOIDS
      Defines a relation between an opening and an element into which it creates a void.

      Corresponds to IfcRelVoidsElement.

      Since:
      9.10.3

  • Method Details

    • values

      public static Relation.Type[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static Relation.Type valueOf​(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null