Package io.openems.common.types

Interface OptionsEnum

All Known Subinterfaces:
IState, State<STATE>
All Known Implementing Classes:
AbstractForceChargeDischarge.State, ActivePowerControlMode, AppModeIndex, ArcSelfCheckStatus, AutoSetFunction, AutoSetFunction, AvailableState, BatteryCurrentDirection, BatteryFeneconHomeHardwareType, BatteryGroupState, BatteryGroupState, BatteryMaintenanceState, BatteryMode, BatteryProtocol, BatteryStatus, BatteryStringSwitchState, BatteryStringWorkState, BatteryWorkState, Baudrate, BlackStartMode, BmsDcdcWorkMode, BmsDcdcWorkState, BmsProtocolSelection, BmsState, BmsStateCommand, BsmuWorkState, CableState, CableState, CcuState, ChargeIndication, ChargeMode, ChargePointState, ChargePointState, ChargeState, ChargeState, ChargingType, ClusterRunState, ClusterRunState, ClusterRunState, ClusterStartStop, ComMode, Conn, ContactExport, ContactorControl, ContactorControl, ContactorControl, ContactorState, ControlMode, ControlMode, ControlMode, CpldWarningCode, CpuType, Currency, DcVoltageLevel, DebugRunState, DefaultSunSpecModel.S101_Evt1, DefaultSunSpecModel.S101_St, DefaultSunSpecModel.S102_Evt1, DefaultSunSpecModel.S102_St, DefaultSunSpecModel.S103_Evt1, DefaultSunSpecModel.S103_St, DefaultSunSpecModel.S111_Evt1, DefaultSunSpecModel.S111_St, DefaultSunSpecModel.S112_Evt1, DefaultSunSpecModel.S112_St, DefaultSunSpecModel.S113_Evt1, DefaultSunSpecModel.S113_St, DefaultSunSpecModel.S120_DERTyp, DefaultSunSpecModel.S121_ClcTotVA, DefaultSunSpecModel.S121_ConnPh, DefaultSunSpecModel.S121_VArAct, DefaultSunSpecModel.S122_ECPConn, DefaultSunSpecModel.S122_PVConn, DefaultSunSpecModel.S122_RtSt, DefaultSunSpecModel.S122_StActCtl, DefaultSunSpecModel.S122_StorConn, DefaultSunSpecModel.S122_StSetLimMsk, DefaultSunSpecModel.S123_Conn, DefaultSunSpecModel.S123_OutPFSet_Ena, DefaultSunSpecModel.S123_VArPct_Ena, DefaultSunSpecModel.S123_VArPct_Mod, DefaultSunSpecModel.S123_WMaxLim_Ena, DefaultSunSpecModel.S124_ChaGriSet, DefaultSunSpecModel.S124_ChaSt, DefaultSunSpecModel.S124_StorCtl_Mod, DefaultSunSpecModel.S125_ModEna, DefaultSunSpecModel.S125_SigType, DefaultSunSpecModel.S127_HysEna, DefaultSunSpecModel.S127_ModEna, DefaultSunSpecModel.S128_ArGraMod, DefaultSunSpecModel.S128_ModEna, DefaultSunSpecModel.S2_Ctl, DefaultSunSpecModel.S2_Evt, DefaultSunSpecModel.S2_St, DefaultSunSpecModel.S201_Evt, DefaultSunSpecModel.S202_Evt, DefaultSunSpecModel.S203_Evt, DefaultSunSpecModel.S204_Evt, DefaultSunSpecModel.S64110_Alarm_email_en, DefaultSunSpecModel.S64110_Log_mode, DefaultSunSpecModel.S64110_NTP_enable, DefaultSunSpecModel.S64110_SMTP_enable_SSL, DefaultSunSpecModel.S64111_ChargerSt, DefaultSunSpecModel.S64112_CC_Config_auto_restart, DefaultSunSpecModel.S64112_CC_Config_AUX_control, DefaultSunSpecModel.S64112_CC_Config_AUX_mode, DefaultSunSpecModel.S64112_CC_Config_AUX_polarity, DefaultSunSpecModel.S64112_CC_Config_AUX_state, DefaultSunSpecModel.S64112_CC_Config_grid_tie, DefaultSunSpecModel.S64112_CC_Config_MPPT_mode, DefaultSunSpecModel.S64112_CC_Config_sweep_max, DefaultSunSpecModel.S64112_CC_Config_sweep_width, DefaultSunSpecModel.S64112_CC_Config_temp_comp, DefaultSunSpecModel.S701_ACType, DefaultSunSpecModel.S701_Alrm, DefaultSunSpecModel.S701_ConnSt, DefaultSunSpecModel.S701_DERMode, DefaultSunSpecModel.S701_InvSt, DefaultSunSpecModel.S701_St, DefaultSunSpecModel.S701_ThrotSrc, DefaultSunSpecModel.S702_AbnOpCatRtg, DefaultSunSpecModel.S702_CtrlModes, DefaultSunSpecModel.S702_IntIslandCat, DefaultSunSpecModel.S702_IntIslandCatRtg, DefaultSunSpecModel.S702_NorOpCatRtg, DefaultSunSpecModel.S703_ES, DefaultSunSpecModel.S704_AntiIslEna, DefaultSunSpecModel.S704_PFWAbsEna, DefaultSunSpecModel.S704_PFWAbsEnaRvrt, DefaultSunSpecModel.S704_PFWInjEna, DefaultSunSpecModel.S704_PFWInjEnaRvrt, DefaultSunSpecModel.S704_VarSetEna, DefaultSunSpecModel.S704_VarSetEnaRvrt, DefaultSunSpecModel.S704_VarSetMod, DefaultSunSpecModel.S704_VarSetPri, DefaultSunSpecModel.S704_WMaxLimPctEna, DefaultSunSpecModel.S704_WMaxLimPctEnaRvrt, DefaultSunSpecModel.S704_WRmpRef, DefaultSunSpecModel.S704_WSetEna, DefaultSunSpecModel.S704_WSetEnaRvrt, DefaultSunSpecModel.S704_WSetMod, DefaultSunSpecModel.S705_AdptCrvRslt, DefaultSunSpecModel.S705_Ena, DefaultSunSpecModel.S706_AdptCrvRslt, DefaultSunSpecModel.S706_Ena, DefaultSunSpecModel.S707_AdptCrvRslt, DefaultSunSpecModel.S707_Ena, DefaultSunSpecModel.S708_AdptCrvRslt, DefaultSunSpecModel.S708_Ena, DefaultSunSpecModel.S709_AdptCrvRslt, DefaultSunSpecModel.S709_Ena, DefaultSunSpecModel.S710_AdptCrvRslt, DefaultSunSpecModel.S710_Ena, DefaultSunSpecModel.S711_AdptCtlRslt, DefaultSunSpecModel.S711_Ena, DefaultSunSpecModel.S712_AdptCrvRslt, DefaultSunSpecModel.S712_Ena, DefaultSunSpecModel.S713_Sta, DefaultSunSpecModel.S715_LocRemCtl, DefaultSunSpecModel.S715_OpCtl, DefaultSunSpecModel.S802_ChaSt, DefaultSunSpecModel.S802_Evt1, DefaultSunSpecModel.S802_LocRemCtl, DefaultSunSpecModel.S802_ReqInvState, DefaultSunSpecModel.S802_SetInvState, DefaultSunSpecModel.S802_SetOp, DefaultSunSpecModel.S802_State, DefaultSunSpecModel.S802_Typ, DelayChargeState, DerTyp, DredCmd, DredOffgridCheck, DummyOptionsEnum, EhBatteryFunctionActive, EmsBaudrate, EmsCheck, EmsPowerMode, EnableCurve, Enums.ClusterRunState, Epo, ErrorBits1, ErrorBits2, ErrorCode, Errors, EvcsClusterStatus, Event1, EvseErrorCode, EvseState, EvseState, ExternalEmsFlag, EzloggerProCommStatus, FanStatus, FeedInPowerSettings.FixedPowerFactor, FrequencyVariationRate, GoodWeGridMeterType, GoodWeType, GridconState, GridMode, GridProtect, GridType, GridWaveCheckLevel, InfoBits, InterfaceType, InverterState, InverterStatus, KacoSunSpecModel.S64201.S64201ControlMode, KacoSunSpecModel.S64201.S64201CurrentState, KacoSunSpecModel.S64201.S64201ErrPcu, KacoSunSpecModel.S64201.S64201RequestedState, KacoSunSpecModel.S64201.S64201StPcu, KacoSunSpecModel.S64201.S64201StPu, KacoSunSpecModel.S64201.S64201StVnd, KacoSunSpecModel.S64201.S64201VarParamEna, KacoSunSpecModel.S64201.S64201WParamEna, KacoSunSpecModel.S64202.S64202EnLimit, KacoSunSpecModel.S64203.S64203EmsErrCode, KacoSunSpecModel.S64204.S64204OffsetEna, LedState, Level, Level, LoadMode, LoadRegulationIndex, LocRemCtl, MeterCommunicateStatus, MeterConnectCheckFlag, Mode, Mode, Mode, ModulePowerLevel, MpptShadowScanEnable, OnGridState, OnOffGridState, OperatingModeForActivePowerLimitation, OperatingState, OperationHealth, OperationMode, OperationMode, OutPfSetEna, OutputTypeAC, PControlMode, PcsMode, PcsMode, PcsOperationState, PcsSetOperation, PhaseAngleAbrupt, Phases, PLimitType, Plug, PowerCircuitControl, PowerManagementConfiguration, PowerRisingMode, PowerSupplyStatus, PreChargeControl, PreContactorState, Priority, ProtocolSelection, PvMode, RackUsage, ReactivePowerControlMode, RotationField, RunningState, SafetyCountry, SelectedConnector, SellToGridLimitState, SetControlMode, SetSystemWorkstate, SetupMode, SetupMode, SetWorkState, SetWorkState, SetWorkState, ShortCircuitFunction, SinexcelGridMode, SinexcelState, SinglePhaseMode, Sleep, SolverStrategy, StableVersion, StackChargeState, StartCancelChargingSession, StartMode, StartStop, State, State, State, State, State, State, State, State, State, State, StateMachine, StateMachine.OffGridState, StateMachine.State, StateMachine.State, StateMachine.State, StateMachine.State, StateMachine.State, StateMachine.State, StateMachine.State, StateMachine.State, StateMachine.State, StateMachine.State, StateMachine.State, StateMachine.State, StateMachine.State, StateMachine.State, StateMachine.State, Status, Status, Status, Status, StatusIpuStateMachine, StatusIpuStatusMcu, SurplusFeedInStateMachine, Switch, SystemManufacturer, SystemReset, SystemRunMode, SystemState, SystemState, SystemState, SystemState, SystemState, SystemType, SystemWorkmode, SystemWorkstate, TemperaturePosition, UpsStandartVoltType, VArPctEna, VectisStatus, VendorOperatingState, WarningBits1, WarningBits2, WifiOrLan, WMaxLimEna, WorkMode, WorkMode, WorkWeek, ZvrtConfig
public interface OptionsEnum

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    asCamelCase()
    Gets the name in CamelCase format.
    String
    getName()
    Gets this enums String representation.
    static <T extends Enum<T> & OptionsEnum>
    T
    getOption(Class<T> enumClass, int value)
    Gets the Option value from a value or null (not UNDEFINED!).
    static <T extends Enum<T> & OptionsEnum>
    T
    getOptionOrUndefined(Class<T> enumClass, int value)
    Gets the Option value from a value.
    OptionsEnum
    getUndefined()
    Gets the enum that is used for 'UNDEFINED' values.
    int
    getValue()
    Gets this enums int representation.
    default boolean
    isUndefined()
    Gets whether the current enum represents the 'UNDEFINED' value.

  • Method Details

    • getValue

      int getValue()
      Gets this enums int representation.
      Returns:
      the int representation

    • getName

      String getName()
      Gets this enums String representation.
      Returns:
      the String representation

    • getUndefined

      OptionsEnum getUndefined()
      Gets the enum that is used for 'UNDEFINED' values.
      Returns:
      the UNDEFINED enum

    • asCamelCase

      default String asCamelCase()
      Gets the name in CamelCase format.

      If getName() returns 'MY_VALUE' this method returns 'MyValue'.

      Returns:
      the Name in CamelCase format

    • isUndefined

      default boolean isUndefined()
      Gets whether the current enum represents the 'UNDEFINED' value.
      Returns:
      true if this is the UNDEFINED enum

    • getOption

      static <T extends Enum<T> & OptionsEnum> T getOption(Class<T> enumClass, int value)
      Gets the Option value from a value or null (not UNDEFINED!).
      Type Parameters:
      T - OptionsEnum
      Parameters:
      enumClass - the enum class
      value - the value of the Option
      Returns:
      the enum value or null

    • getOptionOrUndefined

      static <T extends Enum<T> & OptionsEnum> T getOptionOrUndefined(Class<T> enumClass, int value)
      Gets the Option value from a value.
      Type Parameters:
      T - OptionsEnum
      Parameters:
      enumClass - the enum class
      value - the value of the Option
      Returns:
      the enum value or getUndefined