Package com.piketec.tpt.api

Interface Back2BackSettings

    • Method Detail

      • addRow

        Back2BackRow addRow​(java.lang.String variable)
             throws java.rmi.RemoteException
        Creates and adds a signal 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 added signal comparison rows. To update the rows based on the current settings and declarations you must call updateRows() else automatically created rows are not up to date after changes to declarations or wanted variable types are made. Calling getRows() will implicitly call updateRows().
        Returns:
        get attribute rows
        Throws:
        java.rmi.RemoteException - remote communication problem
        See Also:
        updateRows()

      • updateRows

        void updateRows()
         throws java.rmi.RemoteException
        Updates the automatically created rows based on the current settings and available declarations.
        • Automatically created rows of removed decalarations will be removed
        • Automatically created rows of decalarations with no longer wanted variable type are removed
        • Not yet existing rows for declarations with wanted variable type are created
        This method must be called manually for performance reasons.
        Throws:
        java.rmi.RemoteException - remote communication problem
        See Also:
        setAutoUpdate(VariableType, boolean), getRows(), Back2BackRow.createdByAutoMode()

      • 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 reference signals.
        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 hose signal.
        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-signal signal.
        Parameters:
        differenceToReferenceSuffix - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isExportReferenceSignals

        boolean isExportReferenceSignals()
                          throws java.rmi.RemoteException
        Returns:
        true if the reference signals are exported to the report.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setExportReferenceSignals

        void setExportReferenceSignals​(boolean exportReferenceSignals)
                        throws java.rmi.RemoteException
        change true if the reference 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 to hose 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 to hose 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 the reference 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 the reference 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
        Change Mapping 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
        Change String 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 the String 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 parent ExecutionConfiguration as reference. A call to getReference() will return the ExecutionConfiguration 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 - If item 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

      • setAutoUpdate

        void setAutoUpdate​(Back2BackSettings.VariableType type,
                   boolean on)
            throws java.rmi.RemoteException
        turn on/off auto-update feature for the specified Back2BackSettings.VariableType. The method updateRows() must be called to refresh the automatically created rows aferwards.
        Parameters:
        type - variable type to change the settings for
        on - turn auto-update on or off
        Throws:
        java.rmi.RemoteException - remote communication problem
        See Also:
        updateRows()

      • 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 for type.
        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 is true.
        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 is true.
        Parameters:
        ignoreUndefinedPhases - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem