Package org.yamcs.xtce

Class StringDataEncoding

java.lang.Object

org.yamcs.xtce.DataEncoding

org.yamcs.xtce.StringDataEncoding

All Implemented Interfaces:

Serializable

public class StringDataEncoding
extends DataEncoding

For common encodings of string data

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StringDataEncoding.Builder
static class	StringDataEncoding.SizeType

Field Summary

Fields inherited from class org.yamcs.xtce.DataEncoding

fromBinaryTransformAlgorithm, sizeInBits, toBinaryTransformAlgorithm

Constructor Summary

Constructors

Constructor	Description
StringDataEncoding(StringDataEncoding.Builder builder)

Method Summary

Modifier and Type	Method	Description
StringDataEncoding	copy()	Create a shallow copy of the data encoding
String	getEncoding()
int	getSizeInBitsOfSizeTag()
StringDataEncoding.SizeType	getSizeType()
byte	getTerminationChar()
Object	parseString(String stringValue)	parses the string into a java object of the correct type Has to match the DataEncodingDecoder (so probably it should be moved there somehow: TODO)
void	setEncoding(String encoding)
void	setSizeInBitsOfSizeTag(int sizeInBits)
void	setSizeType(StringDataEncoding.SizeType sizeType)
void	setTerminationChar(byte tc)
StringDataEncoding.Builder	toBuilder()
String	toString()

Methods inherited from class org.yamcs.xtce.DataEncoding

getByteOrder, getDependentParameters, getFromBinaryTransformAlgorithm, getSizeInBits, getToBinaryTransformAlgorithm, setFromBinaryTransformAlgorithm, setSizeInBits, setToBinaryTransformAlgorithm

Methods inherited from class java.lang.Object

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

Constructor Detail

StringDataEncoding

public StringDataEncoding(StringDataEncoding.Builder builder)

Method Detail

toBuilder

public StringDataEncoding.Builder toBuilder()

Specified by:

toBuilder in class DataEncoding

setSizeType

public void setSizeType(StringDataEncoding.SizeType sizeType)

getSizeType

public StringDataEncoding.SizeType getSizeType()

getSizeInBitsOfSizeTag

public int getSizeInBitsOfSizeTag()

setSizeInBitsOfSizeTag

public void setSizeInBitsOfSizeTag(int sizeInBits)

getTerminationChar

public byte getTerminationChar()

setTerminationChar

public void setTerminationChar(byte tc)

toString

public String toString()

Overrides:

toString in class Object

parseString

public Object parseString(String stringValue)

Description copied from class: DataEncoding

parses the string into a java object of the correct type Has to match the DataEncodingDecoder (so probably it should be moved there somehow: TODO)

Specified by:

parseString in class DataEncoding

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

copy

public StringDataEncoding copy()

Description copied from class: DataEncoding

Create a shallow copy of the data encoding

Specified by:

copy in class DataEncoding

Returns: