Package com.solibri.smc.api.project

Interface Project

public interface Project

Service for accessing info regarding project (.smc) file.

Since:

9.10.3

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Project.Industry	Industry associated with the project.
static class	Project.SaveStatus	Statuses of project file.

Method Summary

Modifier and Type	Method	Description
Optional<File>	getFile()	Return the location of the file (.smc) where the project is saved.
Project.SaveStatus	getFileStatus()	Get the Project.SaveStatus of the project file.
Project.Industry	getIndustry()	Get the Project.Industry of the project.
Optional<OffsetDateTime>	getLastSaveTime()	Get the time when the project file was last saved.
List<Score>	getScores(Project.Industry industry, Instant fromTime, Instant toTime)	Get the list of scores based on the Industry and time range provided.
void	setIndustry(Project.Industry industry)	Set the Project.Industry of the project.

Method Detail

getFile

Optional<File> getFile()

Return the location of the file (.smc) where the project is saved.

Returns:

file location, empty, if project is not yet saved

Since:

9.10.3

getFileStatus

Project.SaveStatus getFileStatus()

Get the Project.SaveStatus of the project file.

Returns:

the status, empty, if no model is open

Since:

9.10.3

getLastSaveTime

Optional<OffsetDateTime> getLastSaveTime()

Get the time when the project file was last saved.

Returns:

the save time, empty, if file is unsaved or no model is open.

getScores

List<Score> getScores(Project.Industry industry,
                      Instant fromTime,
                      Instant toTime)
               throws Exception

Get the list of scores based on the Industry and time range provided.

Both lower and higher range of time-line are inclusive. List of scores is sorted in ascending order of time when the respective score was calculated.

Parameters:

industry - the type industry of the project

fromTime - lower range of time-line

toTime - higher range of time-line

Returns:

scores of the project

Throws:

Exception - any exception in getting scores

Since:

9.12.6

getIndustry

Project.Industry getIndustry()

Get the Project.Industry of the project.

Returns:

Industry of the project

Since:

9.12.6

setIndustry

void setIndustry(Project.Industry industry)

Set the Project.Industry of the project.

Parameters:

industry - the industry

Since:

9.12.6