This class is used for wrapping standard executables that are included as part of a configuration. This is usually used for programmes such as script generators etc. This class makes some use of WinAPI commands for showing, hiding and moving windows. More...

Inheritance diagram for Seci.Definitions.Executable:

Collaboration diagram for Seci.Definitions.Executable:

Public Member Functions
void	Dispose ()
	Public Dispose Method - member of IDisposable. The loaded executable is unmanaged so it needs to be disposed of safely. The Dispose method will do this and SuppressFinalize will remove the executable from the list of resources the garbage collector need to deal with. Added exception handling in case the executable has been closed by the user. More...

	Executable ()
	Standard Constructor - neccessary for XML deserialisation. More...

	Executable (String filepath)
	Recommended Constructor for use in code. More...

void	GetPosition ()
	Method for getting the position of an executable's window. First checks that the window is not minimised. Uses the IsIconic and GetWindowRect methods from the WinAPI. More...

Boolean	Hide ()
	Method for hiding the executable - uses the ShowWindow method from the WinAPI. More...

void	Load ()
	Method for creating the executable's process. More...

void	Move ()
	Method for moving an executable's window. This is usually done after the executable is loaded, so it returns to the right position. Uses the MoveWindow method from the WinAPI. More...

void	Move (int xPos, int yPos)
	Overloaded method for moving an executable's window. Uses the MoveWindow method from the WinAPI. More...

Boolean	Show ()
	Method for showing the executable and bringing it to the front. Uses the ShowWindow and SetForegroundWindow methods from the WinAPI. More...

Protected Member Functions
virtual void	Dispose (Boolean disposing)
	Protected Dispose Method - member of IDisposable. If the value passed it true then the method has been called directly or indirectly from SECI code. If the value passed is false then the method has been called by the runtime from inside the finalizer. More...

Properties
String	FilePath `[get, set]`

String	Name `[get, set]`

String	OwningComponent `[get, set]`

int	PositionX `[get, set]`

int	PositionY `[get, set]`

Private Member Functions
void	getSize ()
	Method for getting the size of an executable's window. First checks that the window is not minimised. Uses the IsIconic and GetWindowRect methods from the WinAPI. More...

	~Executable ()
	This destructor will run only if the Dispose method does not get called. More...

Private Attributes
bool	_disposed

String	_filePath

int	_height

String	_name

String	_owningComponent

int	_positionX
	The component to which this exe belongs. More...

int	_positionY

Process	_process

int	_width

Detailed Description

This class is used for wrapping standard executables that are included as part of a configuration. This is usually used for programmes such as script generators etc. This class makes some use of WinAPI commands for showing, hiding and moving windows.

Definition at line 15 of file Executable.cs.

Constructor & Destructor Documentation

Seci.Definitions.Executable.Executable ( )

inline

Standard Constructor - neccessary for XML deserialisation.

Definition at line 38 of file Executable.cs.

Seci.Definitions.Executable.Executable ( String filepath )

inline

Recommended Constructor for use in code.

Parameters

filepath The full filepath of the executable

Definition at line 47 of file Executable.cs.

Seci.Definitions.Executable.~Executable ( )

inlineprivate

This destructor will run only if the Dispose method does not get called.

Definition at line 194 of file Executable.cs.

Member Function Documentation

void Seci.Definitions.Executable.Dispose ( )

inline

Public Dispose Method - member of IDisposable. The loaded executable is unmanaged so it needs to be disposed of safely. The Dispose method will do this and SuppressFinalize will remove the executable from the list of resources the garbage collector need to deal with. Added exception handling in case the executable has been closed by the user.

Definition at line 179 of file Executable.cs.

virtual void Seci.Definitions.Executable.Dispose ( Boolean disposing )

inlineprotectedvirtual

Protected Dispose Method - member of IDisposable. If the value passed it true then the method has been called directly or indirectly from SECI code. If the value passed is false then the method has been called by the runtime from inside the finalizer.

Parameters

disposing Indicates what has called the Dispose method

Definition at line 207 of file Executable.cs.

void Seci.Definitions.Executable.GetPosition ( )

inline

Method for getting the position of an executable's window. First checks that the window is not minimised. Uses the IsIconic and GetWindowRect methods from the WinAPI.

Definition at line 127 of file Executable.cs.

void Seci.Definitions.Executable.getSize ( )

inlineprivate

Method for getting the size of an executable's window. First checks that the window is not minimised. Uses the IsIconic and GetWindowRect methods from the WinAPI.

Definition at line 108 of file Executable.cs.

Boolean Seci.Definitions.Executable.Hide ( )

inline

Method for hiding the executable - uses the ShowWindow method from the WinAPI.

Returns: Result

Definition at line 80 of file Executable.cs.

void Seci.Definitions.Executable.Load ( )

inline

Method for creating the executable's process.

Definition at line 61 of file Executable.cs.

void Seci.Definitions.Executable.Move ( )

inline

Method for moving an executable's window. This is usually done after the executable is loaded, so it returns to the right position. Uses the MoveWindow method from the WinAPI.

Definition at line 146 of file Executable.cs.

void Seci.Definitions.Executable.Move	(	int	xPos,
		int	yPos
	)

inline

Overloaded method for moving an executable's window. Uses the MoveWindow method from the WinAPI.

Parameters

xPos	New x position for the top-left corner of the window
yPos	New y position for the top-left corner of the window

Definition at line 159 of file Executable.cs.

Boolean Seci.Definitions.Executable.Show ( )

inline

Method for showing the executable and bringing it to the front. Uses the ShowWindow and SetForegroundWindow methods from the WinAPI.

Returns: Result

Definition at line 95 of file Executable.cs.

Member Data Documentation

bool Seci.Definitions.Executable._disposed

private

Definition at line 26 of file Executable.cs.

String Seci.Definitions.Executable._filePath

private

Definition at line 19 of file Executable.cs.

int Seci.Definitions.Executable._height

private

Definition at line 24 of file Executable.cs.

String Seci.Definitions.Executable._name

private

Definition at line 18 of file Executable.cs.

String Seci.Definitions.Executable._owningComponent

private

Definition at line 20 of file Executable.cs.

int Seci.Definitions.Executable._positionX

private

The component to which this exe belongs.

Definition at line 21 of file Executable.cs.

int Seci.Definitions.Executable._positionY

private

Definition at line 22 of file Executable.cs.

Process Seci.Definitions.Executable._process

private

Definition at line 25 of file Executable.cs.

int Seci.Definitions.Executable._width

private

Definition at line 23 of file Executable.cs.

Property Documentation

String Seci.Definitions.Executable.FilePath

getset

Definition at line 30 of file Executable.cs.

Referenced by Seci.Managers.ExecutableMgr.AddExecutable().

String Seci.Definitions.Executable.Name

getset

Definition at line 29 of file Executable.cs.

String Seci.Definitions.Executable.OwningComponent

getset

Definition at line 33 of file Executable.cs.

int Seci.Definitions.Executable.PositionX

getset

Definition at line 31 of file Executable.cs.

int Seci.Definitions.Executable.PositionY

getset

Definition at line 32 of file Executable.cs.

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

/isis2/instcontrol_temp/NewSECI/Sample_Environment_Control_Interface/Seci/Definitions/Executable.cs

Public Member Functions

Protected Member Functions

Properties

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation