TopCon API  1.1.0
.Net API to control TopCon devices
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123456]
 NCH
 NRegatron
 NHPPS
 NDevice
 NErrorWarning
 CErrorHistoryItemThe ErrorItem is one element of the ErrorHistory
 CErrorHistoryItemListA List of ErrorHistoryItems
 CErrorItemThe ErrorItem is one element of the ErrorTree/WarningTree
 CErrorItemListA List of ErrorItems
 CErrorListThis ErrorHistory is a generic list of TopConErrorState objects. The list might be a part of the overall list (from inside of the TopCon device) or might represent the whole list (transmission might be (very) slow, depending on the length of items in the TopCon device
 CTCLINThis class implements the functionality for TC.LIN module values
 CTopConThis is the main TopCon object
 CDeviceControlModeGets Data about the actual state of device control mode
 CTopConCofigurationExceptionThis Exception is thrown when a configuration error occurs
 CTopConCommunicationExceptionThis Exception is thrown when a communication error occurs. The internal error can be automatically cleared, by using autoClearError Then failed communication can directly be repeated
 CTopConConfigurationThis class is the location to hold the configuration information of the present TopCon system
 CTopConExceptionThis Exception is thrown when a generic error occurs
 NEnergyStorage
 NBatSimulation
 CActualBatteryValuesActual battery values
 CBatterySimulationCentral class for Battery simulation. You cannot create an object for this type over new command. To obtain that object call the function: GetBatterySimulationObject() from topCon object. Example: var batSimulation = myTopCon.GetBatterySimulationObject(); If the TC device is disconnected or the option BatSim is not installed into the TC device, you get a null object
 CBatterySimulationStateExceptionThis exception is thrown by calling not allowed operations for an state. Example: Current state is Started and the ResumeSimulation() function is called!
 NSolarArraySimulation
 CCalculatedSASCurveComponentThis is the main component (used as current functionBlock that makes up calculated SASCurve)
 CChannelDefinitionsThis class implements the list of DataCollector channels that can be used in the DataCollector
 CCSi_TechnologyModelThis class defines all CSI solar array related parameters technology model. The user can derive own technology models from this one and modify the settings with the getter/setter methods
 CCustomSASCurveComponent
 CDataCollector
 CDC_ScopeChannel
 CMPPDataMPPData is a class that holds data of solar panels.
If the users wants to define the panel by giving the PanelData ( Uoc, Isc), please use the PanelData class
 CPanelDataThis class contains key data of the solar panel (Uoc (open circuit voltage) and Isc (shortcut current)
 CSASCurveComponentThis is the abstract base class for CUSTOM and CALCULATED CurveComponents.
You cannot instantiate objects of this class, use CustomSASCurveComponent or CalculatedSASCurveComponent instead
 CSolarArrayTechnologyModel
 CTF_TechnologyModelThis class defines all THINFILM solar array related parameters technology model. The user can derive own technology models from this one and modify the settings with the getter/setter methods
 CUserDefined_TechnologyModelThis class allows to define own models for the underlying 1-diode-model
 NTFE
 CAAPCurve_IUthis class denotes the AAPCurve of the IU type (only the current controller has a special role, it works as 'current = f ( voltage)' controller)
 CAAPCurveComponentThis class is a CurveComponent that keeps a set of Points
 CAAPCurvePointThis class represents the AAP curve points
 CAAPCurvePointListThis class is a special CurvePointList with a maximum capacity of 64 points.
It is intended to use this CurvePointList for the initialization of all AAP and SASCurves.
It is not recommended for use with userDefinedCurves
 CCurveComponentThis class is a collector class to build a common base for all curveComponents. A CurveComponent is a rule system (set of configuration settings) for one of the three controllers built into the TopCon device (U, I, P controller).
Example of a complex rule system for being executed by the current controller and (at the same time) the voltage controller. The power controller is not affected by those two 'rules'.
Example:
a) The current controller should follow a rectangle pattern with a 30% duty cycle.
b) The voltage controller should follow a sinus pattern with 10 Hz frequency and an offset of 15Volts.
Therefore the curve that is to be defined must consist of two CurveComponents, one of type VOLTAGEComponent and the other of type CURRENTComponent. The not used power controller remains undefined.
 CCurveContainerThis class is an optimized transport container of one curve's raw data. Use it if no internal components of the curve are to be used on the PC side (e.g. if only loading curve data from one TopCon, storing them on the PC and storing them on other TopCon devices
 CCurveFactory
 CCurveListThis class implements the CurveList that resides inside of the TopCon device (physically in the TopCon or in the virtual correspondant)
 CCurvePointThis class defines objects of the data type "CurvePoints". They consist of general (x,y) - coordinate pairs.
 CCurvePointListThis class covers a set of points and is used in all AAP based curves. It is declared 'abstract' so that it cannot be implemented, instead use the derived classes (e.g. AAPCurvePointList, UserDefinedCurvePointList)
 CFunctionAapData
 CFunctionBlock
 CFunctionEngineThis class implements the FunctionEngine that resides inside of the TopCon device (physically in the TopCon or in the virtual correspondant). It is derived from the CurveList as it contains the
 CLinesCurveComponentThis is a wrapper class to cover all aspects that Rectangle and Triangle curve have in common.
Do not use this, instead instantiate objects of the following classes:
 CRectangleCurveComponentA rectangle curve is a time-based (non-sinus) curve with a rectangle pattern. Use convenience constructor or use setter methods to set Amplitude, Offset, Frequency, Symmetry (minimum configuration)
 CSineCurveComponentClass representing sinusodial curves (sinus curve). Use convenience constructor or use setter methods to set Amplitude, Offset, Frequency (minimum configuration)
 CStandardTimeBasedCurveComponentThis class is the base class for Sinus, Rectangle and Triangle curves. It should never be instantiated directly
 CTFECurveThis class is the container that represents a curve. It can hold SeqNumber, SeqName and so on. Thus it is prepared to be stored in the TopCon SequenceHeaderFile.
Or it is just a container to keep the U, I and P curveComponents
 CTimeBasedCurveComponent
 CTriangleCurveComponentA triangle curve is a time-based curve with a triangle pattern.
Use convenience constructor or use setter methods to set Amplitude, Offset, Frequency, Symmetry (minimum configuration)
 CUserDefinedCurveComponentThis class implements all components that handle the use-defined time-based curve components
 CUserDefinedCurvePointObjects of this class contain data of points in a user defined curve. They consist of two-tupel of the format: (U/I/P-value, deltaTime). Prior to the use, the static function prepareUse has to be called to correctly initialize the use
 CUserDefinedCurvePointListThis class is a special CurvePointList with a maximum capacity of 1000 points.
It should be used with userDefinedCurves.
It is not recommended to use this CurvePointList for the initialization of all AAP and SASCurves
 CExceptionMessenger
 CIExceptionMessenger