Package com.comsol.model

Interface Results

    • Method Detail

      • clear

        void clear()
        Remove all entities in the list.

      • clearStoredPlotData

        void clearStoredPlotData()
        Clears the plot data stored in plot features (plot groups, plots, and plot attributes).

      • colorTable

        ColorTableFeatureList colorTable()
        Get the list of color table features.
        Returns:
        Color table feature list.

      • colorTable

        ColorTableFeature colorTable​(java.lang.String tag)
        Gets a color table feature with a given tag.
        Parameters:
        tag - Gets a color table feature with a given tag.
        Returns:
        Color table feature.

      • configuration

        ConfigurationFeatureList configuration()
        Get the list of configuration features.
        Returns:
        Configuration feature list.

      • configuration

        ConfigurationFeature configuration​(java.lang.String tag)
        Gets a configuration feature with a given tag.
        Parameters:
        tag - Gets a configuration feature with a given tag.
        Returns:
        Configuration.

      • copy

        ResultFeature copy​(java.lang.String newTag,
                   java.lang.String tag)
        Creates a copy of a feature in the list.
        Parameters:
        newTag - The tag of the new feature.
        tag - The tag of the feature to copy.
        Returns:
        The feature copy.

      • create

        ResultFeature create​(java.lang.String tag,
                     java.lang.String type)
        Create a result feature of a certain type.
        Parameters:
        tag - Result feature tag.
        type - Result feature type.
        Returns:
        Created result feature.

      • create

        ResultFeature create​(java.lang.String tag,
                     int dimension)
        Creates a plot group, of a certain dimension.
        Parameters:
        tag - Plot group tag.
        dimension - Plot group dimension (1, 2, or 3).
        Returns:
        Created plot group.

      • dataset

        DatasetFeatureList dataset()
        Gets the dataset feature list.
        Returns:
        Dataset feature list.

      • dataset

        DatasetFeature dataset​(java.lang.String tag)
        Gets a dataset feature with a given tag.
        Parameters:
        tag - Dataset feature tag.
        Returns:
        Dataset feature.

      • duplicate

        ResultFeature duplicate​(java.lang.String newTag,
                        java.lang.String tag)
        Creates a new feature in the list with the same settings as the original. Returns the new feature.
        Parameters:
        newTag - Tag of new feature.
        tag - Tag of duplicated feature.
        Returns:
        Duplicated feature.

      • evaluationGroup

        EvaluationGroupFeature evaluationGroup​(java.lang.String tag)
        Gets an evaluation group feature with a given tag.
        Parameters:
        tag - Evaluation group feature tag.
        Returns:
        Evaluation group feature.

      • export

        ExportFeatureList export()
        Gets an export feature list.
        Returns:
        Export feature list.

      • export

        ExportFeature export​(java.lang.String tag)
        Gets an export feature with a given tag.
        Parameters:
        tag - Gets an export feature with a given tag.
        Returns:
        Export feature.

      • get

        ResultFeature get​(java.lang.String tag)
        Gets a feature in the list with a given tag.
        Parameters:
        tag - Result feature tag.
        Returns:
        Requested result feature.

      • hasTag

        boolean hasTag​(java.lang.String tag)
        Returns true if the list has a plot group with the given tag.
        Parameters:
        tag - Tag to check.
        Returns:
        True if there is such a plot group.

      • insert

        java.lang.String[][] insert​(java.lang.String filename,
                            java.lang.String[] features,
                            java.lang.String... password)
        Insert result features from an mph file into the result list of this model and returns the result of the operation as a double string array of length 3.
        The first array contains the messages from insert, the second array contains paths to the inserted objects, and the third array contains paths to the inserted references. A pasted reference is an object that an inserted object refers to, and isn't necessarily contained by any of the inserted objects.
        Parameters:
        filename - The filename.
        features - The tags of the result features to insert.
        password - Optional password for opening the file.
        Returns:
        Results from the insert operation.

      • isOnlyPlotWhenRequested

        boolean isOnlyPlotWhenRequested()
        Returns true if plots selected in the Model Builder only should be updated when the user explicitly requests it.
        Returns:
        true if updating a plot requires a user action.

      • numerical

        NumericalFeatureList numerical()
        Gets a numerical feature list.
        Returns:
        Numerical feature list.

      • numerical

        NumericalFeature numerical​(java.lang.String tag)
        Gets a numerical feature with a given tag.
        Parameters:
        tag - Numerical feature tag.
        Returns:
        Numerical feature.

      • param

        ResultParam param()
        Returns the parameters.
        Returns:
        Parameters.

      • remove

        void remove​(java.lang.String tag)
        Remove a plot group with a given tag.
        Parameters:
        tag - Plot group tag.

      • report

        ReportFeatureList report()
        Gets a report feature list.
        Returns:
        Report feature list.

      • report

        ReportFeature report​(java.lang.String tag)
        Gets a report feature with a given tag.
        Parameters:
        tag - Report feature tag.
        Returns:
        Report feature.

      • setOnlyPlotWhenRequested

        void setOnlyPlotWhenRequested​(boolean value)
        Set if plots selected in the Model Builder only should be updated when the user explicitly requests it.
        Parameters:
        value - true if updating a plot should require a user action.

      • size

        int size()
        Determines the number of plot groups.
        Returns:
        Number of plot groups.

      • table

        TableFeatureList table()
        Get the list of table features.
        Returns:
        List of table features.

      • table

        TableFeature table​(java.lang.String tag)
        Get the table feature with a given tag.
        Parameters:
        tag - Table feature tag.
        Returns:
        Table feature.

      • tags

        java.lang.String[] tags()
        Returns the tags of all result features.
        Returns:
        List of tags.

      • uniquetag

        java.lang.String uniquetag​(java.lang.String tag)
        Returns a unique tag in the list context.
        Parameters:
        tag - The base for the unique tag.
        Returns:
        A unique tag.