Regatron.G5.Api.System.ParameterSetConfiguration Class Reference

This class provides methods for accessing
or modifying parameter set information. More...

Public Member Functions
UInt16	GetNumberOfParameterSets ()
	Gets the number of defined parameter sets.
IList< ParameterSetInformation >	GetParameterSetInformationList ()
	Returns a list of ParameterSetInformation containing information of the parameter sets.
ParameterSetInformation	GetParameterSetInformation (UInt16 setId)
	Returns the parameter set information of a specific set-id.
UInt16	GetLoadedParameterSetId ()
	Returns the set-id of a currently loaded parameter set.
UInt16	GetAutoLoadParameterSetId ()
	Returns the set-id of a parameter set configured for auto load.
bool	EnableAutoLoad (UInt16 setId)
	Enables the auto load configuration of an existing parameter set.
bool	DisableAutoLoad ()
	Disables the auto load configuration of any parameter set.
bool	LoadParameterSet (UInt16 setId)
	Loads a specific parameter set if it exists.
bool	StoreParameterSet (UInt16 setId)
	Stores a preloaded parameter set id. The parameter set id to store has to match the previously loaded parameter set id.

Detailed Description

This class provides methods for accessing
or modifying parameter set information.

Member Function Documentation

DisableAutoLoad()

bool Regatron.G5.Api.System.ParameterSetConfiguration.DisableAutoLoad ( )

inline

Disables the auto load configuration of any parameter set.

Caution: When setting the AutoLoad the G5.System will automatically force a "store settings".

Exceptions

G5ApiException

Returns

true if auto load was successfully disabled

EnableAutoLoad()

bool Regatron.G5.Api.System.ParameterSetConfiguration.EnableAutoLoad ( UInt16 setId )

inline

Enables the auto load configuration of an existing parameter set.

Caution: When setting the AutoLoad the G5.System will automatically force a "store settings".

Parameters

setId

Exceptions

G5ApiException

Returns

true if auto load was successfully enabled

GetAutoLoadParameterSetId()

UInt16 Regatron.G5.Api.System.ParameterSetConfiguration.GetAutoLoadParameterSetId ( )

inline

Returns the set-id of a parameter set configured for auto load.

Exceptions

G5ApiException

Returns

UInt16 representing the set-id of the active auto load parameter set. 0 if no auto load is configured.

GetLoadedParameterSetId()

UInt16 Regatron.G5.Api.System.ParameterSetConfiguration.GetLoadedParameterSetId ( )

inline

Returns the set-id of a currently loaded parameter set.

Exceptions

G5ApiException

Returns

UInt16 representing the currently loaded set-id. 0 if no parameter set is loaded.

GetNumberOfParameterSets()

UInt16 Regatron.G5.Api.System.ParameterSetConfiguration.GetNumberOfParameterSets ( )

inline

Gets the number of defined parameter sets.

Exceptions

G5ApiException

Returns

UInt16 representing the number of parameter sets.

GetParameterSetInformation()

ParameterSetInformation Regatron.G5.Api.System.ParameterSetConfiguration.GetParameterSetInformation ( UInt16 setId )

inline

Returns the parameter set information of a specific set-id.

Parameters

setId

Exceptions

G5ApiException

Returns

ParameterSetInformation

GetParameterSetInformationList()

IList< ParameterSetInformation > Regatron.G5.Api.System.ParameterSetConfiguration.GetParameterSetInformationList ( )

inline

Returns a list of ParameterSetInformation containing information of the parameter sets.

Exceptions

G5ApiException

Returns

IList<ParameterSetInformation>

LoadParameterSet()

bool Regatron.G5.Api.System.ParameterSetConfiguration.LoadParameterSet ( UInt16 setId )

inline

Loads a specific parameter set if it exists.

Parameters

setId

Exceptions

G5ApiException

Returns

true if successfully loaded

StoreParameterSet()

bool Regatron.G5.Api.System.ParameterSetConfiguration.StoreParameterSet ( UInt16 setId )

inline

Stores a preloaded parameter set id. The parameter set id to store has to match the previously loaded parameter set id.

Parameters

setId

Exceptions

G5ApiException

Returns

true if successful