Interface FWSimFieldContainer

All Known Implementing Classes:
CacheOutputAdapter, CSVOutputAdapter, CSVResourceAdapter, DatabaseOutputAdapter, DatabaseResourceAdapter, DBFResourceAdapter, DefaultManagement, DefaultRuleTransformer, DefaultSimulationGenerator, DefaultSimulationIterator, DefaultSQLStatementTransformer, EquidistantCalSimGenerator, FWAnalyticsSimComponent, FWSimCache, FWSimComponent, FWSimComponentGroup, FWSimFieldContainerGroup, FWSimInputAdapter, FWSimIOAdapter, FWSimOutputAdapter, FWSimpleSimComponent, FWSimResourceAdapter, FWSimResourceAlias, FWSimResourceCache, FWSimResourceTransformer, FWSimResultCache, FWSimSolution, FWSimSyncAdapter, FWSimulationControlCache, FWSimulationControlContainer, FWSimulationGenerator, FWSimulationIterator, FWSimulationSelector, JSONResourceAdapter, LeastDifferenceSelector, LeastSquareSelector, NetCDFOutputAdapter, NetCDFResourceAdapter, ShrinkParameterspaceIterator, SimpleSimulationGenerator, WeightedLeastDifferenceSelector, XMLResourceAdapter

public interface FWSimFieldContainer
An object that owns simulation variables in a field map, e.g. a SimComponent, a solution or a simulation control container. The interface gives the framework and the GUI access to the variables and settings of the object.
Author:
Andreas Enders
  • Method Details

    • createVariables

      HashMap<String, FWSimVariable<?>> createVariables()
      Creates the variables of this container. Called once when the container is set up.
      Returns:
      the variables, keyed by name
    • addVariable

      void addVariable(FWSimVariable<?> aVariable)
      Adds a variable to the field map.
      Parameters:
      aVariable - the variable to add
    • getOrderNumber

      int getOrderNumber()
      Returns:
      position of this container in the order of execution
    • getVarMap

      FWSimVarMap getVarMap()
      Returns:
      the var map this container belongs to
    • getContentType

      FWSimVariable.CONTENT_TYPE getContentType()
      Returns:
      the content type of the variables of this container (e.g. sys, mgm)
    • getVariable

      FWSimVariable<?> getVariable(String aID) throws SimFieldMissingException
      Returns a variable of the field map.
      Parameters:
      aID - id of the variable
      Returns:
      the variable
      Throws:
      SimFieldMissingException - if there is no variable with this id
    • removeVariable

      void removeVariable(String aID)
      Removes a variable from the field map.
      Parameters:
      aID - id of the variable
    • getName

      String getName()
      Returns:
      the name of the container
    • getOutputVariables

      Collection<FWSimVariable<?>> getOutputVariables()
      Returns:
      the output variables of the field map
    • getInputVariables

      Collection<FWSimVariable<?>> getInputVariables()
      Returns:
      the input variables of the field map
    • getFieldMap

      HashMap<String, FWSimVariable<?>> getFieldMap()
      Returns:
      the whole field map as created in createVariables()
    • toXML

      org.jdom2.Element toXML()
      Returns:
      an XML element with all settings of this container
    • getCreateFormXML

      org.jdom2.Element getCreateFormXML()
      Returns:
      the XML form definition used by the GUI to create this container
    • getEditFormXML

      org.jdom2.Element getEditFormXML(boolean aEnabled)
      Parameters:
      aEnabled - if false, the form fields are read-only
      Returns:
      the XML form definition used by the GUI to edit the settings of this container
    • getFrequence

      FWSimIOAdapter.FREQUENCE getFrequence()
      Returns:
      the frequency in which this container is called, or null if not applicable
    • isConditionCheck

      boolean isConditionCheck()
      Returns:
      true if conditions are checked with the current check level of the session
      See Also:
    • checkCondition

      void checkCondition(Boolean aCheckResult, String aMessage)
      Checks a condition during initialisation and reports a failed check according to the check level of the session.
      Parameters:
      aCheckResult - result of the check; false means the condition is violated
      aMessage - message describing the condition
      See Also: