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 Summary

Modifier and Type	Method and Description
Optional<Classification>	getClassification(String name) Returns the first Classification found with the given name, if there is any loaded in this model.
Collection<Classification>	getClassifications() Returns all the classifications loaded in this model.
Optional<Component>	getComponentByBatId(String batId) Gets the component by BIM Authoring Tool ID.
Optional<Component>	getComponentByGuid(String guid) Gets the component with the given IFC GUID.
Set<Component>	getComponents(ComponentFilter filter) Returns components accepted by given filter.
<T extends Component> Set<T>	getComponents(ComponentFilter filter, Class<T> type) Returns components accepted by given filter that are also of the specified type.
Map<String,String>	getMetadata() Returns the metadata of the model as key to value map.
String	getName() Returns the name of the model.
Optional<Model>	getSubModel(UUID uuid) Gets a sub-model with the given UUID.
UUID	getUUID() Returns unique identifier of the model.

Method Detail

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:

1.x

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:

1.x