org.eclipse.soda.dk.parameter
Class BitOffsetParameter

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.parameter.Parameter
          org.eclipse.soda.dk.parameter.BitOffsetParameter

All Implemented Interfaces:

DataParameterService, ParameterService

Direct Known Subclasses:

ByteOffsetParameter

public class BitOffsetParameter
extends Parameter

The OffsetParameter class implements the ParameterService interface.

Version:

1.0.0

See Also:

Parameter, ParameterService

Field Summary

static int[]

MASKS Define the masks (int) constant.

Fields inherited from class org.eclipse.soda.dk.parameter.Parameter

SET_MASKS, SET_TOP_MASKS

Fields inherited from class org.eclipse.soda.dk.core.EscObject

CLONE_EXCEPTION_RESOURCE, EMPTY_BYTES, EMPTY_STRING, ERROR_OCCURRED_EXCEPTION_RESOURCE, ID_FILTER_KEY, ID_KEY, ID_KEY_ANY, INTEGER_TABLE, KEY_KEY, LOG_DEBUG, LOG_ERROR, LOG_INFO, LOG_TRACE, LOG_WARNING, PREFIX_KEY, RESOURCE_BUNDLE, SLEEP_EXCEPTION_RESOURCE, SYSTEM_INFO_RESOURCE, TO_STRING_CONFIGURATION_KEYS, TRACE_LEVEL_HIGH, TRACE_LEVEL_LOW, TRACE_LEVEL_MAX, TRACE_LEVEL_MIN, TRACE_LEVEL_NONE, TRACE_LEVEL_NORMAL, TRACELEVEL_KEY, UNKNOWN_ERROR_RESOURCE

Fields inherited from interface org.eclipse.soda.dk.parameter.service.ParameterService

ARRAY, ASCII, ASCIIZ, BOOLEAN, BYTE, BYTES, DOUBLE, FLOAT, HEXASCII, HEXSTRING, INSERT, INTEGER, LITTLEENDIAN, LONG, NASCII, NSTRING, NULL, SHORT, STRING, UNSIGNED

Constructor Summary

BitOffsetParameter(java.lang.String key, int offset)
Constructs an instance of this class from the specified key and offset parameters.

BitOffsetParameter(java.lang.String key, int offset, short style)
Constructs an instance of this class from the specified key, offset and style parameters.

BitOffsetParameter(java.lang.String key, TransformService transform, int offset, short style)
Constructs an BitOffsetParameter object using the input parameter(s).

Method Summary

protected java.lang.Object	decodeMessage(MessageService message) Perform the decodeMessage method and return the Object result.
MessageService	encodeMessage(MessageService message, java.lang.Object value, int offset) Perform the encodeMessage method and return the MessageService result.
protected int	getIndex() Gets the int index property value.
int	getLength() Gets the length.
protected int	getMask() Gets the int mask property value.
protected int	getOffset() Gets the int offset property value.
protected int	getSize() Gets the int size property value.
protected void	setOffset(int offset) Sets the offset property.

Methods inherited from class org.eclipse.soda.dk.parameter.Parameter

decode, decodeBytes, decodeEnd, decodeString, decodeValue, encode, encodeBegin, encodeBytes, encodeString, encodeValue, equals, getDefaultStyle, getKey, getLong, getStyle, getTransform, getTypeStyle, isArray, isInsert, isLittleEndian, isUnsigned, setBits, setKey, setStyle, setTransform

Methods inherited from class org.eclipse.soda.dk.core.EscObject

attemptRecoveryFromError, createDefaultLogService, createException, createException, createInteger, createIntegerTable, createNumber, format, getBoolean, getConfigurationService, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getErrorSeverity, getFloat, getInt, getLoadLibraryName, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails4, getLogDetails5, getLogDetails6, getLogDetails7, getLogService, getLong, getObject, getOutputName, getResource, getSimpleClassName, getStaticBoolean, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticString, getString, getTraceLevel, getVmLibraryVersion, handleError, handleError, handleError, handleStaticError, handleStaticException, isDebug, isTrace, loadService, log, log, report, report, report, report, report, report, reportError, reportSystemInfo, setDebug, setDefaultLogService, setLogService, setTraceLevel, shouldLog, sleep, startupEscStatic, toString, toStringConfigurationKeys, toStringInfo

Methods inherited from class java.lang.Object

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

Field Detail

MASKS

public static final int[] MASKS

Define the masks (int) constant.

Constructor Detail

BitOffsetParameter

public BitOffsetParameter(java.lang.String key,
                          int offset)

Constructs an instance of this class from the specified key and offset parameters.

Parameters:

key - The key (String) parameter.

offset - The offset (int) parameter.

See Also:

BitOffsetParameter(String,int,short), BitOffsetParameter(String,TransformService,int,short)

BitOffsetParameter

public BitOffsetParameter(java.lang.String key,
                          int offset,
                          short style)

Constructs an instance of this class from the specified key, offset and style parameters.

Parameters:

key - The key (String) parameter.

offset - The offset (int) parameter.

style - The style (short) parameter.

See Also:

BitOffsetParameter(String,int), BitOffsetParameter(String,TransformService,int,short)

BitOffsetParameter

public BitOffsetParameter(java.lang.String key,
                          TransformService transform,
                          int offset,
                          short style)

Constructs an BitOffsetParameter object using the input parameter(s).

Parameters:

transform - org.eclipse.soda.dk.transform.service.TransformService

offset - The starting bit offset of the parameter in the message.

style - short

key - The key (String) parameter.

See Also:

BitOffsetParameter(String,int), BitOffsetParameter(String,int,short)

Method Detail

decodeMessage

protected java.lang.Object decodeMessage(MessageService message)

Perform the decodeMessage method and return the Object result.

Overrides:

decodeMessage in class Parameter

Parameters:

message - org.eclipse.soda.dk.message.service.MessageService

Returns:

Results of the decode message (Object) value.

See Also:

encodeMessage(MessageService,Object,int)

encodeMessage

public MessageService encodeMessage(MessageService message,
                                    java.lang.Object value,
                                    int offset)

Perform the encodeMessage method and return the MessageService result.

Overrides:

encodeMessage in class Parameter

Parameters:

message - org.eclipse.soda.dk.message.service.MessageService

value - java.lang.Object

offset - int

Returns:

Results of the encode message (MessageService) value.

See Also:

decodeMessage(MessageService)

getIndex

protected int getIndex()

Gets the int index property value.

Returns:

Results of the get index (int) value.

getLength

public int getLength()

Gets the length.

Returns:

Returns the length.

getMask

protected int getMask()

Gets the int mask property value.

Returns:

Results of the get mask (int) value.

getOffset

protected int getOffset()

Gets the int offset property value.

Returns:

Results of the get offset (int) value.

See Also:

setOffset(int)

getSize

protected int getSize()

Gets the int size property value.

Returns:

Results of the get size (int) value.

setOffset

protected void setOffset(int offset)

Sets the offset property.

Parameters:

offset - The new property value (int).

See Also:

getOffset()