TopCon API  1.1.0
.Net API to control TopCon devices
CH.Regatron.HPPS.Device.TCLIN Class Reference

This class implements the functionality for TC.LIN module values. More...

Inheritance diagram for CH.Regatron.HPPS.Device.TCLIN:
Inheritance graph

Public Member Functions

 TCLIN (TopCon topCon, UInt32 tcLinId)
 This is the TCLIN constructor. More...
 
void GetVoltageStats (ref double voltageMean, ref double voltageMin, ref double voltageMax)
 This method returns 3 values (as referenced parameters) that describe the actual output voltage.
The min and max values work similar to an audio equalizer: the values are immediately pushed to the min (max) if the current value exceeds that limit. After a short time, the values return slowly to the mean value. This can be seen as a LP filtering of the signals.
More...
 
void GetCurrentStats (ref double currentMean, ref double currentMin, ref double currentMax)
 This method returns 3 values (as referenced parameters) that describe the actual output current.
See voltage statistics for further explanations. More...
 
void GetPowerStats (ref double powerMean, ref double powerMin, ref double powerMax)
 This method returns 3 values (as referenced parameters) that describe the actual power output.
See voltage statistics for further explanations.
More...
 
void GetMppVoltageAndCurrent (ref double mppVoltage, ref double mppCurrent)
 This method returns the MPP data (voltage, current)of this TCLIN. More...
 
double GetMppCurrent ()
 This method returns the MPP voltage value of this TCLIN. More...
 
double GetMppVoltage ()
 This method returns the MPP voltage value of this TCLIN. More...
 
void GetEnergyCounterActualAndMpp (ref double actualPower, ref double mppPower)
 This method returns the current values of both, actual power and MPP power. More...
 
double GetEnergyCounterMpp ()
 This method returns the value of the MPP energy counter. More...
 
double GetEnergyCounterActual ()
 This method returns the value of the energy counter linked to the actual output. More...
 
double GetPowerMaximum ()
 This method returns the maximum (peak) value of the output power. More...
 
double GetPowerMinimum ()
 This method returns the mainimum value of the output power. More...
 
double GetPowerAverage ()
 This method returns the average value of the output power. More...
 
double GetCurrentMaximum ()
 This method returns the maximum (peak) value of the output current. More...
 
double GetCurrentMinimum ()
 This method returns the mainimum value of the output current. More...
 
double GetCurrentAverage ()
 This method returns the average value of the output current. More...
 
double GetVoltageAverage ()
 This method returns the average value of the output voltage. More...
 
double GetVoltageMaximum ()
 This method returns the maximum (peak) value of the output voltage. More...
 
double GetVoltageMinimum ()
 This method returns the mainimum value of the output voltage. More...
 
Boolean IsAlternativeCurrentRange ()
 Check the alternative current range of the TC.LIN More...
 
string GetLastError ()
 Get the last exception message. More...
 

Detailed Description

This class implements the functionality for TC.LIN module values.

There are up to 8 ID = 0...7 TC.LIN objects available.Generated objects received thru TopCon are only needed for TC.LIN module values. TC.LIN system values are automatically switched if TC.LIN and TC.P or TC.MAC support these values.

See also
TopCon.GetActualVoltage()

Constructor & Destructor Documentation

◆ TCLIN()

CH.Regatron.HPPS.Device.TCLIN.TCLIN ( TopCon  topCon,
UInt32  tcLinId 
)

This is the TCLIN constructor.

Parameters
topConLink to the calling TopCon object.
tcLinIdSet this parameter to whatever is the index of that TC.LIN (commonly = 0 for first TC.LIN)
Exceptions
ArgumentException
NullReferenceException

Member Function Documentation

◆ GetCurrentAverage()

double CH.Regatron.HPPS.Device.TCLIN.GetCurrentAverage ( )

This method returns the average value of the output current.

Returns
Value of the maximum output current within the analysis time window [A].
Exceptions
CH.Regatron.HPPS.Device.TopConCommunicationException

◆ GetCurrentMaximum()

double CH.Regatron.HPPS.Device.TCLIN.GetCurrentMaximum ( )

This method returns the maximum (peak) value of the output current.

Returns
Value of the maximum output current within the analysis time window [A].
Exceptions
CH.Regatron.HPPS.Device.TopConCommunicationException

◆ GetCurrentMinimum()

double CH.Regatron.HPPS.Device.TCLIN.GetCurrentMinimum ( )

This method returns the mainimum value of the output current.

Returns
Value of the minimum output current within the analysis time window [A].
Exceptions
CH.Regatron.HPPS.Device.TopConCommunicationException

◆ GetCurrentStats()

void CH.Regatron.HPPS.Device.TCLIN.GetCurrentStats ( ref double  currentMean,
ref double  currentMin,
ref double  currentMax 
)

This method returns 3 values (as referenced parameters) that describe the actual output current.
See voltage statistics for further explanations.

Parameters
currentMeanMean value of the output current. [A] within the analysis time window.
currentMinMinimum value of the output current [A] within the analysis time window.
currentMaxMaximum value of the output current [A] within the analysis time window.
Exceptions
CH.Regatron.HPPS.Device.TopConCommunicationException

◆ GetEnergyCounterActual()

double CH.Regatron.HPPS.Device.TCLIN.GetEnergyCounterActual ( )

This method returns the value of the energy counter linked to the actual output.

Returns
Value of the 'actual' energy counter [Ws]
Exceptions
CH.Regatron.HPPS.Device.TopConCommunicationException

◆ GetEnergyCounterActualAndMpp()

