parameters

InputParameters describe different types of input parameters for the model. All parameters for a model are contained in a hierarchical map where successive keys can be retrieved using a dot-notation between the key elements.

Example

Suppose a model has two servers: server1 and server2. Each of the servers has an average service time and a number of resources. This can be codes using keys ‘server1.avg_serice_time’, ‘server1.nr_resources’, ‘server2.avg_serice_time’, ‘server2.nr_resources’. This means that the key ‘server1’ contains an InputParameterMap with an instance of InputParameterFloat for the service time, and InputParameterInt for the number of resources. Readers for the input parameter map can read the model parameters, e.g., from the screen, a web page, an Excel file, a properties file, or a JSON file.

Click below for the API of a specific input parameter type.

Classes

• InputParameter
  • InputParameter
    • InputParameter.__init__()
    • InputParameter.key
    • InputParameter.extended_key()
    • InputParameter.name
    • InputParameter.description
    • InputParameter.default_value
    • InputParameter.value
    • InputParameter.set_value()
    • InputParameter.display_priority
    • InputParameter.read_only
    • InputParameter.parent
• InputParameterMap
  • InputParameterMap
    • InputParameterMap.__init__()
    • InputParameterMap.value
    • InputParameterMap.set_value()
    • InputParameterMap.add()
    • InputParameterMap.get()
    • InputParameterMap.remove()
    • InputParameterMap.print_values()
    • InputParameterMap.default_value
    • InputParameterMap.description
    • InputParameterMap.display_priority
    • InputParameterMap.extended_key()
    • InputParameterMap.key
    • InputParameterMap.name
    • InputParameterMap.parent
    • InputParameterMap.read_only
• InputParameterInt
  • InputParameterInt
    • InputParameterInt.__init__()
    • InputParameterInt.value
    • InputParameterInt.min_value
    • InputParameterInt.max_value
    • InputParameterInt.format_str
    • InputParameterInt.set_value()
    • InputParameterInt.default_value
    • InputParameterInt.description
    • InputParameterInt.display_priority
    • InputParameterInt.extended_key()
    • InputParameterInt.key
    • InputParameterInt.name
    • InputParameterInt.parent
    • InputParameterInt.read_only
• InputParameterFloat
  • InputParameterFloat
    • InputParameterFloat.__init__()
    • InputParameterFloat.value
    • InputParameterFloat.min_value
    • InputParameterFloat.max_value
    • InputParameterFloat.format_str
    • InputParameterFloat.set_value()
    • InputParameterFloat.default_value
    • InputParameterFloat.description
    • InputParameterFloat.display_priority
    • InputParameterFloat.extended_key()
    • InputParameterFloat.key
    • InputParameterFloat.name
    • InputParameterFloat.parent
    • InputParameterFloat.read_only
• InputParameterStr
  • InputParameterStr
    • InputParameterStr.__init__()
    • InputParameterStr.value
    • InputParameterStr.set_value()
    • InputParameterStr.default_value
    • InputParameterStr.description
    • InputParameterStr.display_priority
    • InputParameterStr.extended_key()
    • InputParameterStr.key
    • InputParameterStr.name
    • InputParameterStr.parent
    • InputParameterStr.read_only
• InputParameterBool
  • InputParameterBool
    • InputParameterBool.__init__()
    • InputParameterBool.value
    • InputParameterBool.set_value()
    • InputParameterBool.default_value
    • InputParameterBool.description
    • InputParameterBool.display_priority
    • InputParameterBool.extended_key()
    • InputParameterBool.key
    • InputParameterBool.name
    • InputParameterBool.parent
    • InputParameterBool.read_only
• InputParameterQuantity
  • InputParameterQuantity
    • InputParameterQuantity.__init__()
    • InputParameterQuantity.value
    • InputParameterQuantity.min_si
    • InputParameterQuantity.max_si
    • InputParameterQuantity.format_str
    • InputParameterQuantity.type
    • InputParameterQuantity.set_value()
    • InputParameterQuantity.default_value
    • InputParameterQuantity.description
    • InputParameterQuantity.display_priority
    • InputParameterQuantity.extended_key()
    • InputParameterQuantity.key
    • InputParameterQuantity.name
    • InputParameterQuantity.parent
    • InputParameterQuantity.read_only
• InputParameterSelectionList
  • InputParameterSelectionList
    • InputParameterSelectionList.__init__()
    • InputParameterSelectionList.value
    • InputParameterSelectionList.options
    • InputParameterSelectionList.set_value()
    • InputParameterSelectionList.default_value
    • InputParameterSelectionList.description
    • InputParameterSelectionList.display_priority
    • InputParameterSelectionList.extended_key()
    • InputParameterSelectionList.key
    • InputParameterSelectionList.name
    • InputParameterSelectionList.parent
    • InputParameterSelectionList.read_only
• InputParameterUnit
  • InputParameterUnit
    • InputParameterUnit.__init__()
    • InputParameterUnit.default_value
    • InputParameterUnit.description
    • InputParameterUnit.display_priority
    • InputParameterUnit.extended_key()
    • InputParameterUnit.key
    • InputParameterUnit.name
    • InputParameterUnit.options
    • InputParameterUnit.parent
    • InputParameterUnit.read_only
    • InputParameterUnit.set_value()
    • InputParameterUnit.unittype
    • InputParameterUnit.value