This class is for accessing Seci from an external source. All the COM and Remoting calls go through this class. More...

Collaboration diagram for Seci.Remoting.Bridge:

Static Public Member Functions
static Boolean	AbortRun ()
	Asks the DAE to abort a run - does not check to see if the run actually aborted. More...

static Boolean	BeginRun ()
	Asks the DAE to begin a run - does not check to see if the run actually started. More...

static Boolean	BlocksLoggingStatus ()

static int	ChangeConfig (String configName)
	Request a change of configuration. May return true, but this does not mean the configuration will change. See SeciInterface.Configuration_Change method for more information. More...

static Boolean	CheckForWaitingState (String blockName)
	Check to see if a block 'wait for control' is true - if so it means the current block value may be unreliable. Example: check to see if the moving LED on VI is lit. More...

static void	ClearGraphs ()
	Requests that any graphs in the user interface are reset More...

static void	EnableBlocksLogging (Boolean enable)

static Boolean	EndRun ()
	Asks the DAE to end a run - does not check to see if the run actually ended. More...

static String[]	GetAllBlockValues (Boolean visibleOnly, Boolean includeSetpoint, Boolean includeGroup, Boolean includeWaitState)
	Get the current values of all the blocks, including any in the components. More...

static String[,]	GetBlockAliases ()
	Get the aliases of all the blocks More...

static String[]	GetBlockNames (Boolean includeHidden)
	Get the names of all the blocks More...

static String[]	GetBlockNames (Boolean includeHidden, Boolean includeAliases)
	Get the names of all the blocks More...

static String[,]	GetBlocks ()
	Get all the block information necessary for a "GetBlocks" in Open GENIE Should not be used as CSET should be done via SECI; but in case of emergency! More...

static String	GetBlockValue (String blockName)
	Get the current value of a block. The block can be in the configuration or any of the components. More...

static String	GetCurrentConfig ()
	Get the name of the current configuration. More...

static Object	GetLabViewValue (String vi, String control)
	Get value directly from LabVIEW with no checks or conversions. More...

static String[]	GetListOfConfigs ()
	Get a list of the available configurations (does not currently include components). More...

static String[,]	GetNexusInfo ()
	Gets the NeXus information for all the blocks, including those in any components. Currently, the only NeXus information is a NeXus name and group. More...

static Object	GetRawBlockValue (String blockName)

static Object	GetRawSetpoint (String blockName)
	Get the setpoint value for a block. The block can be in the configuration or any of the components. More...

static String[]	GetRunInfo ()
	Get the current run information from the DAE. More...

static String	GetRunStatus ()
	Get the current run status from the DAE. More...

static String[]	GetVIsFullpath ()

static Boolean	IsBusy ()

static Boolean	IsInRange (String blockName)
	See if a block is currently within the run-control bounds. Note: returns true if it is not under run-control, because it is technically in range. More...

static Boolean	PauseRun ()
	Asks the DAE to pause a run - does not check to see if the run actually paused. More...

static Boolean	ResumeRun ()
	Asks the DAE to resume a paused run - does not check to see if the run actually resumed. More...

static Boolean	SaveRun ()
	Asks the DAE to save a run - does not check to see if the run actually saved. More...

static Boolean	SetBlockValue (String blockName, String value)
	Set the setpoint value of a block. The block can be in the configuration or any of the components. Will check that the 'wait-for control' is not true, otherwise will not set values. More...

static Boolean	SetLabViewValue (String vi, String control, Object value)
	Set value directly in LabVIEW with no checks or conversions. More...

static Boolean	SetRawBlockValue (String blockName, object value)

static Boolean	UnderRunControl (String blockName)

Static Private Member Functions
static Boolean	checkForWaitFor (String blockName)
	Does the actual checking of the wait for indicator More...

Detailed Description

This class is for accessing Seci from an external source. All the COM and Remoting calls go through this class.

Definition at line 12 of file Bridge.cs.

Member Function Documentation

static Boolean Seci.Remoting.Bridge.AbortRun ( )

inlinestatic

Asks the DAE to abort a run - does not check to see if the run actually aborted.

Returns: result

Definition at line 494 of file Bridge.cs.

static Boolean Seci.Remoting.Bridge.BeginRun ( )

inlinestatic

Asks the DAE to begin a run - does not check to see if the run actually started.

Returns: Result

Definition at line 411 of file Bridge.cs.

static Boolean Seci.Remoting.Bridge.BlocksLoggingStatus ( )