void CH.Regatron.HPPS.Device.TCLIN.GetEnergyCounterActualAndMpp ( ref double  actualPower,
ref double  mppPower 
)

This method returns the current values of both, actual power and MPP power.

Parameters
actualPowerValue of the currently output energy counter [Ws].
mppPowerValue of the current MPP energy counter [Ws].
Exceptions
CH.Regatron.HPPS.Device.TopConCommunicationException

◆ GetEnergyCounterMpp()

double CH.Regatron.HPPS.Device.TCLIN.GetEnergyCounterMpp ( )

This method returns the value of the MPP energy counter.

Returns
Value of the MPP energy counter [Ws]
Exceptions
CH.Regatron.HPPS.Device.TopConCommunicationException

◆ GetLastError()

string CH.Regatron.HPPS.Device.TCLIN.GetLastError ( )

Get the last exception message.

Returns

Implements CH.Regatron.HPPS.IExceptionMessenger.

◆ GetMppCurrent()

double CH.Regatron.HPPS.Device.TCLIN.GetMppCurrent ( )

This method returns the MPP voltage value of this TCLIN.

Returns
The actual value of the MPP point.
Exceptions
CH.Regatron.HPPS.Device.TopConCommunicationException

◆ GetMppVoltage()

double CH.Regatron.HPPS.Device.TCLIN.GetMppVoltage ( )

This method returns the MPP voltage value of this TCLIN.

Returns
The actual value of the MPP point.
Exceptions
CH.Regatron.HPPS.Device.TopConCommunicationException

◆ GetMppVoltageAndCurrent()

void CH.Regatron.HPPS.Device.TCLIN.GetMppVoltageAndCurrent ( ref double  mppVoltage,
ref double  mppCurrent 
)

This method returns the MPP data (voltage, current)of this TCLIN.

Parameters
mppVoltageVoltage value of the MPP [V]
mppCurrentCurrent value of the MPP [A]
Exceptions
CH.Regatron.HPPS.Device.TopConCommunicationException

◆ GetPowerAverage()

double CH.Regatron.HPPS.Device.TCLIN.GetPowerAverage ( )

This method returns the average value of the output power.

Returns
Value of the maximum output power within the analysis time window [W].
Exceptions
CH.Regatron.HPPS.Device.TopConCommunicationException

◆ GetPowerMaximum()

double CH.Regatron.HPPS.Device.TCLIN.GetPowerMaximum ( )

This method returns the maximum (peak) value of the output power.

Returns
Value of the maximum output power within the analysis time window [W].
Exceptions
CH.Regatron.HPPS.Device.TopConCommunicationException

◆ GetPowerMinimum()

double CH.Regatron.HPPS.Device.TCLIN.GetPowerMinimum ( )

This method returns the mainimum value of the output power.

Returns
Value of the minimum output power within the analysis time window [W].
Exceptions
CH.Regatron.HPPS.Device.TopConCommunicationException

◆ GetPowerStats()

void CH.Regatron.HPPS.Device.TCLIN.GetPowerStats ( ref double  powerMean,
ref double  powerMin,
ref double  powerMax 
)

This method returns 3 values (as referenced parameters) that describe the actual power output.
See voltage statistics for further explanations.

Parameters
powerMeanMean value of the output power. [W] within the analysis time window.
powerMinMinimum value of the output power [W] within the analysis time window.
powerMaxMaximum value of the output power [W] within the analysis time window.
Exceptions
CH.Regatron.HPPS.Device.TopConCommunicationException

◆ GetVoltageAverage()

double CH.Regatron.HPPS.Device.TCLIN.GetVoltageAverage ( )

This method returns the average value of the output voltage.

Returns
Value of the maximum output voltage within the analysis time window [V].
Exceptions
CH.Regatron.HPPS.Device.TopConCommunicationException

◆ GetVoltageMaximum()

double CH.Regatron.HPPS.Device.TCLIN.GetVoltageMaximum ( )

This method returns the maximum (peak) value of the output voltage.

Returns
Value of the maximum output voltage within the analysis time window [V].
Exceptions
CH.Regatron.HPPS.Device.TopConCommunicationException

◆ GetVoltageMinimum()

double CH.Regatron.HPPS.Device.TCLIN.GetVoltageMinimum ( )

This method returns the mainimum value of the output voltage.

Returns
Value of the minimum output voltage within the analysis time window [V].
Exceptions
CH.Regatron.HPPS.Device.TopConCommunicationException

◆ GetVoltageStats()

void CH.Regatron.HPPS.Device.TCLIN.GetVoltageStats ( ref double  voltageMean,
ref double  voltageMin,
ref double  voltageMax 
)

This method returns 3 values (as referenced parameters) that describe the actual output voltage.
The min and max values work similar to an audio equalizer: the values are immediately pushed to the min (max) if the current value exceeds that limit. After a short time, the values return slowly to the mean value. This can be seen as a LP filtering of the signals.

Parameters
voltageMeanMean value of the output voltage [V] within the analysis time window.
voltageMinMinimum value of the output voltage [V] within the analysis time window.
voltageMaxMaximum value of the output voltage [V] within the analysis time window.
Exceptions
CH.Regatron.HPPS.Device.TopConCommunicationException

◆ IsAlternativeCurrentRange()

Boolean CH.Regatron.HPPS.Device.TCLIN.IsAlternativeCurrentRange ( )

Check the alternative current range of the TC.LIN

Returns
true if alternativ range is set, false otherwise
Exceptions
CH.Regatron.HPPS.Device.TopConCommunicationException