This class is a wrapper for the Sample Parameters VI. More...

Collaboration diagram for Seci.Standard.SampleParameters:

Static Public Member Functions
static void	CreateParameter (int index, String value)
	Adds a standard parameter to the VI. More...

static void	CreateParameter (String name, int typeIndex, String units, String value)
	Adds a custom parameter to the VI. More...

static List< String >	GetParameterNames ()
	Method for retrieving the standard parameter names for creating a new parameter. More...

static String[,]	GetParameters ()
	Method for retrieving the parameters associated with the current experiment. More...

static List< String >	GetParameterTypes ()
	Method for retrieving the standard parameter types for creating a new parameter. More...

static void	HideVi ()
	Method for hiding the VI - it is hidden by default. More...

static void	Initialise ()
	Method for loading and starting the VI. More...

static void	RemoveParameter (String name)
	Remove a parameter to the VI. More...

static void	ShowVi ()
	Method for showing the VI - it is hidden by default. More...

Properties
static String	FilePath `[get]`

Static Private Attributes
static String	_filePath

Detailed Description

This class is a wrapper for the Sample Parameters VI.

Definition at line 11 of file SampleParameters.cs.

Member Function Documentation

static void Seci.Standard.SampleParameters.CreateParameter	(	int	index,
		String	value
	)

inlinestatic

Adds a standard parameter to the VI.

Parameters

index	The index of the standard parameter to add/change
value	The value to set

Definition at line 114 of file SampleParameters.cs.

static void Seci.Standard.SampleParameters.CreateParameter	(	String	name,
		int	typeIndex,
		String	units,
		String	value
	)

inlinestatic

Adds a custom parameter to the VI.

Parameters

name	The name of the custom parameter to add/change
typeIndex	The index of the standard parameter to set
units	The units
value	The value to set

Definition at line 135 of file SampleParameters.cs.

static List<String> Seci.Standard.SampleParameters.GetParameterNames ( )

inlinestatic

Method for retrieving the standard parameter names for creating a new parameter.

Returns: Returns a string array which gives the names

Definition at line 69 of file SampleParameters.cs.

static String [,] Seci.Standard.SampleParameters.GetParameters ( )

inlinestatic

Method for retrieving the parameters associated with the current experiment.

Returns: Returns a 2D string array which gives the name, type, units and value

Definition at line 51 of file SampleParameters.cs.

static List<String> Seci.Standard.SampleParameters.GetParameterTypes ( )

inlinestatic

Method for retrieving the standard parameter types for creating a new parameter.

Returns: Returns a string array which gives the types

Definition at line 95 of file SampleParameters.cs.

static void Seci.Standard.SampleParameters.HideVi ( )

inlinestatic

Method for hiding the VI - it is hidden by default.

Definition at line 42 of file SampleParameters.cs.

static void Seci.Standard.SampleParameters.Initialise ( )

inlinestatic

Method for loading and starting the VI.

Definition at line 20 of file SampleParameters.cs.

static void Seci.Standard.SampleParameters.RemoveParameter ( String name )

inlinestatic

Remove a parameter to the VI.

Parameters

name	The name of the custom parameter to remove

Definition at line 155 of file SampleParameters.cs.

static void Seci.Standard.SampleParameters.ShowVi ( )

inlinestatic

Method for showing the VI - it is hidden by default.

Definition at line 34 of file SampleParameters.cs.

Member Data Documentation

String Seci.Standard.SampleParameters._filePath

staticprivate

Definition at line 13 of file SampleParameters.cs.

Property Documentation

String Seci.Standard.SampleParameters.FilePath

staticget

Definition at line 15 of file SampleParameters.cs.

The documentation for this class was generated from the following file:

/isis2/instcontrol_temp/NewSECI/Sample_Environment_Control_Interface/Seci/Standard/SampleParameters.cs

Static Public Member Functions

Properties

Static Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation