pt.lsts.imc

Class IMCMessageType

java.lang.Object

pt.lsts.imc.IMCMessageType

public class IMCMessageType
extends java.lang.Object

When parsing the messages definition file, an hashtable is filled with the supported message structures. This class holds information about a message like its size, name and fields.

Author:

ZP

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNKNOWN_SIZE

Constructor Summary

Constructors

Constructor and Description
IMCMessageType()
IMCMessageType(IMCMessageType superType)

Method Summary

Modifier and Type	Method and Description
void	addField(java.lang.String abbrv, java.lang.String fieldType, java.lang.String unit, java.lang.String min, java.lang.String max)
int	getComputedLength()
java.lang.Object	getDefaultValue(java.lang.String field)
java.util.LinkedHashMap<java.lang.String,java.lang.Object>	getDefaultValues()
java.lang.String	getFieldDescription(java.lang.String field)
java.util.Collection<IMCFieldType>	getFieldIMCTypes()
java.util.LinkedHashMap<java.lang.String,java.lang.Long>	getFieldMeanings(java.lang.String abbrev)
java.util.Collection<java.lang.String>	getFieldNames()
java.util.LinkedHashMap<java.lang.Long,java.lang.String>	getFieldPossibleValues(java.lang.String abbrev)
java.lang.String	getFieldPrefix(java.lang.String field)
java.lang.String	getFieldSubtype(java.lang.String abbrev)
IMCFieldType	getFieldType(java.lang.String field)
java.lang.String	getFieldUnits(java.lang.String field)
java.util.Vector<java.lang.String>	getFlags()
java.lang.String	getFullFieldName(java.lang.String field)
java.lang.String	getFullName()
int	getId()
java.lang.String	getImcVersion()
java.lang.String	getMessageDescription()
int	getOffsetOf(java.lang.String field)
java.lang.String	getShortName()
int	getSize()
IMCMessageType	getSupertype()
boolean	hasFlag(java.lang.String flag)
boolean	isAbstract()
static boolean	isInitializable(java.lang.String type)
static boolean	isNumericType(java.lang.String type)
void	setComputedLength(int computedLength)
void	setFieldDescription(java.lang.String field, java.lang.String description)
void	setFieldName(java.lang.String field, java.lang.String fullname)
void	setFieldPossibleValues(java.lang.String abbrev, java.util.LinkedHashMap<java.lang.Long,java.lang.String> possibleValues)
void	setFieldPrefix(java.lang.String field, java.lang.String prefix)
void	setFieldSubtype(java.lang.String abbrev, java.lang.String subtype)
void	setFullName(java.lang.String fullName)
void	setId(int id)
void	setImcVersion(java.lang.String imcVersion)
void	setMessageDescription(java.lang.String description)
void	setShortName(java.lang.String shortName)
void	setSize(int size)
void	setSuperType(IMCMessageType msgType)
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UNKNOWN_SIZE

public static final int UNKNOWN_SIZE

See Also:

Constant Field Values

Constructor Detail

IMCMessageType

public IMCMessageType()

IMCMessageType

public IMCMessageType(IMCMessageType superType)

Method Detail

getFlags

public java.util.Vector<java.lang.String> getFlags()

hasFlag

public boolean hasFlag(java.lang.String flag)

getDefaultValue

public java.lang.Object getDefaultValue(java.lang.String field)

getOffsetOf

public int getOffsetOf(java.lang.String field)

isNumericType

public static boolean isNumericType(java.lang.String type)

isInitializable

public static boolean isInitializable(java.lang.String type)

addField

public void addField(java.lang.String abbrv,
                     java.lang.String fieldType,
                     java.lang.String unit,
                     java.lang.String min,
                     java.lang.String max)

setFieldPossibleValues

public void setFieldPossibleValues(java.lang.String abbrev,
                                   java.util.LinkedHashMap<java.lang.Long,java.lang.String> possibleValues)

setFieldPrefix

public void setFieldPrefix(java.lang.String field,
                           java.lang.String prefix)

getFieldPrefix

public java.lang.String getFieldPrefix(java.lang.String field)

getFieldNames

public java.util.Collection<java.lang.String> getFieldNames()

getFieldIMCTypes

public java.util.Collection<IMCFieldType> getFieldIMCTypes()

getFieldType

public IMCFieldType getFieldType(java.lang.String field)

getFieldUnits

public java.lang.String getFieldUnits(java.lang.String field)

getFieldPossibleValues

public java.util.LinkedHashMap<java.lang.Long,java.lang.String> getFieldPossibleValues(java.lang.String abbrev)

getFieldMeanings

public java.util.LinkedHashMap<java.lang.String,java.lang.Long> getFieldMeanings(java.lang.String abbrev)

isAbstract

public boolean isAbstract()

getId

public int getId()

setId

public void setId(int id)

getComputedLength

public int getComputedLength()

setComputedLength

public void setComputedLength(int computedLength)

getSize

public int getSize()

setSize

public void setSize(int size)

getFullName

public java.lang.String getFullName()

setFullName

public void setFullName(java.lang.String fullName)

getShortName

public java.lang.String getShortName()

setShortName

public void setShortName(java.lang.String shortName)

getImcVersion

public java.lang.String getImcVersion()

setImcVersion

public void setImcVersion(java.lang.String imcVersion)

setFieldDescription

public void setFieldDescription(java.lang.String field,
                                java.lang.String description)

setFieldName

public void setFieldName(java.lang.String field,
                         java.lang.String fullname)

getFieldDescription

public java.lang.String getFieldDescription(java.lang.String field)

getFullFieldName

public java.lang.String getFullFieldName(java.lang.String field)

getMessageDescription

public java.lang.String getMessageDescription()

setMessageDescription

public void setMessageDescription(java.lang.String description)

getDefaultValues

public java.util.LinkedHashMap<java.lang.String,java.lang.Object> getDefaultValues()

Returns:

the defaultValues

setFieldSubtype

public void setFieldSubtype(java.lang.String abbrev,
                            java.lang.String subtype)

getFieldSubtype

public java.lang.String getFieldSubtype(java.lang.String abbrev)

getSupertype

public IMCMessageType getSupertype()

setSuperType

public void setSuperType(IMCMessageType msgType)
                  throws java.lang.Exception

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object