Package com.piketec.tpt.api
Interface Back2BackSettings
-
- All Superinterfaces:
IdentifiableRemote
,java.rmi.Remote
,TptRemote
public interface Back2BackSettings extends IdentifiableRemote
- Author:
- Copyright (c) 2014-2020 Piketec GmbH - MIT License (MIT) - All rights reserved
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Back2BackSettings.VariableType
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Back2BackRow
addRow(java.lang.String variable)
Creates and adds asignal comparison row
for the given variable name.java.lang.String
getComparisonTriggerExpression()
java.lang.String
getDifferenceToHoseSuffix()
java.lang.String
getDifferenceToReferenceSuffix()
ExecutionConfigurationItem
getExecConfigItem()
Mapping
getMappingForTolerance()
java.lang.Object
getReference()
There are three types of possible references and therefore three different types of return values.java.lang.String
getReferenceDataTimeShift()
java.lang.String
getReferenceSuffix()
RemoteList<Back2BackRow>
getRows()
Get all addedsignal comparison rows
.boolean
isAutoUpdate(Back2BackSettings.VariableType type)
boolean
isDisplayDifferenceToReference()
boolean
isExportDifferenceToHoseSignals()
boolean
isExportDifferenceToReferenceSignals()
boolean
isExportReferenceSignals()
boolean
isHighlightSelectiveSamplePoints()
boolean
isIgnoreTimeBoundaries()
boolean
isIgnoreUndefinedPhases()
void
setAutoUpdate(Back2BackSettings.VariableType type, boolean on)
turn on/off auto-update feature for the specifiedBack2BackSettings.VariableType
void
setComparisonTriggerExpression(java.lang.String sampleFilterExpression)
Change theString
that represents the comparison-trigger-expression.void
setDifferenceToHoseSuffix(java.lang.String differenceToHoseSuffix)
Changes the suffix added to the difference to hosesignal
.void
setDifferenceToReferenceSuffix(java.lang.String differenceToReferenceSuffix)
Changes the suffix added to the difference to the reference-signalsignal
.void
setDisplayDifferenceToReference(boolean displayDifferenceToReference)
If set to true, the differenceSignal calculated by TPT.hose will not be shown but used to display, where the Assesslet fails (red background in SignalViewer).void
setExportDifferenceToHoseSignals(boolean exportDifferenceToHoseSignals)
Change if the difference tohose signals
are exported to the report.void
setExportDifferenceToReferenceSignals(boolean exportDifferenceToReferenceSignals)
Change if the difference to thereference signals
are exported to the report.void
setExportReferenceSignals(boolean exportReferenceSignals)
changetrue
if thereference signals
are exported to the report.void
setHighlightSelectiveSamplePoints(boolean usePatternsToHighlightSignals)
Changes if patterns are used to highlight signals.void
setIgnoreTimeBoundaries(boolean ignoreTimeBoundaries)
Change if the time-boundaries are ignored.void
setIgnoreUndefinedPhases(boolean ignoreUndefinedPhases)
Changes if differences in a sample are ignored.void
setMappingForTolerance(Mapping mappingForTolerance)
ChangeMapping
that is used for the tolerance.void
setReferenceDataTimeShift(java.lang.String referenceDataTimeShift)
ChangeString
that represents the reference-data-time-shift.void
setReferenceSuffix(java.lang.String referenceSuffix)
Changes the suffix added to the referencesignals
.void
setReferenceToExecutionConfigurationItem(ExecutionConfigurationItem item)
Set an other execution configuration item as reference.void
setReferenceToFile(java.lang.String path)
Set a reference file as reference.void
setReferenceToReferenceDirectory()
Set the reference directory of the parentExecutionConfiguration
as reference.-
Methods inherited from interface com.piketec.tpt.api.IdentifiableRemote
getIdentifier
-
-
-
-
Method Detail
-
addRow
Back2BackRow addRow(java.lang.String variable) throws java.rmi.RemoteException
Creates and adds asignal comparison row
for the given variable name.- Parameters:
variable
- variable name of the variable to be compared- Returns:
- the newly created row instance for variable comparison
- Throws:
java.rmi.RemoteException
- remote communication problem
-
getRows
RemoteList<Back2BackRow> getRows() throws java.rmi.RemoteException
Get all addedsignal comparison rows
.- Returns:
- get attribute rows
- Throws:
java.rmi.RemoteException
- remote communication problem
-
getReferenceSuffix
java.lang.String getReferenceSuffix() throws java.rmi.RemoteException
- Returns:
- the suffix added to the reference signals.
- Throws:
java.rmi.RemoteException
- remote communication problem
-
setReferenceSuffix
void setReferenceSuffix(java.lang.String referenceSuffix) throws java.rmi.RemoteException
Changes the suffix added to the referencesignals
.- Parameters:
referenceSuffix
- the new attribute value- Throws:
java.rmi.RemoteException
- remote communication problem
-
getDifferenceToHoseSuffix
java.lang.String getDifferenceToHoseSuffix() throws java.rmi.RemoteException
- Returns:
- the suffix added to the difference to hose
signal
. - Throws:
java.rmi.RemoteException
- remote communication problem
-
setDifferenceToHoseSuffix
void setDifferenceToHoseSuffix(java.lang.String differenceToHoseSuffix) throws java.rmi.RemoteException
Changes the suffix added to the difference to hosesignal
.- Parameters:
differenceToHoseSuffix
- the new attribute value- Throws:
java.rmi.RemoteException
- remote communication problem
-
getDifferenceToReferenceSuffix
java.lang.String getDifferenceToReferenceSuffix() throws java.rmi.RemoteException
- Returns:
- the suffix added to the difference to the reference-signal
signal
. - Throws:
java.rmi.RemoteException
- remote communication problem
-
setDifferenceToReferenceSuffix
void setDifferenceToReferenceSuffix(java.lang.String differenceToReferenceSuffix) throws java.rmi.RemoteException
Changes the suffix added to the difference to the reference-signalsignal
.- Parameters:
differenceToReferenceSuffix
- the new attribute value- Throws:
java.rmi.RemoteException
- remote communication problem
-
isExportReferenceSignals
boolean isExportReferenceSignals() throws java.rmi.RemoteException
- Returns:
true
if thereference signals
are exported to the report.- Throws:
java.rmi.RemoteException
- remote communication problem
-
setExportReferenceSignals
void setExportReferenceSignals(boolean exportReferenceSignals) throws java.rmi.RemoteException
changetrue
if thereference signals
are exported to the report.- Parameters:
exportReferenceSignals
- the new attribute value- Throws:
java.rmi.RemoteException
- remote communication problem
-
isExportDifferenceToHoseSignals
boolean isExportDifferenceToHoseSignals() throws java.rmi.RemoteException
- Returns:
true
if the difference tohose signals
are exported to the report.- Throws:
java.rmi.RemoteException
- remote communication problem
-
setExportDifferenceToHoseSignals
void setExportDifferenceToHoseSignals(boolean exportDifferenceToHoseSignals) throws java.rmi.RemoteException
Change if the difference tohose signals
are exported to the report.- Parameters:
exportDifferenceToHoseSignals
- the new attribute value- Throws:
java.rmi.RemoteException
- remote communication problem
-
isExportDifferenceToReferenceSignals
boolean isExportDifferenceToReferenceSignals() throws java.rmi.RemoteException
- Returns:
true
if the difference to thereference signals
are exported to the report.- Throws:
java.rmi.RemoteException
- remote communication problem
-
setExportDifferenceToReferenceSignals
void setExportDifferenceToReferenceSignals(boolean exportDifferenceToReferenceSignals) throws java.rmi.RemoteException
Change if the difference to thereference signals
are exported to the report.- Parameters:
exportDifferenceToReferenceSignals
- the new attribute value- Throws:
java.rmi.RemoteException
- remote communication problem
-
isHighlightSelectiveSamplePoints
boolean isHighlightSelectiveSamplePoints() throws java.rmi.RemoteException
- Returns:
true
if patterns are used to highlight signals.- Throws:
java.rmi.RemoteException
- remote communication problem
-
setHighlightSelectiveSamplePoints
void setHighlightSelectiveSamplePoints(boolean usePatternsToHighlightSignals) throws java.rmi.RemoteException
Changes if patterns are used to highlight signals.- Parameters:
usePatternsToHighlightSignals
- the new attribute value- Throws:
java.rmi.RemoteException
- remote communication problem
-
isDisplayDifferenceToReference
boolean isDisplayDifferenceToReference() throws java.rmi.RemoteException
- Returns:
true
if the differenceSignal calculated by TPT.hose will not be shown but used to display, where the Assesslet fails (red background in SignalViewer). Instead an absolute Signal will be calculated and displayed.- Throws:
java.rmi.RemoteException
- remote communication problem
-
setDisplayDifferenceToReference
void setDisplayDifferenceToReference(boolean displayDifferenceToReference) throws java.rmi.RemoteException
If set to true, the differenceSignal calculated by TPT.hose will not be shown but used to display, where the Assesslet fails (red background in SignalViewer). Instead an absolute Signal will be calculated and displayed.- Parameters:
displayDifferenceToReference
- the new attribute value- Throws:
java.rmi.RemoteException
- remote communication problem
-
isIgnoreTimeBoundaries
boolean isIgnoreTimeBoundaries() throws java.rmi.RemoteException
- Returns:
true
if the time-boundaries are ignored.- Throws:
java.rmi.RemoteException
- remote communication problem
-
setIgnoreTimeBoundaries
void setIgnoreTimeBoundaries(boolean ignoreTimeBoundaries) throws java.rmi.RemoteException
Change if the time-boundaries are ignored.- Parameters:
ignoreTimeBoundaries
- the new attribute value- Throws:
java.rmi.RemoteException
- remote communication problem
-
getMappingForTolerance
Mapping getMappingForTolerance() throws java.rmi.RemoteException
- Returns:
Mapping
that is used for the tolerance.- Throws:
java.rmi.RemoteException
- remote communication problem
-
setMappingForTolerance
void setMappingForTolerance(Mapping mappingForTolerance) throws java.rmi.RemoteException
ChangeMapping
that is used for the tolerance.- Parameters:
mappingForTolerance
- the new attribute value- Throws:
java.rmi.RemoteException
- remote communication problem
-
getReferenceDataTimeShift
java.lang.String getReferenceDataTimeShift() throws java.rmi.RemoteException
- Returns:
String
that represents the reference-data-time-shift.- Throws:
java.rmi.RemoteException
- remote communication problem
-
setReferenceDataTimeShift
void setReferenceDataTimeShift(java.lang.String referenceDataTimeShift) throws java.rmi.RemoteException
ChangeString
that represents the reference-data-time-shift.- Parameters:
referenceDataTimeShift
- the new attribute value- Throws:
java.rmi.RemoteException
- remote communication problem
-
getComparisonTriggerExpression
java.lang.String getComparisonTriggerExpression() throws java.rmi.RemoteException
- Returns:
String
that represents the comparison-trigger-expression.- Throws:
java.rmi.RemoteException
- remote communication problem
-
setComparisonTriggerExpression
void setComparisonTriggerExpression(java.lang.String sampleFilterExpression) throws java.rmi.RemoteException
Change theString
that represents the comparison-trigger-expression.- Parameters:
sampleFilterExpression
- the new attribute value- Throws:
java.rmi.RemoteException
- remote communication problem
-
setReferenceToReferenceDirectory
void setReferenceToReferenceDirectory() throws java.rmi.RemoteException, ApiException
Set the reference directory of the parentExecutionConfiguration
as reference. A call togetReference()
will return theExecutionConfiguration
in this case.- Throws:
ApiException
- If the configuration is not part of the model anymore.java.rmi.RemoteException
- remote communication problem
-
setReferenceToFile
void setReferenceToFile(java.lang.String path) throws java.rmi.RemoteException
Set a reference file as reference.- Parameters:
path
- The path to the reference file.- Throws:
java.rmi.RemoteException
- remote communication problem
-
setReferenceToExecutionConfigurationItem
void setReferenceToExecutionConfigurationItem(ExecutionConfigurationItem item) throws java.rmi.RemoteException, ApiException
Set an other execution configuration item as reference.- Parameters:
item
- the execution configuration item.- Throws:
ApiException
- Ifitem
is from another model or is the same as the execution configuration item this back to back settings belong to (getExecConfigItem()
).java.rmi.RemoteException
- remote communication problem
-
getReference
java.lang.Object getReference() throws java.rmi.RemoteException
There are three types of possible references and therefore three different types of return values.- File: A path to reference file is given. The path is returned as a
String
. - Execution configuration item: An other execution configuration item is used as
reference. This
ExecutionConfigurationItem
is returned. - Reference directory: The reference directory of the execution configuration is set
as a reference. the
ExecutionConfiguration
is returned.
- Returns:
- The back to back reference of this setting.
- Throws:
java.rmi.RemoteException
- remote communication problem- See Also:
setReferenceToReferenceDirectory()
,setReferenceToFile(String)
,setReferenceToExecutionConfigurationItem(ExecutionConfigurationItem)
- File: A path to reference file is given. The path is returned as a
-
setAutoUpdate
void setAutoUpdate(Back2BackSettings.VariableType type, boolean on) throws java.rmi.RemoteException
turn on/off auto-update feature for the specifiedBack2BackSettings.VariableType
- Parameters:
type
- variable type to change the settings foron
- turn auto-update on or off- Throws:
java.rmi.RemoteException
- remote communication problem
-
isAutoUpdate
boolean isAutoUpdate(Back2BackSettings.VariableType type) throws java.rmi.RemoteException
- Parameters:
type
- type for which the current setting should be determined- Returns:
true
if auto-update is enabled fortype
.- Throws:
java.rmi.RemoteException
- remote communication problem
-
isIgnoreUndefinedPhases
boolean isIgnoreUndefinedPhases() throws java.rmi.RemoteException
- Returns:
true
if differences in a sample are ignored. Default value istrue
.- Throws:
java.rmi.RemoteException
- remote communication problem
-
setIgnoreUndefinedPhases
void setIgnoreUndefinedPhases(boolean ignoreUndefinedPhases) throws java.rmi.RemoteException
Changes if differences in a sample are ignored. Default value istrue
.- Parameters:
ignoreUndefinedPhases
- the new attribute value- Throws:
java.rmi.RemoteException
- remote communication problem
-
getExecConfigItem
ExecutionConfigurationItem getExecConfigItem() throws java.rmi.RemoteException
- Returns:
ExecutionConfigurationItem
related to thisBack2BackSettings
.- Throws:
java.rmi.RemoteException
- remote communication problem
-
-