Regatron.G5.Api.System.ActiveInterface Class Reference

Public Member Functions
void	SetAccessMode (ActiveInterfaceAccessMode accessMode)
	Set an access mode.
ActiveInterfaceAccessMode	GetAccessMode ()
	Returns the actual access mode.
void	RequestInterface (ActiveInterfaceAccessMode accessMode)
	Request the active interface with the desired access mode. Throws an exception if access option is set to "Locked".
void	TransferInterface (ActiveInterfaceId interfaceId)
	Transfer the active interface to another interface.
ActiveInterfaceInformationDetails	GetActiveInterfaceInformation ()
	Returns the interface information of the currently active interface.
Boolean	HasActiveInterface ()
	Returns a boolean value whether the calling instance has the active interface.
IList< ActiveInterfaceInformationDetails >	GetConnectedInterfaces ()
	Returns the interface informations of the connected interfaces.

Member Function Documentation

GetAccessMode()

ActiveInterfaceAccessMode Regatron.G5.Api.System.ActiveInterface.GetAccessMode ( )

inline

Returns the actual access mode.

Returns

Actual access mode.

Exceptions

G5ApiException

GetActiveInterfaceInformation()

ActiveInterfaceInformationDetails Regatron.G5.Api.System.ActiveInterface.GetActiveInterfaceInformation ( )

inline

Returns the interface information of the currently active interface.

Returns

Interface information of the currently active interface

Exceptions

G5ApiException

GetConnectedInterfaces()

IList< ActiveInterfaceInformationDetails > Regatron.G5.Api.System.ActiveInterface.GetConnectedInterfaces ( )

inline

Returns the interface informations of the connected interfaces.

Returns

List of connected interfaces

Exceptions

G5ApiException

HasActiveInterface()

Boolean Regatron.G5.Api.System.ActiveInterface.HasActiveInterface ( )

inline

Returns a boolean value whether the calling instance has the active interface.

Returns

Boolean to indicate whether the calling instance has the active interface.

Exceptions

G5ApiException

RequestInterface()

void Regatron.G5.Api.System.ActiveInterface.RequestInterface ( ActiveInterfaceAccessMode accessMode )

inline

Request the active interface with the desired access mode. Throws an exception if access option is set to "Locked".

Parameters

accessMode

Exceptions

G5ApiException

SetAccessMode()

void Regatron.G5.Api.System.ActiveInterface.SetAccessMode ( ActiveInterfaceAccessMode accessMode )

inline

Set an access mode.

Parameters

accessMode

Exceptions

G5ApiException

TransferInterface()

void Regatron.G5.Api.System.ActiveInterface.TransferInterface ( ActiveInterfaceId interfaceId )

inline

Transfer the active interface to another interface.

Parameters

interfaceId

Exceptions

G5ApiException