C# Class HandCoded.Framework.Application

The Application class provides a basic application framework. Derived classes extend its functionality and specialise it to a particular task.

Inheritance: Process

Mostrar archivo Open project: formicary/fpml-toolkit-csharp Class Usage Examples

Public Methods

Method	Description
GetAllAssemblies ( ) : List	Returns a list of all the assemblies that are referenced by the executing application.
GetType ( string name ) : Type	Searches all of the assemblies that comprise the current application to locate a Type instance for the indicated type name.
PathTo ( string where ) : string	Derives the path to the indicated location relative to the applications data directory.
Run ( string arguments ) : void	Causes the Application to process it's command line arguments and begin the execution cycle.
ToString ( ) : string	Converts the instance data members to a string representation that can be displayed for debugging purposes.

Protected Methods

Method	Description
Application ( ) : System	Constructs an Application instance and records it.
DescribeArguments ( ) : string	Provides a text description of the arguments expected after the options (if any), for example "file ...". This method should be overridedn in a derived class requiring an non-empty argument list.
StartUp ( ) : void	Provides an Application with a chance to perform any initialisation. This implementation checks for the -help option. Derived classes may extend the functionality.
ToDebug ( ) : string	Converts the instance's member values to string representations and concatenates them all together. This function is used by ToString and my be overwritten in derived classes.

Method Details

Application() protected method

Constructs an Application instance and records it.

protected Application ( ) : System
return	System

DescribeArguments() protected method

Provides a text description of the arguments expected after the options (if any), for example "file ...". This method should be overridedn in a derived class requiring an non-empty argument list.

protected DescribeArguments ( ) : string
return	string

GetAllAssemblies() public static method

Returns a list of all the assemblies that are referenced by the executing application.

public static GetAllAssemblies ( ) : List
return	List

GetType() public static method

Searches all of the assemblies that comprise the current application to locate a Type instance for the indicated type name.

public static GetType ( string name ) : Type
name	string	The qualified name of the required type.
return	System.Type

PathTo() public static method

Derives the path to the indicated location relative to the applications data directory.

public static PathTo ( string where ) : string
where	string	The target location.
return	string

Run() public method

Causes the Application to process it's command line arguments and begin the execution cycle.

public Run ( string arguments ) : void
arguments	string	The array of command line arguments.
return	void

StartUp() protected method

Provides an Application with a chance to perform any initialisation. This implementation checks for the -help option. Derived classes may extend the functionality.

protected StartUp ( ) : void
return	void

ToDebug() protected method

Converts the instance's member values to string representations and concatenates them all together. This function is used by ToString and my be overwritten in derived classes.

protected ToDebug ( ) : string
return	string

ToString() public method

Converts the instance data members to a string representation that can be displayed for debugging purposes.

public ToString ( ) : string
return	string