SECI  1
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events
Static Public Member Functions | Properties | Static Private Attributes | List of all members
Seci.Standard.BeamlineParameters Class Reference

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

Collaboration diagram for Seci.Standard.BeamlineParameters:
Collaboration graph

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 Beamline Parameters VI

Definition at line 11 of file BeamlineParameters.cs.

Member Function Documentation

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

Adds a standard parameter to the VI.

Parameters
indexThe index of the standard parameter to add/change
valueThe value to set

Definition at line 114 of file BeamlineParameters.cs.

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

Adds a custom parameter to the VI.

Parameters
nameThe name of the custom parameter to add/change
typeIndexThe index of the standard parameter to set
unitsThe units
valueThe value to set

Definition at line 135 of file BeamlineParameters.cs.

static List<String> Seci.Standard.BeamlineParameters.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 BeamlineParameters.cs.

static String [,] Seci.Standard.BeamlineParameters.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 BeamlineParameters.cs.

static List<String> Seci.Standard.BeamlineParameters.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 BeamlineParameters.cs.

static void Seci.Standard.BeamlineParameters.HideVi ( )
inlinestatic

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

Definition at line 42 of file BeamlineParameters.cs.

static void Seci.Standard.BeamlineParameters.Initialise ( )
inlinestatic

Method for loading and starting the VI.

Definition at line 20 of file BeamlineParameters.cs.

static void Seci.Standard.BeamlineParameters.RemoveParameter ( String  name)
inlinestatic

Remove a parameter to the VI.

Parameters
nameThe name of the custom parameter to remove

Definition at line 155 of file BeamlineParameters.cs.

static void Seci.Standard.BeamlineParameters.ShowVi ( )
inlinestatic

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

Definition at line 34 of file BeamlineParameters.cs.

Member Data Documentation

String Seci.Standard.BeamlineParameters._filePath
staticprivate

Definition at line 13 of file BeamlineParameters.cs.

Property Documentation

String Seci.Standard.BeamlineParameters.FilePath
staticget

Definition at line 15 of file BeamlineParameters.cs.


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