Regatron.G5.Api.System.G5System Class Reference

G5System is the root object of this library.
It is the entry point to all the functionality of this library.
You can create multiple number of instances by using:
Regatron.G5.Api.System.G5System.CreateSystem
. More...

Inheritance diagram for Regatron.G5.Api.System.G5System:

Public Member Functions
override List< Device >	GetDeviceList ()
	Get a list with all devices or null.
override Device	GetDevice (UInt16 deviceId)
	Get a dedicated device.
override Device	GetConnectedDevice ()
	Get the directly connected device.
Boolean	Connect (Int32 comPortNumber, Int32 baudRate)
	Connect to a device via a dedicated serial/UART port.
Boolean	Connect (Int32 comPortNumber, Int32 baudRate, Int32 timeout)
	Connect to a device via a dedicated serial/UART port.
Boolean	Connect (String targetIpAddress, UInt16 targetPortNumber)
	Connect to a device via a dedicated IP address and port.
Boolean	Connect (String targetIpAddress, UInt16 targetPortNumber, Int32 timeout)
	Connect to a device via a dedicated IP address and port.
Boolean	Connect (String targetIpAddress, UInt16 targetPortNumber, String hostIpAddress, UInt16 hostPortNumber)
	Connect to a device via a dedicated IP address and port.
Boolean	Connect (String targetIpAddress, UInt16 targetPortNumber, String hostIpAddress, UInt16 hostPortNumber, Int32 timeout)
	Connect to a device via a dedicated IP address and port.
Boolean	IsConnected ()
	Check if a device is connected.
Boolean	Disconnect ()
	Disconnect from a device.
SystemCharacteristics	GetCharacteristics ()
	Get a instance of SystemCharacteristics.
ReferenceValues	GetReferenceValues ()
	Get an instance of ReferenceValues.
Sensing	GetSensing ()
	Get an instance of Sensing.
SystemReversePolarityProtection	GetSystemReversePolarityProtection ()
ActualSystemValues	GetActualValues ()
	Get an instance of ActualSystemValues.
Commands	GetCommands ()
	Get an instance of SystemCommands.
DataExchange	GetDataExchange ()
	Get an instance of DataExchange.
FunctionGenerator	GetFunctionGenerator ()
	Get an instance of FunctionGenerator.
SolarArraySimulation	GetSolarArraySimulation ()
	Get an instance of SolarArraySimulation.
BatteryControl	GetBatteryControl ()
	Get an instance of BatteryControl.
LoadProtection	GetLoadProtection ()
	Get an instance of LoadProtection.
SystemState	GetState ()
	Get an instance of SystemState.
EthernetConfiguration	GetEthernetConfiguration ()
	Get an instance of EthernetConfiguration.
SystemInformation	GetInformation ()
	Get an instance of SystemInformation.
LicenseInformation	GetLicenseInformation ()
	Get an instance of LicenseInformation.
OutputControl	GetOutputControl ()
	Get an instance of OutputControl.
Safety	GetSafety ()
	Get an instance of Safety.
ReferenceValueSource	GetReferenceValueSource ()
	Get an instance of ReferenceValueSource.
ParameterSetConfiguration	GetParameterSetConfiguration ()
	Gets an instance of ParameterSetConfiguration.
ActiveInterface	GetActiveInterface ()
	Get an instance of ActiveInterface.
OutputMeasurement	GetOutputMeasurement ()
	Get an instance of OutputMeasurement.

Static Public Member Functions
static G5System	CreateSystem ()
	Create an instance of a G5System root object.

Static Public Attributes
static bool	InitializeLogging = true
	Use this to suppress "reinitialization" of the logging in case of the WebAPI or any other caller that also uses log4net logging.

Properties
static G5System	Instance [get]
	Get a Singleton instance of a G5System root object.

Events
G5ConnectionChangedDelegate	ConnectionChanged
	Informs whether or not there is a connection to the G5 device. In case of disconnection this can be: a) The user made the disconnection, b) Unexpected connection interruption.

Detailed Description

G5System is the root object of this library.
It is the entry point to all the functionality of this library.
You can create multiple number of instances by using:
Regatron.G5.Api.System.G5System.CreateSystem
.

Member Function Documentation

Connect() [1/6]

Boolean Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.Connect ( Int32 comPortNumber, Int32 baudRate )

inlineinherited

Connect to a device via a dedicated serial/UART port.

Parameters

comPortNumber	Number of the COM port (1 = COM1, 2 = COM2, ...)
baudRate	Baud rate. Supported values: 230400, 38400

Exceptions

ArgumentException
G5ApiException

Connect() [2/6]

Boolean Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.Connect ( Int32 comPortNumber, Int32 baudRate, Int32 timeout )

inlineinherited

Connect to a device via a dedicated serial/UART port.

Parameters

comPortNumber	Number of the COM port (1 = COM1, 2 = COM2, ...).
baudRate	Baud rate. Supported values: 230400, 38400.
timeout	Communication timeout.

Exceptions

ArgumentException
G5ApiException

Connect() [3/6]

Boolean Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.Connect ( String targetIpAddress, UInt16 targetPortNumber )

inlineinherited

Connect to a device via a dedicated IP address and port.

Parameters

targetIpAddress	IP Address of the target device in IPv4 format (e.g. "192.168.1.20").
targetPortNumber	Port number of the target. Default: 2000.

Exceptions

ArgumentNullException
ArgumentException
G5ApiException

Connect() [4/6]

Boolean Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.Connect ( String targetIpAddress, UInt16 targetPortNumber, Int32 timeout )

inlineinherited

Connect to a device via a dedicated IP address and port.

Parameters

targetIpAddress	IP Address of the target device in IPv4 format (e.g. "192.168.1.20").
targetPortNumber	Port number of the target. Default: 2000.
timeout	Port number of the target. Default: 2000.

Exceptions

ArgumentNullException
ArgumentException
G5ApiException

Connect() [5/6]

Boolean Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.Connect ( String targetIpAddress, UInt16 targetPortNumber, String hostIpAddress, UInt16 hostPortNumber )

inlineinherited

Connect to a device via a dedicated IP address and port.

Parameters

targetIpAddress	IP Address of the target device in IPv4 format (e.g. "192.168.1.20").
targetPortNumber	Port number of the target. Default: 2000.
hostIpAddress	IP Address of the host in IPv4 format (e.g. "192.168.1.10").
hostPortNumber	Port number of the host.

Exceptions

ArgumentNullException
ArgumentException
G5ApiException

Connect() [6/6]

Boolean Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.Connect ( String targetIpAddress, UInt16 targetPortNumber, String hostIpAddress, UInt16 hostPortNumber, Int32 timeout )

inlineinherited

Connect to a device via a dedicated IP address and port.

Parameters

targetIpAddress	IP Address of the target device in IPv4 format (e.g. "192.168.1.20").
targetPortNumber	Port number of the target. Default: 2000.
hostIpAddress	IP Address of the host in IPv4 format (e.g. "192.168.1.10").
hostPortNumber	Port number of the host.
timeout	Communication timeout.

Exceptions

ArgumentNullException
ArgumentException
G5ApiException

CreateSystem()

static G5System Regatron.G5.Api.System.G5System.CreateSystem ( )

inlinestatic

Create an instance of a G5System root object.

Returns

Instance of a G5System.

Disconnect()

Boolean Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.Disconnect ( )

inlineinherited

Disconnect from a device.

Exceptions

G5ApiException

GetActiveInterface()

ActiveInterface Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetActiveInterface ( )

inlineinherited

Get an instance of ActiveInterface.

Returns

System.ActiveInterface

GetActualValues()

ActualSystemValues Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetActualValues ( )

inlineinherited

Get an instance of ActualSystemValues.

Returns

System.ActualSystemValues

GetBatteryControl()

BatteryControl Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetBatteryControl ( )

inlineinherited

Get an instance of BatteryControl.

Returns

System.BatteryControl

GetCharacteristics()

SystemCharacteristics Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetCharacteristics ( )

inlineinherited

Get a instance of SystemCharacteristics.

Returns

System.SystemCharacteristics

GetCommands()

Commands Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetCommands ( )

inlineinherited

Get an instance of SystemCommands.

Returns

System.SystemCommands

GetConnectedDevice()

