FMUInfo

class persalys.FMUInfo(*args)

Retrieve information from a FMU file.

Parameters:

fmuFilestr

FMU file name

fmuTypestr, default=’auto’

FMU type, either auto, ME or CS

Methods

getAuthor()	Author accessor.
getCausality()	Causality accessor.
getClassName()	Accessor to the object's name.
getCopyright()	Copyright accessor.
getDateTime()	Date/Time accessor.
getFMIVersion()	FMI version accessor.
getFileName()	File name accessor.
getGUID()	GUID accessor.
getIdentifier()	Model identifier accessor.
getModelType()	Model type accessor.
getName()	Accessor to the object's name.
getPlatform()	Platform accessor.
getStartKeys()	Variables with values: names accessor.
getStartValues()	Variables with values: values accessor.
getTool()	Tool identifier accessor.
getVariability()	Variability accessor.
getVariableNames()	Variable names accessor.
getVersion()	Model version accessor.
hasName()	Test if the object is named.
setName(name)	Accessor to the object's name.

__init__(*args)

getAuthor()

Author accessor.

Returns:

authorstr

Author name

getCausality()

Causality accessor.

Returns:

causalityopenturns.Indices

Causality values

getClassName()

Accessor to the object’s name.

Returns:

class_namestr

The object class name (object.__class__.__name__).

getCopyright()

Copyright accessor.

Returns:

copyrightstr

Copyright text

getDateTime()

Date/Time accessor.

Returns:

dateTimestr

Date and time

getFMIVersion()

FMI version accessor.

Returns:

fmiVersionstr

FMI specification version string

getFileName()

File name accessor.

Returns:

fnstr

FMU file name

getGUID()

GUID accessor.

Returns:

guidstr

Globally Unique Identifier string

getIdentifier()

Model identifier accessor.

Returns:

identifierstr

Model identifier string

getModelType()

Model type accessor.

Returns:

model_typestr

Model type string: either Model Exchange or Co-Simulation

getName()

Accessor to the object’s name.

Returns:

namestr

The name of the object.

getPlatform()

Platform accessor.

Returns:

platformstr

Platform string

getStartKeys()

Variables with values: names accessor.

Returns:

startKeysopenturns.Description

Variables names

getStartValues()

Variables with values: values accessor.

Returns:

startValuesopenturns.Point

Default values

getTool()

Tool identifier accessor.

Returns:

toolstr

Generation tool identifier string

getVariability()

Variability accessor.

Returns:

variabilityopenturns.Indices

Variability values

getVariableNames()

Variable names accessor.

Returns:

descriptionopenturns.Description

Variable names

getVersion()

Model version accessor.

Returns:

versionstr

Model version string

hasName()

Test if the object is named.

Returns:

hasNamebool

True if the name is not empty.

setName(name)

Accessor to the object’s name.

Parameters:

namestr

The name of the object.