org.ogema.channelmapperv2.config

Interface ChannelMapperConfiguration

All Superinterfaces:

org.ogema.model.prototypes.Configuration, org.ogema.core.model.Resource

public interface ChannelMapperConfiguration
extends org.ogema.model.prototypes.Configuration

Method Summary

Modifier and Type	Method and Description
PersistentChannelLocator	channelLocator() The channel identifier.
org.ogema.core.model.simple.StringResource	description() Optional.
org.ogema.core.model.simple.StringResource	direction() Admissible values: INPUT read channel value and write it to the target resource OUTPUT write resource value to channel INOUT read from and write to channel
org.ogema.core.model.simple.BooleanResource	registrationSuccessful() Indicates whether the channel mapping has been successful, or is still pending.
org.ogema.core.model.simple.TimeResource	samplingInterval() In ms.
org.ogema.core.model.simple.FloatResource	scalingFactor() Scaling factor between channel value and resource value (resource value = channel value * scalingFactor + valueOffset)
org.ogema.core.model.simple.SingleValueResource	target() Must be a reference
org.ogema.core.model.simple.FloatResource	valueOffset() Offset between channel value and resource value (resource value = channel value * scalingFactor + valueOffset)

Methods inherited from interface org.ogema.model.prototypes.Configuration

name

Methods inherited from interface org.ogema.core.model.Resource

activate, addAccessModeListener, addDecorator, addDecorator, addOptionalElement, addResourceListener, addStructureListener, addValueListener, addValueListener, create, deactivate, delete, deleteElement, equalsLocation, equalsPath, exists, getAccessMode, getAccessPriority, getDirectSubResources, getLocation, getLocation, getLocationResource, getName, getParent, getPath, getPath, getReferencingNodes, getReferencingResources, getResourceType, getSubResource, getSubResource, getSubResources, getSubResources, isActive, isDecorator, isReference, isTopLevel, isWriteable, removeAccessModeListener, removeResourceListener, removeStructureListener, removeValueListener, requestAccessMode, setAsReference, setOptionalElement

Method Detail

target

org.ogema.core.model.simple.SingleValueResource target()

Must be a reference

Returns:

channelLocator

PersistentChannelLocator channelLocator()

The channel identifier.

Returns:

See Also:

ChannelLocator

direction

org.ogema.core.model.simple.StringResource direction()

Admissible values:

• INPUT read channel value and write it to the target resource
• OUTPUT write resource value to channel
• INOUT read from and write to channel

Returns:

See Also:

ChannelConfiguration.Direction

samplingInterval

org.ogema.core.model.simple.TimeResource samplingInterval()

In ms. Only relevant for direction INPUT and INOUT.

Returns:

scalingFactor

org.ogema.core.model.simple.FloatResource scalingFactor()

Scaling factor between channel value and resource value (resource value = channel value * scalingFactor + valueOffset)

Returns:

valueOffset

org.ogema.core.model.simple.FloatResource valueOffset()

Offset between channel value and resource value (resource value = channel value * scalingFactor + valueOffset)

Returns:

description

org.ogema.core.model.simple.StringResource description()

Optional. A human-readable description of the value.

Returns:

registrationSuccessful

org.ogema.core.model.simple.BooleanResource registrationSuccessful()

Indicates whether the channel mapping has been successful, or is still pending.

Returns: