This class is for accessing Seci via COM. The COM interface is registered when Seci starts and unregistered when Seci closes; this means if Seci is not running then the COM call will fail. All COM connections will go to the same instance of Seci rather than starting a new instance. More...

#include <ComInterface.cs>

Inheritance diagram for Seci.Remoting.ComInterface:

Collaboration diagram for Seci.Remoting.ComInterface:

Public Member Functions
	ComInterface ()
	The constructor More...

void	DisposeCom ()
	Unregisters the interface from COM. More...

void	InitialiseCom ()
	Registers the interface with COM. More...

Public Member Functions inherited from Seci.Remoting.IComInterface
Boolean	SetRunControl (String blockName, Boolean value)

Boolean	UnderRunControl (String blockName)

Private Member Functions
int IComInterface.	AreYouThere ()
	Test COM method. More...

Boolean IComInterface.	BlocksLoggingStatus ()

int IComInterface.	ChangeConfiguration (String configName)

void IComInterface.	ClearGraphs ()

void IComInterface.	EnableBlocksLogging (Boolean enable)

String[] IComInterface.	GetBlockNames (Boolean includeHidden)
	Method for getting Block names More...

String IComInterface.	GetBlockValueString (String blockName)
	Method for retrieving a Block's value. More...

String[] IComInterface.	GetConfigurations ()

object IComInterface.	GetRawBlockValue (String blockname)
	Method for getting Block value directly from LabVIEW More...

object IComInterface.	GetRawSetpoint (String blockname)
	Method for getting Block setpoint value directly from LabVIEW More...

String[] IComInterface.	GetVIsFullpath ()

Boolean IComInterface.	IsSeciBusy ()

Boolean IComInterface.	SetRawBlockValue (String blockName, Object value)

Boolean IComInterface.	SetRunControl (string blockName, bool value)

Boolean IComInterface.	UnderRunControl (string blockName)

Private Attributes
int	_cookie

RegistrationServices	_regServices

Detailed Description

This class is for accessing Seci via COM. The COM interface is registered when Seci starts and unregistered when Seci closes; this means if Seci is not running then the COM call will fail. All COM connections will go to the same instance of Seci rather than starting a new instance.

Author: Matt Clarke, ISIS

The ComInterface class. This class is for accessing SECI via COM. It was required that all COM connections would go to the existing SECI rather than starting a new instance. This is done by creating a COM visible class that contains a DotNet Remoting client that connects to SECI; so, essentially you have a COM visible object in SECI that talks to the rest of SECI via DotNet Remoting. It is not the most elegant method, but it is the only way that has worked so far. Note: connecting via COM gives access to the ReadWriteRemoting object.

Definition at line 21 of file ComInterface.cs.

Constructor & Destructor Documentation

Seci.Remoting.ComInterface.ComInterface ( )

inline

The constructor

Definition at line 29 of file ComInterface.cs.

Member Function Documentation

int IComInterface. Seci.Remoting.ComInterface.AreYouThere ( )

inlineprivate

Test COM method.

Returns: An integer of value 0 (S_OK)

Implements Seci.Remoting.IComInterface.

Definition at line 59 of file ComInterface.cs.

Boolean IComInterface. Seci.Remoting.ComInterface.BlocksLoggingStatus ( )

inlineprivate

Implements Seci.Remoting.IComInterface.

Definition at line 170 of file ComInterface.cs.

int IComInterface. Seci.Remoting.ComInterface.ChangeConfiguration ( String configName )

inlineprivate

Implements Seci.Remoting.IComInterface.

Definition at line 145 of file ComInterface.cs.

void IComInterface. Seci.Remoting.ComInterface.ClearGraphs ( )

inlineprivate

Implements Seci.Remoting.IComInterface.

Definition at line 140 of file ComInterface.cs.

void Seci.Remoting.ComInterface.DisposeCom ( )

inline

Unregisters the interface from COM.

Definition at line 47 of file ComInterface.cs.

void IComInterface. Seci.Remoting.ComInterface.EnableBlocksLogging ( Boolean enable )

inlineprivate

Implements Seci.Remoting.IComInterface.

Definition at line 165 of file ComInterface.cs.

String [] IComInterface. Seci.Remoting.ComInterface.GetBlockNames ( Boolean includeHidden )

inlineprivate

Method for getting Block names

Parameters

includeHidden Include non-visible Blocks

Returns

Implements Seci.Remoting.IComInterface.

Definition at line 79 of file ComInterface.cs.

String IComInterface. Seci.Remoting.ComInterface.GetBlockValueString ( String blockName )

inlineprivate

Method for retrieving a Block's value.

Parameters

blockName The name of the Block

Returns: Block value as a String (_bstr_t)

Implements Seci.Remoting.IComInterface.

Definition at line 69 of file ComInterface.cs.

String [] IComInterface. Seci.Remoting.ComInterface.GetConfigurations ( )

inlineprivate

Implements Seci.Remoting.IComInterface.

Definition at line 155 of file ComInterface.cs.

object IComInterface. Seci.Remoting.ComInterface.GetRawBlockValue ( String blockname )

inlineprivate

Method for getting Block value directly from LabVIEW

Parameters

blockname The name of the block

Returns: The current value (variant_t)

Implements Seci.Remoting.IComInterface.

Definition at line 89 of file ComInterface.cs.

object IComInterface. Seci.Remoting.ComInterface.GetRawSetpoint ( String blockname )

inlineprivate

Method for getting Block setpoint value directly from LabVIEW

Parameters

blockname The name of the block

Returns: The current setpoint (variant_t)

Implements Seci.Remoting.IComInterface.

Definition at line 99 of file ComInterface.cs.

String [] IComInterface. Seci.Remoting.ComInterface.GetVIsFullpath ( )

inlineprivate

Implements Seci.Remoting.IComInterface.

Definition at line 150 of file ComInterface.cs.

void Seci.Remoting.ComInterface.InitialiseCom ( )

inline

Registers the interface with COM.

Definition at line 36 of file ComInterface.cs.

Boolean IComInterface. Seci.Remoting.ComInterface.IsSeciBusy ( )

inlineprivate

Implements Seci.Remoting.IComInterface.

Definition at line 160 of file ComInterface.cs.

Boolean IComInterface. Seci.Remoting.ComInterface.SetRawBlockValue	(	String	blockName,
		Object	value
	)

inlineprivate

Parameters

blockName
value

Returns

Implements Seci.Remoting.IComInterface.

Definition at line 110 of file ComInterface.cs.

Boolean IComInterface. Seci.Remoting.ComInterface.SetRunControl	(	string	blockName,
		bool	value
	)

inlineprivate

Definition at line 120 of file ComInterface.cs.

References Seci.Remoting.Bridge.GetLabViewValue().

Here is the call graph for this function:

Boolean IComInterface. Seci.Remoting.ComInterface.UnderRunControl ( string blockName )

inlineprivate

Definition at line 115 of file ComInterface.cs.

Member Data Documentation

int Seci.Remoting.ComInterface._cookie

private

Definition at line 24 of file ComInterface.cs.

RegistrationServices Seci.Remoting.ComInterface._regServices

private

Definition at line 23 of file ComInterface.cs.

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

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation