Package com.solibri.smc.api.model

Interface Model

All Known Subinterfaces:
MModel
public interface Model
This interface is used for getting data from the data model. This interface alone does not enable editing of the data model yet. This can be retrieved through the SMC interface.
Since:
9.10.2

  • Method Details

    • getComponentByGuid

      Optional<Component> getComponentByGuid​(String guid)
      Gets the component with the given IFC GUID.
      Parameters:
      guid - the component IFC GUID
      Returns:
      An Optional containing the component, or an empty Optional if no match
      Since:
      9.10.3

    • getComponentByBatId

      Optional<Component> getComponentByBatId​(String batId)
      Gets the component by BIM Authoring Tool ID.
      Parameters:
      batId - the id
      Returns:
      An Optional containing the component, or an empty Optional if no match
      Since:
      9.10.3

    • getSubModel

      Optional<Model> getSubModel​(UUID uuid)
      Gets a sub-model with the given UUID.
      Parameters:
      uuid - the model UUID
      Returns:
      An Optional containing the model, or an empty Optional if no match
      Since:
      9.10.3

    • getComponents

      Set<Component> getComponents​(ComponentFilter filter)
      Returns components accepted by given filter.
      Parameters:
      filter - a ComponentFilter
      Returns:
      a collection of Component passing given filter
      Since:
      9.10.2

    • getComponents

      <T extends Component> Set<T> getComponents​(ComponentFilter filter, Class<T> type)
      Returns components accepted by given filter that are also of the specified type.
      Type Parameters:
      T - the type of the component
      Parameters:
      filter - a ComponentFilter
      type - the class type of the components to retrieve from the model
      Returns:
      a collection of Component passing given filter
      Since:
      9.10.2

    • getUUID

      UUID getUUID()
      Returns unique identifier of the model.
      Returns:
      the UUID
      Since:
      9.10.3

    • getName

      String getName()
      Returns the name of the model.
      Returns:
      the name
      Since:
      9.10.3

    • getMetadata

      Map<String,​String> getMetadata()
      Returns the metadata of the model as key to value map.
      Returns:
      the metadata
      Since:
      9.10.3

    • getClassifications

      Collection<Classification> getClassifications()
      Returns all the classifications loaded in this model.
      Returns:
      a collection of all the Classifications loaded in this model
      Since:
      9.10.4

    • getClassification

      Optional<Classification> getClassification​(String name)
      Returns the first Classification found with the given name, if there is any loaded in this model. If there are multiple classifications with the same name, this method returns the first found.
      Parameters:
      name - the given name
      Returns:
      the first Classification found with the given name, empty Optional if not found
      Since:
      9.10.4

    • getSourceApplication

      Optional<String> getSourceApplication()
      Returns the source application for this model, if the information exists.
      Returns:
      the source application
      Since:
      9.12.0

    • getRulesets

      Set<Ruleset> getRulesets()
      Returns the root rulesets of the model. The fact that only root rulesets are returned means that to find all rules, the hierarchy must be traversed fully and it is not enough to only get the direct descendants.
      Returns:
      the root rulesets
      Since:
      9.12.0

    • getTransformationMatrix

      Matrix4d getTransformationMatrix()
      Get the model's global transformation matrix. When this method is called on the root model, it returns the root model's transformation matrix, not the sub model's transformation matrix, even when only one sub model is present. To retrieve the transformation matrix of a sub model, call this method on the sub model instead. Sub models can be retrieved by using Models.getModels() or Component.getModel().
      Returns:
      the model's global transformation matrix
      Since:
      9.12.1