Package io.openems.edge.app.common.props

Class ComponentProps

java.lang.Object

io.openems.edge.app.common.props.ComponentProps

public final class ComponentProps
extends Object

Static method collection for AppDefs for selecting different kinds of OpenemsComponents.

Method Summary

Modifier and Type	Method	Description
static <APP extends OpenemsApp & ComponentManagerSupplier> AppDef<APP,Nameable,Type.Parameter.BundleProvider>	pickComponentId()	Creates a AppDef for a input to select a enabled OpenemsComponent.
static <APP extends OpenemsApp & ComponentUtilSupplier, T extends OpenemsComponent> AppDef<APP,Nameable,Type.Parameter.BundleProvider>	pickComponentId(Class<T> type)	Creates a AppDef for a input to select a enabled OpenemsComponent of the given type.
static <APP extends OpenemsApp & ComponentUtilSupplier, T extends OpenemsComponent> AppDef<APP,Nameable,Type.Parameter.BundleProvider>	pickComponentId(Class<T> type, Predicate<T> filter)	Creates a AppDef for a input to select a enabled OpenemsComponent of the given type and filtered by the given filter.
static <APP extends OpenemsApp & ComponentUtilSupplier> AppDef<APP,Nameable,Type.Parameter.BundleProvider>	pickComponentId(String startingId)	Creates a AppDef for a input to select a enabled OpenemsComponent with the given starting id.
static <APP extends OpenemsApp & ComponentUtilSupplier> AppDef<APP,Nameable,Type.Parameter.BundleProvider>	pickComponentId(String startingId, Predicate<OpenemsComponent> filter)	Creates a AppDef for a input to select a enabled OpenemsComponent with the given starting id.
static <APP extends OpenemsApp & ComponentUtilSupplier> AppDef<APP,Nameable,Type.Parameter.BundleProvider>	pickElectricityGridMeterId()	Creates a AppDef for a input to select an ElectricityMeter with the MeterType MeterType.GRID.
static <APP extends OpenemsApp & ComponentUtilSupplier> AppDef<APP,Nameable,Type.Parameter.BundleProvider>	pickElectricityMeterId()	Creates a AppDef for a input to select an ElectricityMeter.
static <APP extends OpenemsApp & ComponentUtilSupplier> AppDef<APP,Nameable,Type.Parameter.BundleProvider>	pickManagedSymmetricEssId()	Creates a AppDef for a input to select a ManagedSymmetricEss.
static <APP extends OpenemsApp & ComponentUtilSupplier & AppManagerUtilSupplier> AppDef<APP,Nameable,Type.Parameter.BundleProvider>	pickModbusId()	Creates a AppDef for a input to select a OpenemsComponent with the starting id 'modbus'.
static <APP extends OpenemsApp & ComponentUtilSupplier & AppManagerUtilSupplier> AppDef<APP,Nameable,Type.Parameter.BundleProvider>	pickModbusId(Predicate<OpenemsComponent> filter)	Creates a AppDef for a input to select a OpenemsComponent with the starting id 'modbus'.
static <APP extends OpenemsApp & ComponentUtilSupplier, T extends OpenemsComponent> AppDef<APP,Nameable,Type.Parameter.BundleProvider>	pickOrderedArrayIds(Class<T> type, Predicate<T> filter, AppDef.FieldValuesFunction<APP,Nameable,Type.Parameter.BundleProvider,OpenemsComponent,ReorderArrayBuilder.SelectOptionExpressions> expressionFunction, List<AppDef.FieldValuesSupplier<APP,Nameable,Type.Parameter.BundleProvider,FormlyBuilder<?>>> additionalFieldSupplier)	Creates a AppDef for a input to select component ids with a specific order.
static <APP extends OpenemsApp> AppDef<APP,Nameable,Type.Parameter.BundleProvider>	pickOrderedArrayIds(Function<APP,List<? extends OpenemsComponent>> supplyComponents, AppDef.FieldValuesFunction<APP,Nameable,Type.Parameter.BundleProvider,OpenemsComponent,ReorderArrayBuilder.SelectOptionExpressions> expressionFunction, List<AppDef.FieldValuesSupplier<APP,Nameable,Type.Parameter.BundleProvider,FormlyBuilder<?>>> additionalFieldSupplier)	Creates a AppDef for a input to select component ids with a specific order.
static <APP extends OpenemsApp & ComponentUtilSupplier & AppManagerUtilSupplier> AppDef<APP,Nameable,Type.Parameter.BundleProvider>	pickSerialModbusId()	Creates a AppDef for a input to select a OpenemsComponent with the starting id 'modbus' and the factoryId 'Bridge.Modbus.Serial'.
static <APP extends OpenemsApp & ComponentUtilSupplier & AppManagerUtilSupplier> AppDef<APP,Nameable,Type.Parameter.BundleProvider>	pickTcpModbusId()	Creates a AppDef for a input to select a OpenemsComponent with the starting id 'modbus' and the factoryId 'Bridge.Modbus.Tcp'.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

