org.vishia.util

Class TimedValues

java.lang.Object

org.vishia.util.TimedValues

public class TimedValues
extends java.lang.Object

This class offers a head structure for timed values, typically measurement values. Each track (one value array) has a name, type, and its data. All tracks are organized in a container, Map with name as key. The absolute time stamp is associated once to all values. It means the spread of the values should be lesser than the half length of a timeShort. TimeShort is 32 bit.
It means for 50 microseconds time step, it is sufficient for 1 day (exactly one day, 5 hours, 49 minutes, 34 seconds, 192.35 ms for a difference of 0x7fffffff. For 1 ms time step it is approximately 23 days.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimedValues.Track

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	ix The current index can be helpfully to fill.
private int	length
private Timeshort	timeAbs Association to the absolute time of all values of this series.
private int[]	timeShort Proper to the values: relative wrapping time associated to each measurement point.
private int[]	timeShortAdd This is the relation between #timeShort and the absolute time stored in #timeAbs.
private java.util.Map<java.lang.String,TimedValues.Track>	tracks
static int	version Version, history and license.

Constructor Summary

Constructors

Constructor and Description
TimedValues(int capacity)

Method Summary

Modifier and Type	Method and Description
TimedValues.Track	addTrack(java.lang.String name, char typeChar)
void	cleanSetCapacity(int length) Defines the capacity for new tracks and cleans existing tracks.
int	getIncrIx()
int	getIncrWrapIx()
int	getLength()
int	getsetTimeShort(int ix, int timeShort, int timeShortAdd)
int	getTimeShort(int ix)
TimedValues.Track	getTrack(java.lang.String name) Get a track to work.
boolean	increaseCapacity(int length) Increases the capacity of all given tracks and set the length for new tracks.
void	setTimeShort(int ix, int timeShort, int timeShortAdd) Set the timeShort to the correspond value.

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final int version

Version, history and license.

• 2022-08-28 Hartmut created, as excerp from the org.vishia.gral.base.GralCurveView data. It is commonly usable.

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

timeAbs

private Timeshort timeAbs

Association to the absolute time of all values of this series.

tracks

private java.util.Map<java.lang.String,TimedValues.Track> tracks

timeShort

private int[] timeShort

Proper to the values: relative wrapping time associated to each measurement point. This timeShort can be newly organized for some points. For example if a controller is restarted, it counts again from 0. See #timeShortAbs

timeShortAdd

private int[] timeShortAdd

This is the relation between #timeShort and the absolute time stored in #timeAbs. To get the correspond time to Timeshort.absTime_short, the timeShort value and this value should be added. Then Timeshort.absTime_short should be subtract. The result is the number of timeShort increments which should be added to the given Timeshort.absTime.

ix

int ix

The current index can be helpfully to fill.

length

private int length

Constructor Detail

TimedValues

public TimedValues(int capacity)

Method Detail

getLength

public int getLength()

cleanSetCapacity

public void cleanSetCapacity(int length)

Defines the capacity for new tracks and cleans existing tracks.

Parameters:

length - the number of values able to store.

increaseCapacity

public boolean increaseCapacity(int length)

Increases the capacity of all given tracks and set the length for new tracks.

Parameters:

length - new length If the length is equivalent to the given length, nothing else is done.

Returns:

false if the new length is less than the given, true if length is correct.

addTrack

public TimedValues.Track addTrack(java.lang.String name,
                                  char typeChar)

getTrack

public TimedValues.Track getTrack(java.lang.String name)

Get a track to work.

Parameters:

name -

Returns:

null if the track with this name does not exists.

getIncrIx

public int getIncrIx()

getIncrWrapIx

public int getIncrWrapIx()

getTimeShort

public int getTimeShort(int ix)

getsetTimeShort

public int getsetTimeShort(int ix,
                           int timeShort,
                           int timeShortAdd)

setTimeShort

public void setTimeShort(int ix,
                         int timeShort,
                         int timeShortAdd)

Set the timeShort to the correspond value.

Parameters:

ix - to this index

timeShort - given timeShort from the source (controller etc.) may be recount from 0 after reset

timeShortAdd - adding value either due to timeAbs adjustment or due to restart/recount. Maybe 0 if not used.