Package adams.data.conversion

Class PrimitiveArrayToByteArray

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.conversion.AbstractConversion

adams.data.conversion.PrimitiveArrayToByteArray

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, Serializable

public class PrimitiveArrayToByteArray
extends AbstractConversion

Turns a primitive array into a byte array (IEE754).

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-type <CHAR|SHORT|INT|LONG|FLOAT|DOUBLE> (property: type)
    The primitive type to convert.
    default: FLOAT
 

-num-bytes <int> (property: numBytes)
    The number of bytes to use for the conversion of the primitive.
    default: 4
    minimum: 1
 

-byte-order <LITTLE_ENDIAN|BIG_ENDIAN> (property: byteOrder)
    The byte order to use for the conversion.
    default: LITTLE_ENDIAN
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ByteArrayToPrimitiveArray.ByteOrderType	m_ByteOrder	the byte order.
protected int	m_NumBytes	the number of bytes to convert.
protected ByteArrayToPrimitiveArray.PrimitiveType	m_Type	the primitive to output.

Fields inherited from class adams.data.conversion.AbstractConversion

m_Input, m_Output, m_Owner, m_Stopped

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
PrimitiveArrayToByteArray()

Method Summary

Modifier and Type	Method	Description
Class	accepts()	Returns the class that is accepted as input.
String	byteOrderTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected Object	doConvert()	Performs the actual conversion.
Class	generates()	Returns the class that is generated as output.
ByteArrayToPrimitiveArray.ByteOrderType	getByteOrder()	Returns the byte order to use for the conversion.
int	getNumBytes()	Returns the number of bytes to use for the conversion.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
ByteArrayToPrimitiveArray.PrimitiveType	getType()	Returns the type of primitive to convert.
String	globalInfo()	Returns a string describing the object.
String	numBytesTipText()	Returns the tip text for this property.
void	setByteOrder(ByteArrayToPrimitiveArray.ByteOrderType value)	Sets the byte order to use for the conversion.
void	setNumBytes(int value)	Sets the number of bytes to use for the conversion.
void	setType(ByteArrayToPrimitiveArray.PrimitiveType value)	Sets the type of primitive to convert.
String	typeTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.conversion.AbstractConversion

checkData, cleanUp, convert, getAdditionalInformation, getInput, getInput, getOutput, getOutput, getOwner, reset, setInput, setOwner, shallowCopy, shallowCopy, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_NumBytes

protected int m_NumBytes

the number of bytes to convert.

m_ByteOrder

protected ByteArrayToPrimitiveArray.ByteOrderType m_ByteOrder

the byte order.

m_Type

protected ByteArrayToPrimitiveArray.PrimitiveType m_Type

the primitive to output.

Constructor Detail

PrimitiveArrayToByteArray

public PrimitiveArrayToByteArray()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setType

public void setType(ByteArrayToPrimitiveArray.PrimitiveType value)

Sets the type of primitive to convert.

Parameters:

value - the type

getType

public ByteArrayToPrimitiveArray.PrimitiveType getType()

Returns the type of primitive to convert.

Returns:

the type

typeTipText

public String typeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setNumBytes

public void setNumBytes(int value)

Sets the number of bytes to use for the conversion.

Parameters:

value - the number

getNumBytes

public int getNumBytes()

Returns the number of bytes to use for the conversion.

Returns:

the number

numBytesTipText

public String numBytesTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setByteOrder

public void setByteOrder(ByteArrayToPrimitiveArray.ByteOrderType value)

Sets the byte order to use for the conversion.

Parameters:

value - the order

getByteOrder

public ByteArrayToPrimitiveArray.ByteOrderType getByteOrder()

Returns the byte order to use for the conversion.

Returns:

the order

byteOrderTipText

public String byteOrderTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractConversion

Returns:

null if no info available, otherwise short string

accepts

public Class accepts()

Returns the class that is accepted as input.

Specified by:

accepts in interface Conversion

Specified by:

accepts in class AbstractConversion

Returns:

the class

generates

public Class generates()

Returns the class that is generated as output.

Specified by:

generates in interface Conversion

Specified by:

generates in class AbstractConversion

Returns:

the class

doConvert

protected Object doConvert()
                    throws Exception

Performs the actual conversion.

Specified by:

doConvert in class AbstractConversion

Returns:

the converted data

Throws:

Exception - if something goes wrong with the conversion