org.vishia.curves

Interface WriteCurve_ifc

All Known Implementing Classes:

WriteCurveBinary, WriteCurveCsv

public interface WriteCurve_ifc

This interface can be used for writing curves into files from any application. Implementors are 'exporter' for that data. This interface is used in org.vishia.gral.base.GralCurveView but it is useful for other applications too. It is possible to load a implementor of that interface by string (using Class.forName(name).newInstance()). It means that this interface should supply all required access methods.

Field Summary

Fields

Modifier and Type	Field and Description
static int	version Version, history and copyright/copyleft.

Method Summary

Modifier and Type	Method and Description
void	setFile(java.io.File file) Sets the output file.
void	setTrackInfo(int nrofTracks, int ixTrack, java.lang.String sPath, java.lang.String sName, java.lang.String sColor, float scale7div, float mid, float line0) Sets information for one track.
void	writeCurveError(java.lang.String msg)
void	writeCurveFinish()
void	writeCurveRecord(int timeshort, float[] values)
void	writeCurveStart(int timeshort) Opens the file and write head information.
void	writeCurveTimestamp(Timeshort timeshortabs)

Field Detail

version

static final int version

Version, history and copyright/copyleft.

• 2012-10-12 created. Firstly used for org.vishia.guiInspc.InspcCurveView and org.vishia.gral.base.GralCurveView.

Copyright/Copyleft:
For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but doesn't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you intent to use this source without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

Method Detail

setFile

void setFile(java.io.File file)

Sets the output file. The file may be opened in this routine or opened in writeCurveStart(int). This routine should be the first one to call. An currently usage of the same instance is closed with this call.

Parameters:

file - The file for output.

setTrackInfo

void setTrackInfo(int nrofTracks,
                  int ixTrack,
                  java.lang.String sPath,
                  java.lang.String sName,
                  java.lang.String sColor,
                  float scale7div,
                  float mid,
                  float line0)

Sets information for one track. This routine should be called more as one time one for each track. It should be called firstly after setFile(File).

Parameters:

nrofTracks -

ixTrack -

sPath -

sName -

writeCurveTimestamp

void writeCurveTimestamp(Timeshort timeshortabs)

writeCurveStart

void writeCurveStart(int timeshort)
              throws java.io.IOException

Opens the file and write head information. The #setTrackInfo(int, int, String, String) should be called already for all tracks. It means, all information which may need in the head are given on calling this method.

Parameters:

timeshort -

Throws:

java.io.IOException

writeCurveRecord

void writeCurveRecord(int timeshort,
                      float[] values)
               throws java.io.IOException

Throws:

java.io.IOException

writeCurveFinish

void writeCurveFinish()
               throws java.io.IOException

Throws:

java.io.IOException

writeCurveError

void writeCurveError(java.lang.String msg)
              throws java.io.IOException

Throws:

java.io.IOException