org.simantics.databoard
Class Historian

java.lang.Object
  extended by org.simantics.databoard.Historian

public class Historian
extends java.lang.Object

Fasade Class for Managing historian data

Author:
Toni Kalajainen

Constructor Summary
Historian()
           
 
Method Summary
static void createDirectoryHistorian(java.io.File directory)
          Create a new directory based historian.
static DataType createRecordingType(DataType timeType, DataType valueType)
          Create DataType for Recording(T, V) where T is the datatype of the Time, and V value. // The captured data for a single variable type Recording(T, V) = { // Record Identifier nodeId : Variant, // All labels labels : LocalizedTexts, // All Segments, segments are time series segments : Map(T, V)[] }
static DataType getRecordingSessionType()
           
static RecordAccessor openDirectoryHistorian(java.io.File directory)
          Open an accessor to directory & file based historian service.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Historian

public Historian()
Method Detail

getRecordingSessionType

public static DataType getRecordingSessionType()

createDirectoryHistorian

public static void createDirectoryHistorian(java.io.File directory)
                                     throws java.io.IOException
Create a new directory based historian. There is a session.dbb file that contains RecordingSession info. The recordings field is empty as they are separate .dbb files.

IOException is thrown if directory already existed, otherwise the directory is used.

Parameters:
directory -
Throws:
java.io.IOException

openDirectoryHistorian

public static RecordAccessor openDirectoryHistorian(java.io.File directory)
                                             throws AccessorConstructionException
Open an accessor to directory & file based historian service. Note atmost one accessor is allowed.

Parameters:
directory -
Returns:
accessor
Throws:
AccessorConstructionException

createRecordingType

public static DataType createRecordingType(DataType timeType,
                                           DataType valueType)
Create DataType for Recording(T, V) where T is the datatype of the Time, and V value. // The captured data for a single variable type Recording(T, V) = { // Record Identifier nodeId : Variant, // All labels labels : LocalizedTexts, // All Segments, segments are time series segments : Map(T, V)[] }

Parameters:
T - value type
Returns:
Recording(T)