![]() |
TopCon API
1.1.0
.Net API to control TopCon devices
|
Public Member Functions | |
DataCollector (Device.TopCon myTopCon, UInt32 collectorID) | |
Generates internal ChannelList object. ( implicitly calls method initChannelArray()). More... | |
void | InitChannelArray () |
This method resets alle items in the channelArray to null. This means that no channel is connected to any data signal. More... | |
UInt32 | GetMaxNumberOfChannels () |
This method returns the number of channels available for this DataCollector object. More... | |
Boolean | IsAtLeastOneChannelSet () |
This method returns true if at least one DataCollector channel ist set. More... | |
DC_ScopeChannel | GetChannelDefinition (UInt32 channNumber) |
This method returns the channel definition it it was set before, null otherwise. More... | |
void | SetChannelDefinition (UInt32 channelNumber, String scopeChannelIdentifier) |
This method allows to define channels of the DataCollector by defining the channel number and the -shortDescription- of the channel. More... | |
String | GetChannelIdentifierAsSingleString () |
This method returns a String representation of all channels currently set in this DataCollector. More... | |
String | GetIdentifierOfChannel (UInt32 channNumber) |
This method returns the short description (identifier) of the channel with index given as parameter. More... | |
void | SetSaveDirectory (String saveDirectory) |
This method allows to define the directory where More... | |
void | SetSaveDirectory (String saveDirectory, Boolean forceCreation) |
This method allows to define the directory where More... | |
String | GetSavePath () |
This method returns the path where the data is saved. More... | |
UInt32 | GetSamplingRateInMilliseconds () |
This method allows to read the sampling time of the dataCollector object. More... | |
void | SetDataCollectorSamplingRateInMilliseconds (UInt32 newSamplingTimeInMs) |
This method allows to set the sampling rate of the data collector. There exist minimal and maximal values for the time between two samples ( commonly: 100 .... 10.000ms). More... | |
void | Start () |
This method starts the data collector. The following exception messages can occur: More... | |
void | Stop () |
This command stops the current execution of the Data Collector and finishes the protocol of the recorded data in the CSV file. More... | |
Boolean | IsRunning () |
This method indicates if the data collector is running. More... | |
string | GetLastError () |
Get the last exception message. More... | |
CH.Regatron.HPPS.SolarArraySimulation.DataCollector.DataCollector | ( | Device.TopCon | myTopCon, |
UInt32 | collectorID | ||
) |
Generates internal ChannelList object. ( implicitly calls method initChannelArray()).
myTopCon | Reference to the parent TopCon object. |
collectorID | This number is used to identify the different DataColletor objects; range: [1...3] |
DC_ScopeChannel CH.Regatron.HPPS.SolarArraySimulation.DataCollector.GetChannelDefinition | ( | UInt32 | channNumber | ) |
This method returns the channel definition it it was set before, null otherwise.
channNumber | Index number of the channel of interest 1 to use GetMaxNumberOfChannels() to determine the upper limit) |
String CH.Regatron.HPPS.SolarArraySimulation.DataCollector.GetChannelIdentifierAsSingleString | ( | ) |
This method returns a String representation of all channels currently set in this DataCollector.
String CH.Regatron.HPPS.SolarArraySimulation.DataCollector.GetIdentifierOfChannel | ( | UInt32 | channNumber | ) |
This method returns the short description (identifier) of the channel with index given as parameter.
channNumber | Unsigned integer, used as index of the channel to be used (1...n). |
string CH.Regatron.HPPS.SolarArraySimulation.DataCollector.GetLastError | ( | ) |
UInt32 CH.Regatron.HPPS.SolarArraySimulation.DataCollector.GetMaxNumberOfChannels | ( | ) |
This method returns the number of channels available for this DataCollector object.
UInt32 CH.Regatron.HPPS.SolarArraySimulation.DataCollector.GetSamplingRateInMilliseconds | ( | ) |
This method allows to read the sampling time of the dataCollector object.
String CH.Regatron.HPPS.SolarArraySimulation.DataCollector.GetSavePath | ( | ) |
This method returns the path where the data is saved.
void CH.Regatron.HPPS.SolarArraySimulation.DataCollector.InitChannelArray | ( | ) |
This method resets alle items in the channelArray to null. This means that no channel is connected to any data signal.
Boolean CH.Regatron.HPPS.SolarArraySimulation.DataCollector.IsAtLeastOneChannelSet | ( | ) |
This method returns true if at least one DataCollector channel ist set.
Boolean CH.Regatron.HPPS.SolarArraySimulation.DataCollector.IsRunning | ( | ) |
This method indicates if the data collector is running.
void CH.Regatron.HPPS.SolarArraySimulation.DataCollector.SetChannelDefinition | ( | UInt32 | channelNumber, |
String | scopeChannelIdentifier | ||
) |
This method allows to define channels of the DataCollector by defining the channel number and the -shortDescription- of the channel.
channelNumber | Number of the channel to be used |
scopeChannelIdentifier | String that identifies the channel. Call |
void CH.Regatron.HPPS.SolarArraySimulation.DataCollector.SetDataCollectorSamplingRateInMilliseconds | ( | UInt32 | newSamplingTimeInMs | ) |
This method allows to set the sampling rate of the data collector. There exist minimal and maximal values for the time between two samples ( commonly: 100 .... 10.000ms).
newSamplingTimeInMs | samolin time in [ms] |
void CH.Regatron.HPPS.SolarArraySimulation.DataCollector.SetSaveDirectory | ( | String | saveDirectory | ) |
This method allows to define the directory where
saveDirectory | String representing the directory where the collected data should be stored. Example: "C:/Regatron/Data/" |
void CH.Regatron.HPPS.SolarArraySimulation.DataCollector.SetSaveDirectory | ( | String | saveDirectory, |
Boolean | forceCreation | ||
) |
This method allows to define the directory where
saveDirectory | String representing the directory where the collected data should be stored. Example: "C:/Regatron/Data/" |
forceCreation | If true: forces the creation of this directory if it does not exist otherwise: Exception if it does not exist. |
void CH.Regatron.HPPS.SolarArraySimulation.DataCollector.Start | ( | ) |
This method starts the data collector.
The following exception messages can occur:
CH.Regatron.HPPS.Device.TopConException |
void CH.Regatron.HPPS.SolarArraySimulation.DataCollector.Stop | ( | ) |
This command stops the current execution of the Data Collector and finishes the protocol of the recorded data in the CSV file.