triana.types

Interface AsciiComm

All Known Implementing Classes:

ComplexSampleSet, ComplexSpectrum, Curve, Document, FileName, GraphType, Histogram, MailMsg, MatrixType, MultipleAudio, MultipleChannel, MultipleSpectra, SampleSet, Spectrum, Spectrum2D, TimeFrequency, VectorType

public interface AsciiComm

AsciiCommype (AsciiComm Type) outlines a set of functions which have to be implemented for each Triana Type which wants to be able to communicate with other programs via streams e.g. the Client and Server classes use this to send data out of Triana via socket etc. Also, each type which implements this interface can be used to output and input their data by using the ATImport (Ascii Type importer) and ATExport (Ascii Type exporter) modules.

All the functions here use ASCII (UniCode) transfer as opposed to binary. This is useful when incompatabilities between various computer platforms cause problems when using binary transfer (i.e. little and big endian).

Note that we ONLY now inplement ASCII transfer because Java has incorporated the Serializable interface which does the same as the old Binary transfer. This will be implemented for each type.

See Also:

TrianaType, GraphType, VectorType, Spectrum, Document

Method Summary

Methods

Modifier and Type	Method and Description
void	inputFromStream(java.io.BufferedReader dis) Used when Triana types want to be able to receive ASCII data from the output of other programs.
void	outputToStream(java.io.PrintWriter dos) Used when Triana types want to be able to send their data via an output stream to other programs using strings.

Method Detail

inputFromStream

void inputFromStream(java.io.BufferedReader dis)
                     throws java.io.IOException

Used when Triana types want to be able to receive ASCII data from the output of other programs. This is used to implement socket and to run other executables, written in C etc. With ASCII you don'y have to worry about ENDIANness as the conversions are all done via text. This is obviously slower than the binary version since you have to format the input and output within the another program.

Throws:

java.io.IOException

outputToStream

void outputToStream(java.io.PrintWriter dos)
                    throws java.io.IOException

Used when Triana types want to be able to send their data via an output stream to other programs using strings. This can be used to implement socket and to run other executables, written in C etc. With ASCII you don't have to worry about ENDIANness as the conversions are all done via text. This is obviously slower than the binary version since you have to format the input and output within the another program.

Throws:

java.io.IOException