Package io.openems.edge.common.cycle

Interface Cycle

All Superinterfaces:

OpenemsComponent

All Known Implementing Classes:

CycleImpl, DummyCycle

public interface Cycle
extends OpenemsComponent

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Cycle.ChannelId

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_CYCLE_TIME
static final String	SINGLETON_COMPONENT_ID
static final String	SINGLETON_SERVICE_PID

Method Summary

Modifier and Type	Method	Description
default void	_setIgnoreDisabledController(boolean value)	Internal method to set the 'nextValue' on Cycle.ChannelId.IGNORE_DISABLED_CONTROLLER Channel.
default void	_setMeasuredCycleTime(long value)	Internal method to set the 'nextValue' on Cycle.ChannelId.MEASURED_CYCLE_TIME Channel.
default void	_setMeasuredCycleTime(Long value)	Internal method to set the 'nextValue' on Cycle.ChannelId.MEASURED_CYCLE_TIME Channel.
int	getCycleTime()	Gets the duration of one global OpenEMS Cycle in [ms].
default Value<Boolean>	getIgnoreDisabledController()	Gets the Ignore Disabled Controller Info State.
default StateChannel	getIgnoreDisabledControllerChannel()	Gets the Channel for Cycle.ChannelId.IGNORE_DISABLED_CONTROLLER.
default Value<Long>	getMeasuredCycleTime()	Gets the Measured Cycle Time in [ms].
default LongReadChannel	getMeasuredCycleTimeChannel()	Gets the Channel for Cycle.ChannelId.MEASURED_CYCLE_TIME.

Methods inherited from interface io.openems.edge.common.component.OpenemsComponent

_channel, _getChannelAs, alias, channel, channel, channels, debugLog, getComponentContext, getState, getStateChannel, hasFaults, id, isEnabled, serviceFactoryPid, servicePid

Field Details

SINGLETON_SERVICE_PID

static final String SINGLETON_SERVICE_PID

See Also:

• Constant Field Values

SINGLETON_COMPONENT_ID

static final String SINGLETON_COMPONENT_ID

See Also:

• Constant Field Values

DEFAULT_CYCLE_TIME

static final int DEFAULT_CYCLE_TIME

See Also:

• Constant Field Values

Method Details

getMeasuredCycleTimeChannel

default LongReadChannel getMeasuredCycleTimeChannel()

Gets the Channel for Cycle.ChannelId.MEASURED_CYCLE_TIME.

Returns:

the Channel

getMeasuredCycleTime

default Value<Long> getMeasuredCycleTime()

Gets the Measured Cycle Time in [ms]. See Cycle.ChannelId.MEASURED_CYCLE_TIME.

Returns:

the Channel Value

_setMeasuredCycleTime

default void _setMeasuredCycleTime(Long value)

Internal method to set the 'nextValue' on Cycle.ChannelId.MEASURED_CYCLE_TIME Channel.

Parameters:

value - the next value

_setMeasuredCycleTime

default void _setMeasuredCycleTime(long value)

Internal method to set the 'nextValue' on Cycle.ChannelId.MEASURED_CYCLE_TIME Channel.

Parameters:

value - the next value

getIgnoreDisabledControllerChannel

default StateChannel getIgnoreDisabledControllerChannel()

Gets the Channel for Cycle.ChannelId.IGNORE_DISABLED_CONTROLLER.

Returns:

the Channel

getIgnoreDisabledController

default Value<Boolean> getIgnoreDisabledController()

Gets the Ignore Disabled Controller Info State. See Cycle.ChannelId.IGNORE_DISABLED_CONTROLLER.

Returns:

the Channel Value

_setIgnoreDisabledController

default void _setIgnoreDisabledController(boolean value)

Internal method to set the 'nextValue' on Cycle.ChannelId.IGNORE_DISABLED_CONTROLLER Channel.

Parameters:

value - the next value

getCycleTime

int getCycleTime()

Gets the duration of one global OpenEMS Cycle in [ms].

Returns:

the duration in milliseconds