inlinestatic

Definition at line 398 of file Bridge.cs.

static int Seci.Remoting.Bridge.ChangeConfig ( String configName )

inlinestatic

Request a change of configuration. May return true, but this does not mean the configuration will change. See SeciInterface.Configuration_Change method for more information.

Parameters

configName The name of the requested configuration

Returns: Returns an error code 0 - Okay 1 - Configuration does not exist 2 - Unknown problem

Definition at line 608 of file Bridge.cs.

static Boolean Seci.Remoting.Bridge.checkForWaitFor ( String blockName )

inlinestaticprivate

Does the actual checking of the wait for indicator

Parameters

blockName The name of the block

Returns: True means the control is true

Definition at line 335 of file Bridge.cs.

static Boolean Seci.Remoting.Bridge.CheckForWaitingState ( String blockName )

inlinestatic

Check to see if a block 'wait for control' is true - if so it means the current block value may be unreliable. Example: check to see if the moving LED on VI is lit.

Parameters

blockName The name of the block

Returns: True means the control is true

Definition at line 317 of file Bridge.cs.

static void Seci.Remoting.Bridge.ClearGraphs ( )

inlinestatic

Requests that any graphs in the user interface are reset

Definition at line 640 of file Bridge.cs.

static void Seci.Remoting.Bridge.EnableBlocksLogging ( Boolean enable )

inlinestatic

Definition at line 393 of file Bridge.cs.

static Boolean Seci.Remoting.Bridge.EndRun ( )

inlinestatic

Asks the DAE to end a run - does not check to see if the run actually ended.

Returns: Result

Definition at line 431 of file Bridge.cs.

static String [] Seci.Remoting.Bridge.GetAllBlockValues	(	Boolean	visibleOnly,
		Boolean	includeSetpoint,
		Boolean	includeGroup,
		Boolean	includeWaitState
	)

inlinestatic

Get the current values of all the blocks, including any in the components.

Parameters

visibleOnly	Whether to include only the blocks set to visible
includeSetpoint	Whether to add the setpoint to the string
includeGroup	Whether to include the group
includeWaitState	Whether to include the waiting state

Returns: A String array containing strings of the form "blockname: value"

Definition at line 143 of file Bridge.cs.

static String [,] Seci.Remoting.Bridge.GetBlockAliases ( )

inlinestatic

Get the aliases of all the blocks

Returns: A 2D String array

Definition at line 205 of file Bridge.cs.

static String [] Seci.Remoting.Bridge.GetBlockNames ( Boolean includeHidden )

inlinestatic

Get the names of all the blocks

Returns: A String array

Definition at line 159 of file Bridge.cs.

static String [] Seci.Remoting.Bridge.GetBlockNames	(	Boolean	includeHidden,
		Boolean	includeAliases
	)

inlinestatic

Get the names of all the blocks

Returns: A String array

Definition at line 170 of file Bridge.cs.

static String [,] Seci.Remoting.Bridge.GetBlocks ( )

inlinestatic

Get all the block information necessary for a "GetBlocks" in Open GENIE Should not be used as CSET should be done via SECI; but in case of emergency!

Returns: A two-dimensional String array

Definition at line 233 of file Bridge.cs.

static String Seci.Remoting.Bridge.GetBlockValue ( String blockName )

inlinestatic

Get the current value of a block. The block can be in the configuration or any of the components.

Parameters

blockName The name of the block

Returns: A String containing the block value

Definition at line 76 of file Bridge.cs.

static String Seci.Remoting.Bridge.GetCurrentConfig ( )

inlinestatic

Get the name of the current configuration.

Returns: The configuration name as a string

Definition at line 558 of file Bridge.cs.

static Object Seci.Remoting.Bridge.GetLabViewValue	(	String	vi,
		String	control
	)

inlinestatic

Get value directly from LabVIEW with no checks or conversions.

Parameters

vi	The full filepath of the VI
control	The name of the control to read

Returns: <An Object - may need to be cast by the caller/returns>

Definition at line 22 of file Bridge.cs.

Referenced by Seci.Remoting.ComInterface.SetRunControl().

static String [] Seci.Remoting.Bridge.GetListOfConfigs ( )

inlinestatic

Get a list of the available configurations (does not currently include components).

Returns: String array

Definition at line 574 of file Bridge.cs.

static String [,] Seci.Remoting.Bridge.GetNexusInfo ( )

inlinestatic