override Device Regatron.G5.Api.System.G5System.GetConnectedDevice ( )

inline

Get the directly connected device.

Returns

The device which is directly connected to the host.

Exceptions

G5ApiException

GetDataExchange()

DataExchange Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetDataExchange ( )

inlineinherited

Get an instance of DataExchange.

Returns

System.DataExchange

GetDevice()

override Device Regatron.G5.Api.System.G5System.GetDevice ( UInt16 deviceId )

inline

Get a dedicated device.

Parameters

deviceId

Device id of the requested device.

Returns

The device with specified id.

Exceptions

G5ApiException

GetDeviceList()

override List< Device > Regatron.G5.Api.System.G5System.GetDeviceList ( )

inline

Get a list with all devices or null.

Returns

A list all devices which are part of the connected system.

Exceptions

G5ApiException

GetEthernetConfiguration()

EthernetConfiguration Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetEthernetConfiguration ( )

inlineinherited

Get an instance of EthernetConfiguration.

Returns

System.EthernetConfiguration

GetFunctionGenerator()

FunctionGenerator Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetFunctionGenerator ( )

inlineinherited

Get an instance of FunctionGenerator.

Returns

System.FunctionGenerator

GetInformation()

SystemInformation Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetInformation ( )

inlineinherited

Get an instance of SystemInformation.

Returns

System.SystemInformation

GetLicenseInformation()

LicenseInformation Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetLicenseInformation ( )

inlineinherited

Get an instance of LicenseInformation.

Returns

System.LicenseInformation

GetLoadProtection()

LoadProtection Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetLoadProtection ( )

inlineinherited

Get an instance of LoadProtection.

Returns

System.LoadProtection

GetOutputControl()

OutputControl Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetOutputControl ( )

inlineinherited

Get an instance of OutputControl.

Returns

System.OutputControl

GetOutputMeasurement()

OutputMeasurement Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetOutputMeasurement ( )

inlineinherited

Get an instance of OutputMeasurement.

Returns

System.OutputMeasurement

GetParameterSetConfiguration()

ParameterSetConfiguration Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetParameterSetConfiguration ( )

inlineinherited

Gets an instance of ParameterSetConfiguration.

Returns

Regatron.G5.Api.System.ParameterSetConfiguration

GetReferenceValues()

ReferenceValues Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetReferenceValues ( )

inlineinherited

Get an instance of ReferenceValues.

Returns

System.ReferenceValues

GetReferenceValueSource()

ReferenceValueSource Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetReferenceValueSource ( )

inlineinherited

Get an instance of ReferenceValueSource.

Returns

System.ReferenceValueSource

GetSafety()

Safety Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetSafety ( )

inlineinherited

Get an instance of Safety.

Returns

System.Sensing

GetSensing()

Sensing Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetSensing ( )

inlineinherited

Get an instance of Sensing.

Returns

System.Sensing

GetSolarArraySimulation()

SolarArraySimulation Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetSolarArraySimulation ( )

inlineinherited

Get an instance of SolarArraySimulation.

Returns

System.SolarArraySimulation

GetState()

SystemState Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetState ( )

inlineinherited

Get an instance of SystemState.

Returns

System.SystemState

GetSystemReversePolarityProtection()

SystemReversePolarityProtection Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetSystemReversePolarityProtection ( )

inlineinherited

IsConnected()

Boolean Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.IsConnected ( )

inlineinherited

Check if a device is connected.

Returns

True: A device is connected.

False: No Device is connected.

Exceptions

G5ApiException

Member Data Documentation

InitializeLogging

bool Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.InitializeLogging = true

staticinherited

Use this to suppress "reinitialization" of the logging in case of the WebAPI or any other caller that also uses log4net logging.

Property Documentation

Instance

G5System Regatron.G5.Api.System.G5System.Instance

staticget

Get a Singleton instance of a G5System root object.

Deprecated

This property is deprecated. Use Regatron.G5.Api.System.G5System.CreateSystem() instead.

Event Documentation

ConnectionChanged

G5ConnectionChangedDelegate Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.ConnectionChanged

inherited

Informs whether or not there is a connection to the G5 device. In case of disconnection this can be: a) The user made the disconnection, b) Unexpected connection interruption.