Name |
Purpose |
Arguments |
Return value |
Example |
getAuthor |
Queries the name of the author specified in the short form Info. |
- |
STRING |
getAuthor; |
getCalcProfileName |
Queries the name of the active profile, which is used at the start of a calculation. |
- |
STRING |
getCalcProfileName; |
getComputerName |
Queries the name of your computer. |
- |
STRING |
getComputerName; |
getFileName |
Queries the name of the active file, either with or without the path. |
1: BOOLEAN: (optional): 2. BOOLEAN: (optional): |
STRING |
getFileName; |
getFluxDirectionAtLink |
returns the flow direction to a component pin |
1: ebscomp: component 2: port number (optional) |
fluxdirectionenum | getFluxDirectionAtLink (Generator, 2); |
getInputFileName |
Queries the name of the active input file, either with or without the path. |
1: BOOLEAN: (optional): |
STRING |
getInputFileName; |
getModelSerialisation |
Queries the serialization number (build-number) if the active file. This can be older than the current build-number of the application. |
- |
INTEGER: Build-number
|
getModelSerialisation; |
getModelTime
|
Queries the current model time (timestamp of the current measurement values (only EPOS)) |
1: STRING: (optional) with the desired time format (see Section Time Format). Default is ”%H:%M:%S” |
STRING |
getModelTime; |
getModelTimeForArchiveId |
Queries the current time of a specific EposArchive archive pool |
1: INTEGER: Archive-ID 2: STRING: (optional) with the desired time format (see Section Time Format). Default is ”%H:%M:%S” |
STRING |
|
getModelVersion |
Queries the EBSILON-version, with which the model was created |
- |
STRING, e.g. "3.12" |
getModelVersion; |
getOnlineState |
Checks the system state (only EPOS) |
- |
STRING: ”online” or ”offline” |
getOnlineState; |
getParentProfileName |
Queries the name of the profile, which is used as the parent profile, when a new sub-profile is created. |
- |
STRING |
getParentProfileName; |
getProductVersionHotfixNumber | Queries the hotfix number out of the version number as integer value | INTEGER: Hotfix-Number | getProductVersionHotfixNumber; | |
getProductVersionPatchNumber |
Queries the patch number out of the version number as integer value | - | INTEGER: Patch-Number | getProductVersionPatchNumber; |
getProductVersionReleaseNumber |
Queries the release number out of the version number as integer value | - | INTEGER: Release-Number | getProductVersionReleaseNumber; |
getProductVersionRevisionNumber |
Queries the revision number out of the version number as integer value | - | INTEGER: Revision-Number | getProductVersionRevisionNumber; |
getProfileName |
Returns the name for a specified Profile-ID. |
1: INTEGER: ID of the searched profile |
STRING: Name of the searched profile |
str:=getProfileName (0); |
getRevisionNumber |
Returns the revision number of the model, which is shown in the summary in case of document properties. |
- |
INTEGER: searched revision number |
n:=getRevisionNumber; |
getTime |
Queries the current system time. |
1: STRING: (optional) with the requested Time Format (see also chapter Time Formats). Default is 2: STRING: (optional) |
STRING |
getTime; |
getTitle |
Queries the title of the model (this is the file name without the path and without the extension ”.ebs”). See also |
- |
STRING |
getTitle; |
getTotalEditingSeconds |
Returns the complete processing time for the model in seconds. |
- |
INTEGER |
n:=getTotalEditingSeconds; |
getTotalEditingTime |
Returns the complete processing time for the model as string. |
1: STRING: (optional) with the desired time format (see Section Time Format). Default is ”%D days %H:%M:%S” |
STRING |
str:=getTotalEditingTime;
|
getUserName |
Queries the user name (the name used for the registration). See also ”getAuthor”. |
- |
STRING |
getUserName; |
getUserTitle |
Queries the title of the model (this is the title specified in the short form Info). See also ”getTitle” |
- |
STRING |
getUserTitle |
getVersion |
Queries the EBSILON-version, with which one is currently working |
- |
STRING, e.g. "3.33" |
getVersion |