MasterScan  Lab_Matlab_control Master Branch
List of all members | Static Methods
dotsDataLogUtilities Class Reference

Overview

Static utility methods for topsDataLog and multiple Matlab instances.

dotsDataLogUtilities provides static methods for working synchronizing topsDataLog across multiple Matlab instances. The methods expect ensemble objects, which can be connected to any remote Matlab instances. They facilitate sending data from from the local Matlab instance to remote Matlab instances, and for writing log data to disk in a remote Matlab instance.

Static Methods

static newData sendNewData (ensemble)
 Send new topsDataLog data to a remote Matlab instance. More...
 
static flushData (ensemble)
 Flush data from a remote data log. More...
 
static writeToDisk (ensemble, fileWithPath, isAutomated)
 Write new topsDataLog data to a remote disk. More...
 

Methods

◆ flushData()

static flushData ( ensemble  )
static

Flush data from a remote data log.

Parameters
ensembleensemble object connected to a remote Matlab

Instructs a remote Matlab instance, via the given ensemble, to flush data from the remote topsDataLog.

◆ writeToDisk()

static writeToDisk ( ensemble  ,
fileWithPath  ,
isAutomated   
)
static

Write new topsDataLog data to a remote disk.

Parameters
ensembleensemble object connected to a remote Matlab
fileWithPathname and path of the data file to write
isAutomatedwhether to automatically write data to disk

Instructs a remote Matlab instance, via the given ensemble, to write topsDataLog data to disk. By default, this happens once. If isAutomated is true, the remote counterpart of the given ensemble will continuously attempt to write new data to disk, whenever new data re available.


The documentation for this class was generated from the following file: