Package com.solibri.smc.api
Class SMC
- java.lang.Object
-
- com.solibri.smc.api.SMC
-
public final class SMC extends Object
The SMC is used to access different Solibri services.- Since:
- 9.10.2
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static void
bringToFront()
Brings the application to front.static ProgressBar
createProgressBar(String title, int total)
Creates a new progressbar instance with given title and total amount of progress.static ThreeD
get3D()
Returns the 3D interface for accessing 3D related functionality.static BcfApi
getBCF()
Returns theBcfApi
that provides information about the BCF communication.static BcfXml
getBcfXml()
Returns a service for creating BCF-XML reports.static Checking
getChecking()
Returns theChecking
that provides information about the softwares checking activities.static User
getCurrentUser()
Returns the current user using this application.static List<View>
getCustomViews()
Returns a list of custom views that are active in the software.static InfoDisplayer
getInfoDisplayer()
Returns an interface for handling the info view (UI).static InformationTakeoff
getInformationTakeoff()
Returns theInformationTakeoff
instance.static InternalViews
getInternalViews()
Returns the Solibri internal views.static Layouts
getLayouts()
static Model
getModel()
Returns an interface to the SMC data model.static Models
getModels()
Returns service for accessing models.static List<Presentation>
getPresentations()
Returns all the presentation available in the software.static Product
getProduct()
Returns the product variant that is running.static String
getProductVersion()
Returns the product version that is currently running.static Project
getProject()
Returns the instance for accessing saved project file (.smc) information.static SelectionBasket
getSelectionBasket()
Returns the default selection basket.static Settings
getSettings()
Provides access to the settings of the software.static boolean
isBusy()
Returns true when Solibri is busy working on something, for example, importing IFC, Checking, or evaluating classifications.static Model
openModel(String name, InputStream inputStream)
Opens a Solibri model/project.static void
shutdown()
Shuts the application down normally, possibly asking the user for confirmation, for example, if the model has unsaved changes.static void
shutdownNow()
Shuts the application down without asking any questions.
-
-
-
Method Detail
-
openModel
public static Model openModel(String name, InputStream inputStream) throws ModelOpeningException
Opens a Solibri model/project.- Parameters:
name
- the name of the modelinputStream
- the model input stream- Returns:
- the model information
- Throws:
ModelOpeningException
- the exception if the model opening fails- Since:
- 9.12.1
-
getModel
public static Model getModel()
Returns an interface to the SMC data model. This interface can be used to access raw data objects in the Solibri database. Returns null if there is no model currently open.- Returns:
- the interface to the Solibri data model
- Since:
- 9.10.2
-
getInfoDisplayer
public static InfoDisplayer getInfoDisplayer()
Returns an interface for handling the info view (UI).- Returns:
- the info service
- Since:
- 9.10.3
-
getSelectionBasket
public static SelectionBasket getSelectionBasket()
Returns the default selection basket.- Returns:
- the selection basket
- Since:
- 9.10.3
-
getModels
public static Models getModels()
Returns service for accessing models.- Returns:
- the model service
- Since:
- 9.10.3
-
getBcfXml
public static BcfXml getBcfXml()
Returns a service for creating BCF-XML reports.- Returns:
- the issue service
- Since:
- 9.10.3
-
getProject
public static Project getProject()
Returns the instance for accessing saved project file (.smc) information.- Returns:
- the project service
- Since:
- 9.10.3
-
getProduct
public static Product getProduct()
Returns the product variant that is running.- Returns:
- the product variant
- Since:
- 9.10.3
-
getProductVersion
public static String getProductVersion()
Returns the product version that is currently running.- Returns:
- the product version
- Since:
- 9.10.3
-
isBusy
public static boolean isBusy()
Returns true when Solibri is busy working on something, for example, importing IFC, Checking, or evaluating classifications.- Returns:
- true when busy
- Since:
- 9.10.3
-
getInformationTakeoff
public static InformationTakeoff getInformationTakeoff()
Returns theInformationTakeoff
instance.- Returns:
- the InformationTakeoff instance
- Since:
- 9.10.8
-
getCurrentUser
public static User getCurrentUser()
Returns the current user using this application.- Returns:
- the current user
- Since:
- 9.10.8
-
getPresentations
public static List<Presentation> getPresentations()
Returns all the presentation available in the software. The returned list is unmodifiable. The presentations inside that list might not be.- Returns:
- the presentations
- Since:
- 9.10.8
-
getSettings
public static Settings getSettings()
Provides access to the settings of the software.- Returns:
- the settings
- Since:
- 9.10.8
-
getCustomViews
public static List<View> getCustomViews()
Returns a list of custom views that are active in the software. Modifying the returned list does not affect the active views, but modifying the views themselves might.- Returns:
- the list of the views
- Since:
- 9.10.8
-
getChecking
public static Checking getChecking()
Returns theChecking
that provides information about the softwares checking activities.- Returns:
- the Checking instance
- Since:
- 9.10.6
-
get3D
public static ThreeD get3D()
Returns the 3D interface for accessing 3D related functionality.- Returns:
- the 3D access
- Since:
- 9.10.8
-
getBCF
public static BcfApi getBCF()
Returns theBcfApi
that provides information about the BCF communication.- Returns:
- the BCF instance
- Since:
- 9.12.0
-
getLayouts
public static Layouts getLayouts()
-
getInternalViews
public static InternalViews getInternalViews()
Returns the Solibri internal views.- Returns:
- the internal views
- Since:
- 9.12.0
-
shutdown
public static void shutdown()
Shuts the application down normally, possibly asking the user for confirmation, for example, if the model has unsaved changes. All custom views withView.onApplicationExit()
defined are notified properly.- Since:
- 9.12.0
-
shutdownNow
public static void shutdownNow()
Shuts the application down without asking any questions. Custom views withView.onApplicationExit()
defined will NOT be notified.- Since:
- 9.12.0
-
bringToFront
public static void bringToFront()
Brings the application to front.- Since:
- 9.12.0
-
createProgressBar
public static ProgressBar createProgressBar(String title, int total)
Creates a new progressbar instance with given title and total amount of progress.- Parameters:
title
- the title of the progressbartotal
- the total progress possible- Returns:
- a new progressbar instance
- Since:
- 9.12.0
-
-