pickComponentId

public static <APP extends OpenemsApp & ComponentManagerSupplier>
AppDef<APP,Nameable,Type.Parameter.BundleProvider> pickComponentId()

Creates a AppDef for a input to select a enabled OpenemsComponent.

Type Parameters:

APP - the type of the OpenemsApp

Returns:

the AppDef

pickComponentId

public static <APP extends OpenemsApp & ComponentUtilSupplier,
T extends OpenemsComponent>
AppDef<APP,Nameable,Type.Parameter.BundleProvider> pickComponentId(Class<T> type)

Creates a AppDef for a input to select a enabled OpenemsComponent of the given type.

Type Parameters:

APP - the type of the OpenemsApp

T - the type of the component

Parameters:

type - the type of the OpenemsComponents

Returns:

the AppDef

pickComponentId

public static <APP extends OpenemsApp & ComponentUtilSupplier,
T extends OpenemsComponent>
AppDef<APP,Nameable,Type.Parameter.BundleProvider> pickComponentId(Class<T> type,
 Predicate<T> filter)

Creates a AppDef for a input to select a enabled OpenemsComponent of the given type and filtered by the given filter.

Type Parameters:

APP - the type of the OpenemsApp

T - the type of the component

Parameters:

type - the type of the OpenemsComponents

filter - the filter of the components

Returns:

the AppDef

pickComponentId

public static <APP extends OpenemsApp & ComponentUtilSupplier>
AppDef<APP,Nameable,Type.Parameter.BundleProvider> pickComponentId(String startingId,
 Predicate<OpenemsComponent> filter)

Creates a AppDef for a input to select a enabled OpenemsComponent with the given starting id.

Type Parameters:

APP - the type of the OpenemsApp

Parameters:

startingId - the starting id of the components e. g. evcs for all evcss: evcs0, evcs1, ...

filter - the filter to apply on the component list

Returns:

the AppDef

pickComponentId

public static <APP extends OpenemsApp & ComponentUtilSupplier>
AppDef<APP,Nameable,Type.Parameter.BundleProvider> pickComponentId(String startingId)

Creates a AppDef for a input to select a enabled OpenemsComponent with the given starting id.

Type Parameters:

APP - the type of the OpenemsApp

Parameters:

startingId - the starting id of the components e. g. evcs for all evcss: evcs0, evcs1, ...

Returns:

the AppDef

pickManagedSymmetricEssId

public static <APP extends OpenemsApp & ComponentUtilSupplier>
AppDef<APP,Nameable,Type.Parameter.BundleProvider> pickManagedSymmetricEssId()

Creates a AppDef for a input to select a ManagedSymmetricEss.

Type Parameters:

APP - the type of the OpenemsApp

Returns:

the AppDef

pickElectricityMeterId

public static <APP extends OpenemsApp & ComponentUtilSupplier>
AppDef<APP,Nameable,Type.Parameter.BundleProvider> pickElectricityMeterId()

Creates a AppDef for a input to select an ElectricityMeter.

Type Parameters:

APP - the type of the OpenemsApp

Returns:

the AppDef

pickElectricityGridMeterId

public static <APP extends OpenemsApp & ComponentUtilSupplier>
AppDef<APP,Nameable,Type.Parameter.BundleProvider> pickElectricityGridMeterId()

