org.eclipse.soda.dk.parameter
Class ByteOffsetParameter

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

All Implemented Interfaces:

DataParameterService, ParameterService

public class ByteOffsetParameter
extends BitOffsetParameter

Version:

1.0.0

Field Summary

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

MASKS

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

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

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

ByteOffsetParameter(java.lang.String key, TransformService transform, int offset, int length, short style)
Constructor for ByteOffsetParameter using the input parameter(s).

Method Summary

int	getLength() Gets the length.
void	setLength(int length) Sets the length.

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

decodeMessage, encodeMessage, getIndex, getMask, getOffset, getSize, setOffset

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

Constructor Detail

ByteOffsetParameter

public ByteOffsetParameter(java.lang.String key,
                           int offset,
                           int length)

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

Parameters:

key - The key (String) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

See Also:

ByteOffsetParameter(String,int,int,short), ByteOffsetParameter(String,TransformService,int,int,short)

ByteOffsetParameter

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

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

Parameters:

key - The key (String) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

style - The style (short) parameter.

See Also:

ByteOffsetParameter(String,int,int), ByteOffsetParameter(String,TransformService,int,int,short)

ByteOffsetParameter

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

Constructor for ByteOffsetParameter using the input parameter(s).

Parameters:

key - The key (String) parameter.

transform - The transform (TransformService) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

style - The style (short) parameter.

See Also:

ByteOffsetParameter(String,int,int), ByteOffsetParameter(String,int,int,short)

Method Detail

getLength

public int getLength()

Gets the length.

Overrides:

getLength in class BitOffsetParameter

Returns:

Returns a int

See Also:

setLength(int)

setLength

public void setLength(int length)

Sets the length.

Parameters:

length - The length to set

See Also:

getLength()