SeaLab CreateFeature

From LabRPS Documentation
Revision as of 20:54, 12 November 2024 by LabRPS (talk | contribs) (Created page with "{{Docnav |New Simulation |UserLab Workbench |SeaLab |IconL=SeaLab_CreateSimulation.svg |IconR=Workbench_UserLab.svg |IconC=Workbench_SeaLab.svg }} {{GuiCommand |Name=SeaLab Features |MenuLocation=SeaLab → SeaLab Features.. |Phenomena=SeaLab |SeeAlso=SeaLab tutorial }} ==Description== The SeaLab Features command allows to create new SeaLab Feature and add...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

SeaLab Features

Menu location
SeaLab → SeaLab Features..
Phenomena
SeaLab
Default shortcut
None
Introduced in version
-
See also
SeaLab tutorial

Description

The SeaLab Features command allows to create new SeaLab Feature and add it to a simulatiion.

Usage

  1. There are several ways to invoke the command:
    • Press the SeaLab CreateFeature.svg Create Feature button.
    • Select the SeaLab → SeaLab CreateFeature.svg Create Feature option from the menu.
  2. A new feature is created and added to its parent simulation.

Properties

Every SeaLab Feature has the following properties:

  • DataIsActive: Whether this feature is active or not.
  • DataAuthor: The name of the person that implements the feature.
  • DataVersion: The version of this feature.
  • DataAPIVersion: The version of the API used to implement this feature.
  • DataReleaseDate: The date when this feature has been release for the first time.
  • DataFeatureType: The feature type this feature belongs to.
  • DataFeatureGroup: The feature group this feature belongs to.
  • DataPublicationAuthor: The name of the author that publishes this feature.
  • DataPublicationTopic: The publication topic of the article in which this feature was published.
  • DataPublicationDate: The publication date of the article in which this feature was published.
  • DataLinkToPublication: The internet link to the article in which this feature was published.
  • DataPluginVersion: The version of the plugin in which the feature is implemented.
  • DataPluginName: The name of the plugin in which the feature is implemented.
  • DataSimulation: The name of the simulation where the feature is created.
  • DataIsStationary: Whether this feature is stationary or not (time dependent).
  • DataIsUniformlyModulated: Whether this feature should be uniformly modulated or not. This is useful in case of non-stationarity.

Scripting

  • Create new feature and add it to an existing simulation.
import SeaLabObjects
import LabRPS
doc = LabRPS.newDocument()
sim = SeaLabObjects.makeSimulation(doc, "MySimulation")
newFeature = SeaLabObjects.makeFeature("MyNewFeatureName", "MySimulation",  "FeatureType", "FeatureGroup")