Package net.simplace.sim.util

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, NetCDFResourceCache, ShrinkParameterspaceIterator, SimpleSimulationGenerator, WeightedLeastDifferenceSelector, XMLResourceAdapter
public interface FWSimFieldContainer
Interface for the GUI to get necessary information about the component
Author:
Andreas Enders

  • Method Details

    • createVariables

      HashMap<String,FWSimVariable<?>> createVariables()
      Returns:
      variables from the field map

    • addVariable

      void addVariable(FWSimVariable<?> aVariable)
      Parameters:
      aVariable -

    • getOrderNumber

      int getOrderNumber()
      Returns:
      number in the order of Components

    • getVarMap

      FWSimVarMap getVarMap()
      Returns:
      number in the order of Components

    • getContentType

      FWSimVariable.CONTENT_TYPE getContentType()
      Returns:
      number in the order of Components

    • getVariable

      FWSimVariable<?> getVariable(String aID) throws SimFieldMissingException
      Parameters:
      aID -
      Returns:
      FWSimVariable for ID in Field Map
      Throws:
      SimFieldMissingException

    • removeVariable

      void removeVariable(String aID)
      Parameters:
      aID -

    • getName

      String getName()
      Returns:
      the Name of the component

    • getOutputVariables

      Collection<FWSimVariable<?>> getOutputVariables()
      Returns:
      FWSimVarables filtered - only output Variables

    • getInputVariables

      Collection<FWSimVariable<?>> getInputVariables()
      Returns:
      FWSimVarables filtered - only input Variables

    • getFieldMap

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

    • toXML

      org.jdom2.Element toXML()
      Returns:
      a xml element with all the settings of this component()

    • getCreateFormXML

      org.jdom2.Element getCreateFormXML()
      Returns:
      a xml element with all the settings of this component()

    • getEditFormXML

      org.jdom2.Element getEditFormXML(boolean aEnabled)
      Parameters:
      aEnabled -
      Returns:
      a xml element with all the settings of this component()

    • getFrequence

      FWSimIOAdapter.FREQUENCE getFrequence()
      Returns:
      the Frequence of the Container calling

    • isConditionCheck

      boolean isConditionCheck()

    • checkCondition

      void checkCondition(Boolean aCheckResult, String aMessage)
      Called from inside the FWSimFieldContainer to log the initialization Errors.
      Parameters:
      aCheckResult -
      aMessage -
      aInstance -