Package adams.data.conversion

Class Mat5StructToMap

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.conversion.AbstractConversion

adams.data.conversion.Mat5StructToMap

All Implemented Interfaces:

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

public class Mat5StructToMap
extends AbstractConversion
implements MatlabArrayIndexSupporter

Turns the Matlab struct into a map.
In case of multi-dimensional (outermost) structs, an index can be supplied to retrieve just a single element instead of all of them. Appends [x] or [y,x] to the field names, using 0-based indices.

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

-index <adams.core.base.Mat5ArrayElementIndex> (property: index)
    The (optional) index for multi-dimensional structs to retrieve a single
    element instead of all.
    default:
 

-zero-based-index <boolean> (property: zeroBasedIndex)
    If true, the index is treated as 0-based (eg 0;0 for first value) rather
    than 1-based ones (eg 1;1 for first value).
    default: false
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Mat5ArrayElementIndex	m_Index	the index to retrieve.
protected boolean	m_ZeroBasedIndex	whether to interpret the indices as 0-based or 1-based.

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
Mat5StructToMap()

Method Summary

Modifier and Type	Method	Description
Class	accepts()	Returns the class that is accepted as input.
protected void	addStruct(Map map, us.hebi.matlab.mat.types.Struct struct, int[] index)	Adds the Struct recursively.
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.
Mat5ArrayElementIndex	getIndex()	Returns the (optional) index for multi-dimensional structs to retrieve just the specified single element instead of all.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
boolean	getZeroBasedIndex()	Returns whether the index is 0-based or 1-based.
String	globalInfo()	Returns a string describing the object.
String	indexTipText()	Returns the tip text for this property.
void	setIndex(Mat5ArrayElementIndex value)	Sets the (optional) index for multi-dimensional structs to retrieve just the specified single element instead of all.
void	setZeroBasedIndex(boolean value)	Sets whether the index is 0-based or 1-based.
String	zeroBasedIndexTipText()	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.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_Index

protected Mat5ArrayElementIndex m_Index

the index to retrieve.

m_ZeroBasedIndex

protected boolean m_ZeroBasedIndex

whether to interpret the indices as 0-based or 1-based.

Constructor Detail

Mat5StructToMap

public Mat5StructToMap()

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

setIndex

public void setIndex(Mat5ArrayElementIndex value)

Sets the (optional) index for multi-dimensional structs to retrieve just the specified single element instead of all.

Specified by:

setIndex in interface MatlabArrayIndexSupporter

Parameters:

value - the index

getIndex

public Mat5ArrayElementIndex getIndex()

Returns the (optional) index for multi-dimensional structs to retrieve just the specified single element instead of all.

Specified by:

getIndex in interface MatlabArrayIndexSupporter

Returns:

the index

indexTipText

public String indexTipText()

Returns the tip text for this property.

Specified by:

indexTipText in interface MatlabArrayIndexSupporter

Returns:

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

setZeroBasedIndex

public void setZeroBasedIndex(boolean value)

Sets whether the index is 0-based or 1-based.

Specified by:

setZeroBasedIndex in interface MatlabArrayIndexSupporter

Parameters:

value - true if 0-based

getZeroBasedIndex

public boolean getZeroBasedIndex()

Returns whether the index is 0-based or 1-based.

Specified by:

getZeroBasedIndex in interface MatlabArrayIndexSupporter

Returns:

true if 0-based

zeroBasedIndexTipText

public String zeroBasedIndexTipText()

Returns the tip text for this property.

Specified by:

zeroBasedIndexTipText in interface MatlabArrayIndexSupporter

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 actor, which will 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

addStruct

protected void addStruct(Map map,
                         us.hebi.matlab.mat.types.Struct struct,
                         int[] index)

Adds the Struct recursively.

Parameters:

map - the map to add to

struct - the struct to add

index - the index to retrieve

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