org.ogema.channelmapperv2

Interface ChannelMapper

All Known Implementing Classes:

ChannelMapperImpl

public interface ChannelMapper

A generic high-level driver for OGEMA. It is responsible for mapping OGEMA resource elements to channels of the ChannelAPI.

Method Summary

Modifier and Type	Method and Description
void	mapChannelToResource(org.ogema.core.channelmanager.driverspi.ChannelLocator channel, org.ogema.core.model.simple.SingleValueResource target, org.ogema.core.channelmanager.ChannelConfiguration.Direction direction, long samplingPeriod, float scalingFactor, float valueOffset) Map a channel to a resource element.
void	unmapChannel(org.ogema.core.channelmanager.driverspi.ChannelLocator channel) Unmap a channel.
void	unmapChannel(org.ogema.core.channelmanager.driverspi.ChannelLocator channel, org.ogema.core.model.simple.SingleValueResource target) Unmap a channel.

Method Detail

mapChannelToResource

void mapChannelToResource(org.ogema.core.channelmanager.driverspi.ChannelLocator channel,
                          org.ogema.core.model.simple.SingleValueResource target,
                          org.ogema.core.channelmanager.ChannelConfiguration.Direction direction,
                          long samplingPeriod,
                          float scalingFactor,
                          float valueOffset)

Map a channel to a resource element. Connects a measurement or control channel to a resource. The connection (mapping) is persistently stored until the unmapChannel method is called for the channel.

Parameters:

channel -

target -

direction -

samplingPeriod -

scalingFactor -

valueOffset -

unmapChannel

void unmapChannel(org.ogema.core.channelmanager.driverspi.ChannelLocator channel)

Unmap a channel. Remove all connections from the specified channel to OGEMA resources.

Parameters:

channel - the channel to be unmapped.

unmapChannel

void unmapChannel(org.ogema.core.channelmanager.driverspi.ChannelLocator channel,
                  org.ogema.core.model.simple.SingleValueResource target)

Unmap a channel. Remove a single connection from the specified channel to an OGEMA resource.

Parameters:

channel - the channel to be unmapped

target -