Gets the NeXus information for all the blocks, including those in any components. Currently, the only NeXus information is a NeXus name and group.

Returns: Two-dimensional String array

Definition at line 353 of file Bridge.cs.

static Object Seci.Remoting.Bridge.GetRawBlockValue ( String blockName )

inlinestatic

Definition at line 88 of file Bridge.cs.

References Seci.Definitions.BlockInfo.ParentVI, and Seci.Definitions.BlockInfo.ReadControl.

static Object Seci.Remoting.Bridge.GetRawSetpoint ( String blockName )

inlinestatic

Get the setpoint value for a block. The block can be in the configuration or any of the components.

Parameters

blockName The name of the block

Returns: An object

Definition at line 107 of file Bridge.cs.

References Seci.Definitions.BlockInfo.ParentVI, and Seci.Definitions.BlockInfo.WriteControl.

static String [] Seci.Remoting.Bridge.GetRunInfo ( )

inlinestatic

Get the current run information from the DAE.

Returns: A String array of the form "daeitem: value"

Definition at line 545 of file Bridge.cs.

static String Seci.Remoting.Bridge.GetRunStatus ( )

inlinestatic

Get the current run status from the DAE.

Returns: A String containing the current run status.

Definition at line 536 of file Bridge.cs.

static String [] Seci.Remoting.Bridge.GetVIsFullpath ( )

inlinestatic

Definition at line 53 of file Bridge.cs.

static Boolean Seci.Remoting.Bridge.IsBusy ( )

inlinestatic

Definition at line 628 of file Bridge.cs.

static Boolean Seci.Remoting.Bridge.IsInRange ( String blockName )

inlinestatic

See if a block is currently within the run-control bounds. Note: returns true if it is not under run-control, because it is technically in range.

Parameters

blockName The name of the block

Returns: Boolean indicating whether it is in the run-control range

Definition at line 388 of file Bridge.cs.

static Boolean Seci.Remoting.Bridge.PauseRun ( )

inlinestatic

Asks the DAE to pause a run - does not check to see if the run actually paused.

Returns: Result

Definition at line 452 of file Bridge.cs.

static Boolean Seci.Remoting.Bridge.ResumeRun ( )

inlinestatic

Asks the DAE to resume a paused run - does not check to see if the run actually resumed.

Returns: Result

Definition at line 473 of file Bridge.cs.

static Boolean Seci.Remoting.Bridge.SaveRun ( )

inlinestatic

Asks the DAE to save a run - does not check to see if the run actually saved.

Returns: Result

Definition at line 515 of file Bridge.cs.

static Boolean Seci.Remoting.Bridge.SetBlockValue	(	String	blockName,
		String	value
	)

inlinestatic

Set the setpoint value of a block. The block can be in the configuration or any of the components. Will check that the 'wait-for control' is not true, otherwise will not set values.

Parameters

blockName	The name of the block
value	The value to set

Returns: True means the value was sent to LabVIEW

Definition at line 254 of file Bridge.cs.

References Seci.Definitions.BlockInfo.BlockEnabled, Seci.BlockDictionary.Contains(), Seci.BlockDictionary.Count, Seci.Definitions.BlockInfo.GoButton, Seci.Definitions.BlockInfo.ParentVI, and Seci.Definitions.BlockInfo.WriteControl.

Here is the call graph for this function:

static Boolean Seci.Remoting.Bridge.SetLabViewValue	(	String	vi,
		String	control,
		Object	value
	)

inlinestatic

Set value directly in LabVIEW with no checks or conversions.

Parameters

vi	The full filepath of the VI
control	The name of the control to set
value	The value to set

Returns: True means the value was set

Definition at line 41 of file Bridge.cs.

static Boolean Seci.Remoting.Bridge.SetRawBlockValue	(	String	blockName,
		object	value
	)

inlinestatic

Definition at line 120 of file Bridge.cs.

References Seci.Definitions.BlockInfo.ParentVI, and Seci.Definitions.BlockInfo.WriteControl.

static Boolean Seci.Remoting.Bridge.UnderRunControl ( String blockName )

inlinestatic

See if a block is currently under run-control.

Parameters

blockName The name of the block

Returns: Boolean indicating whether it is under run-control

Definition at line 305 of file Bridge.cs.

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

/isis2/instcontrol_temp/NewSECI/Sample_Environment_Control_Interface/Seci/Remoting/Bridge.cs

Static Public Member Functions

Static Private Member Functions

Detailed Description

Member Function Documentation