Creates a AppDef for a input to select an ElectricityMeter with the MeterType MeterType.GRID.

Type Parameters:

APP - the type of the OpenemsApp

Returns:

the AppDef

pickModbusId

public static <APP extends OpenemsApp & ComponentUtilSupplier & AppManagerUtilSupplier>
AppDef<APP,Nameable,Type.Parameter.BundleProvider> pickModbusId(Predicate<OpenemsComponent> filter)

Creates a AppDef for a input to select a OpenemsComponent with the starting id 'modbus'.

Type Parameters:

APP - the type of the OpenemsApp

Parameters:

filter - the filter to apply on the component list

Returns:

the AppDef

pickModbusId

public static <APP extends OpenemsApp & ComponentUtilSupplier & AppManagerUtilSupplier>
AppDef<APP,Nameable,Type.Parameter.BundleProvider> pickModbusId()

Creates a AppDef for a input to select a OpenemsComponent with the starting id 'modbus'.

Type Parameters:

APP - the type of the OpenemsApp

Returns:

the AppDef

pickSerialModbusId

public static <APP extends OpenemsApp & ComponentUtilSupplier & AppManagerUtilSupplier>
AppDef<APP,Nameable,Type.Parameter.BundleProvider> pickSerialModbusId()

Creates a AppDef for a input to select a OpenemsComponent with the starting id 'modbus' and the factoryId 'Bridge.Modbus.Serial'.

Type Parameters:

APP - the type of the OpenemsApp

Returns:

the AppDef

pickTcpModbusId

public static <APP extends OpenemsApp & ComponentUtilSupplier & AppManagerUtilSupplier>
AppDef<APP,Nameable,Type.Parameter.BundleProvider> pickTcpModbusId()

Creates a AppDef for a input to select a OpenemsComponent with the starting id 'modbus' and the factoryId 'Bridge.Modbus.Tcp'.

Type Parameters:

APP - the type of the OpenemsApp

Returns:

the AppDef

pickOrderedArrayIds

public static <APP extends OpenemsApp>
AppDef<APP,Nameable,Type.Parameter.BundleProvider> pickOrderedArrayIds(Function<APP,List<? extends OpenemsComponent>> supplyComponents,
 AppDef.FieldValuesFunction<APP,Nameable,Type.Parameter.BundleProvider,OpenemsComponent,ReorderArrayBuilder.SelectOptionExpressions> expressionFunction,
 List<AppDef.FieldValuesSupplier<APP,Nameable,Type.Parameter.BundleProvider,FormlyBuilder<?>>> additionalFieldSupplier)

Creates a AppDef for a input to select component ids with a specific order. Used for e. g. in ModbusTcpApi's or EVCS Cluster.

Type Parameters:

APP - the type of the OpenemsApp

Parameters:

supplyComponents - the method to get the selectable components from

expressionFunction - the function to get the expressions of one ReorderArrayBuilder.SelectOption

additionalFieldSupplier - the additional fields which are inserted after the component selection; can be used to display additional information inside the modal

Returns:

the AppDef

pickOrderedArrayIds

public static <APP extends OpenemsApp & ComponentUtilSupplier,
T extends OpenemsComponent>
AppDef<APP,Nameable,Type.Parameter.BundleProvider> pickOrderedArrayIds(Class<T> type,
 Predicate<T> filter,
 AppDef.FieldValuesFunction<APP,Nameable,Type.Parameter.BundleProvider,OpenemsComponent,ReorderArrayBuilder.SelectOptionExpressions> expressionFunction,
 List<AppDef.FieldValuesSupplier<APP,Nameable,Type.Parameter.BundleProvider,FormlyBuilder<?>>> additionalFieldSupplier)

Creates a AppDef for a input to select component ids with a specific order. Used for e. g. in ModbusTcpApi's or EVCS Cluster.

Type Parameters:

APP - the type of the OpenemsApp

T - the type of the selectable components

Parameters:

type - the class of the selectable components

filter - the filter to apply on the component list

expressionFunction - the function to get the expressions of one ReorderArrayBuilder.SelectOption

additionalFieldSupplier - the additional fields which are inserted after the component selection; can be used to display additional information inside the modal

Returns:

the AppDef