IGLib  1.7.2
The IGLib base library for development of numerical, technical and business applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
IG.Lib.ModuleBase Class Reference

Manages basic program informatin and resources such as directories, expiration time, etc. More...

+ Inheritance diagram for IG.Lib.ModuleBase:
+ Collaboration diagram for IG.Lib.ModuleBase:

Public Member Functions

DateTime CalculateCreationTime ()
 Calculates program creation time of the current executable (the entry assembly) and returns it. More...
 
DateTime CalculateCreationTime (Type type)
 Calculates creation time of the assembly containing the specified class and returns it. More...
 
virtual bool CheckSoftwareRootValidity (string rootpath)
 Verifies whether the specified directory is a valid software root directory. Global is verified by the standard identtification file that was put into the directory at its creation. More...
 
string ToStringShort ()
 Retrurns a short string containing very basic information about the application or module. More...
 
override string ToString ()
 Returns a string containing basic data of the module or application. More...
 
virtual List< String > NoticeShort ()
 Returns a list of text lines introducing the module or application in a condensed way. More...
 
virtual List< String > Notice ()
 Returns a list of text lines introducing the module or application in. More...
 
virtual List< String > Notice (bool useCodename, bool printVersion, bool printRelease, bool printAuthor, bool printAuthorAddress, bool printWebPage, bool printEmail)
 Returns a list of text lines introducing the module or application. More...
 
virtual void LaunchInitNotice ()
 Launches initialization notice. More...
 

Static Public Member Functions

static string DecorationFrameAsterisk (List< string > lines, int indent, int padLeft, int padRight, int padTop, int padBottom)
 Returns a string containing the specified text lines in a single frame made of asterisks. More...
 
static string DecorationFrameDoubleAsterisk (List< string > lines, int indent, int padLeft, int padRight, int padTop, int padBottom)
 Returns a string containing the specified text lines in a double frame made of asterisks. More...
 
static string DecorationFrame (List< string > lines, int indent, int padLeft, int padRight, int padTop, int padBottom, char frameChar, int thickness)
 Returns a string containing the specified text lines in a frame made of one or more layers of equal characters. More...
 
static string DecorationFrameDashed (List< string > lines, int indent, int padLeft, int padRight, int padTop, int padBottom)
 Returns a string containing the specified text lines in a frame made of a single layers of dashes ('-') and vertical bars ('|'). More...
 
static string DecorationFrameDoubleDashed (List< string > lines, int indent, int padLeft, int padRight, int padTop, int padBottom)
 Returns a string containing the specified text lines in a frame made of a double layers of dashes ('-') and vertical bars ('|'). More...
 
static void AddDefaultAssembliesExtShellApp ()
 Appends list of assemblies for dynamic testing of software in the ExtShellApp project. More...
 
static void AddDefaultAssembliesExtNeuralApp ()
 Appends list of assemblies for dynamic testing of software in the ExtNeuralApp project. More...
 
static void AddDefaultAssembliesExtShellAppExt ()
 Appends list of assemblies for dynamic testing of software in the ExtShellAppExt project. More...
 

Public Attributes

XmlDocument Data =null
 
const string DefaultModuleName = "Test Library"
 
const int DefaultVersion = 0
 
String Email = null
 
String[] Authors = null
 
bool _expires = true
 

Protected Member Functions

virtual void BeforeInitialization ()
 A method called before any s initializations in constructors. Override this method in derived classes in order to achieve different behavior. More...
 
virtual void AfterInitialization ()
 A method called after any s initializations in constructors. Override this method in derived classes in order to achieve different behavior. More...
 
void InitModuleBase (string name, string codeName, int version, int subVersion, int subSubVersion, string release)
 Performs complete initialization of the program or module, including the pre-initialization and post-initialization steps. More...
 
virtual string ToCodeName (string Name)
 Converts a module or program name to a valid code name. More...
 

Static Protected Member Functions

static int MaxLength (List< string > lines)
 Maximal length of any line in the specified list. More...
 
static string MultiCharacter (char ch, int num)
 Returns a string containing the specified number of specified (equal) characters. More...
 

Protected Attributes

const int DD = 06
 
object _lock = new object()
 
string _IGHomeEnv = null
 
string[] _IGHomeEnvList
 
bool _isModule = false
 
string _Name = "IG's Test Program"
 
int _version = 0
 
int _NumVersionDigits =2
 
bool _useSubVersion = true
 
DateTime _StartTime = DateTime.Now
 
TimeSpan _ValidityPeriod =new TimeSpan(100*366,0,0,0,0)
 
string _Directory = null
 
string _modulesDir = "modules"
 
string _applicationsDir = "applications"
 
IReporter _reporter = DefaultReporter
 

Static Protected Attributes

static IReporter _defaultReporter = null
 

Properties

object Lock [get]
 Object's lock (implementation of ILockable). More...
 
string IGHomeEnv [get, protected set]
 Environment variable that holds the software root directory. More...
 
string[] IGHomeEnvList [get, protected set]
 Possible names for environment variable that holds the software root directory. More...
 
virtual string IGHomeIdFile [get, protected set]
 Name of the software root identification file This file must be contained immediately in the software root directory. Its contents is checked in order to see whether a certain directory is actually the software root directory. More...
 
virtual string IGHomeIdFileString [get, protected set]
 Name of the software root identification file This file must be contained immediately in the software root directory. Its contents is checked in order to see whether a certain directory is actually the software root directory. More...
 
string AuthorFullName [get]
 Gets a treue/false value telling whether the global program data is initialized or not. More...
 
string AuthorAddress [get]
 Gets complete developer's address (combination of individual address lines). More...
 
virtual bool IsApplication [get, protected set]
 Whether the current object represents an application. More...
 
virtual bool IsModule [get, protected set]
 Whether the current object represents a module (not an application). More...
 
virtual string Name [get, set]
 Gets or sets the full name of the program. More...
 
string CodeName [get, set]
 Gets or sets code name of the program. More...
 
int Version [get, set]
 Gets or sets the main version number of the program. More...
 
int SubVersion [get, set]
 Gets or sets the subversion number of the program. More...
 
int SubSubVersion [get, set]
 Gets or sets the sub-subversion number of the program. More...
 
string Release [get, set]
 Gets or sets the release specification of the program (e.g. "alpha", "beta", "release"...). More...
 
virtual DateTime StartTime [get, private set]
 Gets The starting time of the program (time when program data was initialized). More...
 
DateTime CreationTime [get, protected set]
 Gets or sets craation time of the program. More...
 
virtual bool Expires [get, set]
 Gets or sets the flag telling whether the program expires. More...
 
TimeSpan ValidityPeriod [get, set]
 Gets or sets the validity period length for the program. More...
 
TimeSpan ExpireWarnPeriod [get, set]
 Gets or sets the length of the expiration warning period. This is the period of time between expiration of the software and time when the software actually stops working. If not set, 0 is taken. More...
 
DateTime ExpireTime [get, set]
 Gets or sets the expiration time of the program. Property is automatically updated if the validity period is changed. More...
 
DateTime ExpireFinalTime [get, set]
 Gets or sets the time when program will stop functioning completely. More...
 
bool HasExpired [get]
 Gets the indicatin whether the program has expired. More...
 
bool HasExpiredFinal [get]
 Gets the indicatin whether the program has stopped being functional because of expiration. This happens after final expiration time has reach, which follows a certain period after the regular expiration time. More...
 
int DaysTillExpire [get]
 Gets the number of days until the expiration of the program or module (0 or negative if already expired). More...
 
int DaysTillExpireFinal [get]
 Gets the number of days until the final expiration of the program or module, when the software will stop functioning (0 or negative if already expired). More...
 
int NumVersionDigits [get, set]
 Number of digits that are output in version strings. More...
 
bool UseSubVersion [get, set]
 Whether or not subversion number is used. More...
 
bool UseSubSubVersion [get, set]
 Whether or not sub-subversion number is used. More...
 
string VersionString [get]
 Gets the string that represents program version. More...
 
string DirectoryVersionString [get]
 Gets the string representation of program version to be used in directory and file names. Sub-subversion is not included in the string. More...
 
string User [get, set]
 Gets name of the user of the program. More...
 
virtual String SoftwareParentDirectory [get]
 Gets the directory containing individual module or application directories. More...
 
virtual string BaseDirectory [get, set]
 Gets or sets the program directory (containing all version directories, user directories, etc.). Setting of program directory should normally be left to the system. More...
 
virtual string VersionDirectory [get, set]
 Gets or sets the program'result specific version directory. Setting of this directory should normally be left to the system. More...
 
virtual string UserDirectory [get, set]
 Gets or sets the spedcific user'result directory for the current version of the progrm. Setting of this directory should normally be left to the system. More...
 
virtual string SessionDirectory [get, set]
 Gets or sets the current session'result directory. Setting of this directory should normally be left to the system. More...
 
virtual string SoftwareRoot [get, protected set]
 Gets or sets the software root directory. Setting it should normally be left to the system. More...
 
IReporter Reporter [get, set]
 
static IReporter DefaultReporter [get]
 Returns the curent global Application reporter. More...
 
static DateTime AnnDllTestLimit [get]
 
static bool IsAnnDllTestMode [get]
 Whether dynamic testing of software is on (helps in agile software development). More...
 
static bool LoadableScriptShellIsLoadableDefault [get]
 Basic procedure for calculation of the flag LoadableScriptShellIsLoadable. More...
 
static bool LoadableScriptShellIsRunnableDefault [get]
 Basic procedure for calculation of the flag LoadableScriptShellIsRunnable. More...
 
- Properties inherited from IG.Lib.ILockable
object Lock [get]
 

Private Member Functions

void Dummy ()
 

Static Private Member Functions

static void AnnAdd ()
 Appends list of assemblies for dynamic testing of software. More...
 

Private Attributes

const int MM = 05
 
const int YYYY = 2013
 
string _IGHomeIdFile = "ighome.did"
 
string _IGHomeIdFileString = "/IGHOME/"
 
bool _isApplication = false
 
string _CodeName = null
 
string _Release = "Test"
 
string _User = null
 
int _SubVersion = 0
 
int _SubSubVersion = 0
 
bool _useSubSubVersion = false
 
DateTime _CreationTime = new DateTime(YYYY, MM, DD)
 
TimeSpan _ExpireWarnPeriod = new TimeSpan(60,0,0,0,0)
 
string _VersionDirectory = null
 
string _UserDirectory = null
 
string _SessionDirectory = null
 
bool ModuleBaseBeforeInitializationCalled = false
 
bool ModuleBaseAfterInitializationCalled = false
 
const string DefaultApplicationName = "Test Application"
 
const string DefaultModuleCodeName = null
 
const string DefaultApplicationCodeName = null
 
const string DefaultRelease = "final"
 
const int DefaultSubVersion = 0
 
const int DefaultSubSubVersion = 0
 
String WebPage = null
 
String Phone = null
 
String AuthorFirstName = null
 
String AuthorMidName = null
 
String AuthorSecondName = null
 
String AuthorAddress1 = null
 
String AuthorAddress2 = null
 
String AuthorAddress3 = null
 
String AuthorAddress4 = null
 
string astr =null
 
const int _maxLoadableScriptWarnings = 1
 

Static Private Attributes

static string _SoftwareRoot = null
 
static int AnnDD = 15
 
static int AnnMM = 8
 
static int AnnYY = 2014
 
static DateTime _annDllLimit = null
 
static bool _isAnnDllTestMode = null
 
static int _numLoadableScriptWarnings = 0
 

Detailed Description

Manages basic program informatin and resources such as directories, expiration time, etc.

In derived classes, override the BeforeInitialization and AfterInitialization methods.

$A Igor Jul08;

Member Function Documentation

virtual void IG.Lib.ModuleBase.BeforeInitialization ( )
inlineprotectedvirtual

A method called before any s initializations in constructors. Override this method in derived classes in order to achieve different behavior.

$A Igor Oct08;

Reimplemented in IG.Lib.Module, IG.Lib.App, IG.Lib.AppTest, IG.Lib.ModuleTest, and IG.Forms.AppTestForms.

virtual void IG.Lib.ModuleBase.AfterInitialization ( )
inlineprotectedvirtual

A method called after any s initializations in constructors. Override this method in derived classes in order to achieve different behavior.

Reimplemented in IG.Lib.AppTest, IG.Forms.AppTestForms, and IG.Lib.ModuleTest.

void IG.Lib.ModuleBase.InitModuleBase ( string  name,
string  codeName,
int  version,
int  subVersion,
int  subSubVersion,
string  release 
)
inlineprotected

Performs complete initialization of the program or module, including the pre-initialization and post-initialization steps.

Parameters
nameName of the program or module.
codeNameCode name (short name, shoud not contain spaces).
versionVersion numver.
subVersionSubversion number.
subSubVersionSub-subversion number.
releaseRelease description (e.g. "pre-release", "alpha", "beta", "experimental")

$A Igor Oct08;

void IG.Lib.ModuleBase.Dummy ( )
inlineprivate
virtual string IG.Lib.ModuleBase.ToCodeName ( string  Name)
inlineprotectedvirtual

Converts a module or program name to a valid code name.

Parameters
NameFull name of the module or program.
Returns
Corresponding code name.
DateTime IG.Lib.ModuleBase.CalculateCreationTime ( )
inline

Calculates program creation time of the current executable (the entry assembly) and returns it.

Returns
Creation time of the current executable.
DateTime IG.Lib.ModuleBase.CalculateCreationTime ( Type  type)
inline

Calculates creation time of the assembly containing the specified class and returns it.

Parameters
typeClass whose assembly'result creation time is returned.
Returns
Creation time of the assembly containing the specified class.
virtual bool IG.Lib.ModuleBase.CheckSoftwareRootValidity ( string  rootpath)
inlinevirtual

Verifies whether the specified directory is a valid software root directory. Global is verified by the standard identtification file that was put into the directory at its creation.

Parameters
rootpathPath of the software root directory to be checked.
string IG.Lib.ModuleBase.ToStringShort ( )
inline

Retrurns a short string containing very basic information about the application or module.

Referenced by IG.Lib.App.ToString().

override string IG.Lib.ModuleBase.ToString ( )
inline

Returns a string containing basic data of the module or application.

Returns
virtual List<String> IG.Lib.ModuleBase.NoticeShort ( )
inlinevirtual

Returns a list of text lines introducing the module or application in a condensed way.

virtual List<String> IG.Lib.ModuleBase.Notice ( )
inlinevirtual

Returns a list of text lines introducing the module or application in.

virtual List<String> IG.Lib.ModuleBase.Notice ( bool  useCodename,
bool  printVersion,
bool  printRelease,
bool  printAuthor,
bool  printAuthorAddress,
bool  printWebPage,
bool  printEmail 
)
inlinevirtual

Returns a list of text lines introducing the module or application.

Parameters
useCodenameIf true then code name is used instead of full module/application name.
printVersionWhether version information is printed.
printReleaseWhether release information is printed.
printAuthorWhether software's author is printed.
printAuthorAddressWhether author's address is printed.
printWebPageWhether software's web page is printed.
printEmailWhether software's e-mail address is printed.
Returns
A list of lines that constitute the notice with information about the software. There are no leading or ending empty lines.
static int IG.Lib.ModuleBase.MaxLength ( List< string >  lines)
inlinestaticprotected

Maximal length of any line in the specified list.

static string IG.Lib.ModuleBase.MultiCharacter ( char  ch,
int  num 
)
inlinestaticprotected

Returns a string containing the specified number of specified (equal) characters.

Parameters
chCharacter repeated in the string.
numNumber of characters in the string.
static string IG.Lib.ModuleBase.DecorationFrameAsterisk ( List< string >  lines,
int  indent,
int  padLeft,
int  padRight,
int  padTop,
int  padBottom 
)
inlinestatic

Returns a string containing the specified text lines in a single frame made of asterisks.

Parameters
linesLines to be embedded in the frame.
indentIndentation of the frame from the left-hand side.
padLeftLeft padding (number of spaces inside the frame).
padRightRight padding.
padTopTop padding.
padBottomBottom padding.
static string IG.Lib.ModuleBase.DecorationFrameDoubleAsterisk ( List< string >  lines,
int  indent,
int  padLeft,
int  padRight,
int  padTop,
int  padBottom 
)
inlinestatic

Returns a string containing the specified text lines in a double frame made of asterisks.

Parameters
linesLines to be embedded in the frame.
indentIndentation of the frame from the left-hand side.
padLeftLeft padding (number of spaces inside the frame).
padRightRight padding.
padTopTop padding.
padBottomBottom padding.
static string IG.Lib.ModuleBase.DecorationFrame ( List< string >  lines,
int  indent,
int  padLeft,
int  padRight,
int  padTop,
int  padBottom,
char  frameChar,
int  thickness 
)
inlinestatic

Returns a string containing the specified text lines in a frame made of one or more layers of equal characters.

Parameters
linesLines to be embedded in the frame.
indentIndentation of the frame from the left-hand side.
padLeftLeft padding (number of spaces inside the frame).
padRightRight padding.
padTopTop padding.
padBottomBottom padding.
thicknessThickness of the frame in characters.
frameCharCharacter that constitutes the frame.
static string IG.Lib.ModuleBase.DecorationFrameDashed ( List< string >  lines,
int  indent,
int  padLeft,
int  padRight,
int  padTop,
int  padBottom 
)
inlinestatic

Returns a string containing the specified text lines in a frame made of a single layers of dashes ('-') and vertical bars ('|').

Parameters
linesLines to be embedded in the frame.
indentIndentation of the frame from the left-hand side.
padLeftLeft padding (number of spaces inside the frame).
padRightRight padding.
padTopTop padding.
padBottomBottom padding.
static string IG.Lib.ModuleBase.DecorationFrameDoubleDashed ( List< string >  lines,
int  indent,
int  padLeft,
int  padRight,
int  padTop,
int  padBottom 
)
inlinestatic

Returns a string containing the specified text lines in a frame made of a double layers of dashes ('-') and vertical bars ('|').

Parameters
linesLines to be embedded in the frame.
indentIndentation of the frame from the left-hand side.
padLeftLeft padding (number of spaces inside the frame).
padRightRight padding.
padTopTop padding.
padBottomBottom padding.
virtual void IG.Lib.ModuleBase.LaunchInitNotice ( )
inlinevirtual

Launches initialization notice.

Reimplemented in IG.Lib.AppTest, and IG.Forms.AppTestForms.

static void IG.Lib.ModuleBase.AnnAdd ( )
inlinestaticprivate

Appends list of assemblies for dynamic testing of software.

References IG.Lib.ScriptLoaderBase.AddDefaultAssemblies().

static void IG.Lib.ModuleBase.AddDefaultAssembliesExtShellApp ( )
inlinestatic

Appends list of assemblies for dynamic testing of software in the ExtShellApp project.

References IG.Lib.ScriptLoaderBase.AddDefaultAssemblies().

static void IG.Lib.ModuleBase.AddDefaultAssembliesExtNeuralApp ( )
inlinestatic

Appends list of assemblies for dynamic testing of software in the ExtNeuralApp project.

static void IG.Lib.ModuleBase.AddDefaultAssembliesExtShellAppExt ( )
inlinestatic

Appends list of assemblies for dynamic testing of software in the ExtShellAppExt project.

Member Data Documentation

const int IG.Lib.ModuleBase.DD = 06
protected
const int IG.Lib.ModuleBase.MM = 05
private
const int IG.Lib.ModuleBase.YYYY = 2013
private
object IG.Lib.ModuleBase._lock = new object()
protected
string IG.Lib.ModuleBase._SoftwareRoot = null
staticprivate
string IG.Lib.ModuleBase._IGHomeEnv = null
protected
string IG.Lib.ModuleBase._IGHomeIdFile = "ighome.did"
private
string IG.Lib.ModuleBase._IGHomeIdFileString = "/IGHOME/"
private
string [] IG.Lib.ModuleBase._IGHomeEnvList
protected
Initial value:
= new string[] {
"IGHOME", "IGHOME01", "IGHOME02", "IGHOME03", "IGHOME04", "IGHOME05",
"IGHOME_spare_01", "IGHOME_spare_02", "IGHOME_spare_03", "IGHOME_spare_04", "IGHOME_spare_05"
}
XmlDocument IG.Lib.ModuleBase.Data =null
bool IG.Lib.ModuleBase._isModule = false
protected
bool IG.Lib.ModuleBase._isApplication = false
private
string IG.Lib.ModuleBase._Name = "IG's Test Program"
protected
string IG.Lib.ModuleBase._CodeName = null
private
string IG.Lib.ModuleBase._Release = "Test"
private
string IG.Lib.ModuleBase._User = null
private
int IG.Lib.ModuleBase._version = 0
protected
int IG.Lib.ModuleBase._SubVersion = 0
private
int IG.Lib.ModuleBase._SubSubVersion = 0
private
int IG.Lib.ModuleBase._NumVersionDigits =2
protected
bool IG.Lib.ModuleBase._useSubVersion = true
protected
bool IG.Lib.ModuleBase._useSubSubVersion = false
private
DateTime IG.Lib.ModuleBase._StartTime = DateTime.Now
protected
DateTime IG.Lib.ModuleBase._CreationTime = new DateTime(YYYY, MM, DD)
private
TimeSpan IG.Lib.ModuleBase._ValidityPeriod =new TimeSpan(100*366,0,0,0,0)
protected
TimeSpan IG.Lib.ModuleBase._ExpireWarnPeriod = new TimeSpan(60,0,0,0,0)
private
string IG.Lib.ModuleBase._Directory = null
protected
string IG.Lib.ModuleBase._VersionDirectory = null
private
string IG.Lib.ModuleBase._UserDirectory = null
private
string IG.Lib.ModuleBase._SessionDirectory = null
private
bool IG.Lib.ModuleBase.ModuleBaseBeforeInitializationCalled = false
private
bool IG.Lib.ModuleBase.ModuleBaseAfterInitializationCalled = false
private
const string IG.Lib.ModuleBase.DefaultModuleName = "Test Library"
const string IG.Lib.ModuleBase.DefaultApplicationName = "Test Application"
private
const string IG.Lib.ModuleBase.DefaultModuleCodeName = null
private
const string IG.Lib.ModuleBase.DefaultApplicationCodeName = null
private
const string IG.Lib.ModuleBase.DefaultRelease = "final"
private
const int IG.Lib.ModuleBase.DefaultVersion = 0
const int IG.Lib.ModuleBase.DefaultSubVersion = 0
private
const int IG.Lib.ModuleBase.DefaultSubSubVersion = 0
private
String IG.Lib.ModuleBase.Email = null
String IG.Lib.ModuleBase.WebPage = null
private
String IG.Lib.ModuleBase.Phone = null
private
String IG.Lib.ModuleBase.AuthorFirstName = null
private
String IG.Lib.ModuleBase.AuthorMidName = null
private
String IG.Lib.ModuleBase.AuthorSecondName = null
private
String IG.Lib.ModuleBase.AuthorAddress1 = null
private
String IG.Lib.ModuleBase.AuthorAddress2 = null
private
String IG.Lib.ModuleBase.AuthorAddress3 = null
private
String IG.Lib.ModuleBase.AuthorAddress4 = null
private
String [] IG.Lib.ModuleBase.Authors = null
string IG.Lib.ModuleBase.astr =null
private
bool IG.Lib.ModuleBase._expires = true
string IG.Lib.ModuleBase._modulesDir = "modules"
protected
string IG.Lib.ModuleBase._applicationsDir = "applications"
protected
IReporter IG.Lib.ModuleBase._reporter = DefaultReporter
protected
IReporter IG.Lib.ModuleBase._defaultReporter = null
staticprotected
int IG.Lib.ModuleBase.AnnDD = 15
staticprivate
int IG.Lib.ModuleBase.AnnMM = 8
staticprivate
int IG.Lib.ModuleBase.AnnYY = 2014
staticprivate
DateTime IG.Lib.ModuleBase._annDllLimit = null
staticprivate
bool IG.Lib.ModuleBase._isAnnDllTestMode = null
staticprivate
int IG.Lib.ModuleBase._numLoadableScriptWarnings = 0
staticprivate
const int IG.Lib.ModuleBase._maxLoadableScriptWarnings = 1
private

Property Documentation

object IG.Lib.ModuleBase.Lock
get

Object's lock (implementation of ILockable).

string IG.Lib.ModuleBase.IGHomeEnv
getprotected set

Environment variable that holds the software root directory.

string [] IG.Lib.ModuleBase.IGHomeEnvList
getprotected set

Possible names for environment variable that holds the software root directory.

virtual string IG.Lib.ModuleBase.IGHomeIdFile
getprotected set

Name of the software root identification file This file must be contained immediately in the software root directory. Its contents is checked in order to see whether a certain directory is actually the software root directory.

virtual string IG.Lib.ModuleBase.IGHomeIdFileString
getprotected set

Name of the software root identification file This file must be contained immediately in the software root directory. Its contents is checked in order to see whether a certain directory is actually the software root directory.

string IG.Lib.ModuleBase.AuthorFullName
get

Gets a treue/false value telling whether the global program data is initialized or not.

string IG.Lib.ModuleBase.AuthorAddress
get

Gets complete developer's address (combination of individual address lines).

virtual bool IG.Lib.ModuleBase.IsApplication
getprotected set

Whether the current object represents an application.

virtual bool IG.Lib.ModuleBase.IsModule
getprotected set

Whether the current object represents a module (not an application).

virtual string IG.Lib.ModuleBase.Name
getset

Gets or sets the full name of the program.

string IG.Lib.ModuleBase.CodeName
getset

Gets or sets code name of the program.

Code name is used in program standard directory names.

If not specified, it is automatically derived from program full name.

Get must not be called unles wither CodeName or Name has been set.

int IG.Lib.ModuleBase.Version
getset

Gets or sets the main version number of the program.

int IG.Lib.ModuleBase.SubVersion
getset

Gets or sets the subversion number of the program.

Gets or sets the main version of the program.

$A Igor Oct08;

int IG.Lib.ModuleBase.SubSubVersion
getset

Gets or sets the sub-subversion number of the program.

Negative number means that this messagelevel of versioning is not used.

string IG.Lib.ModuleBase.Release
getset

Gets or sets the release specification of the program (e.g. "alpha", "beta", "release"...).

virtual DateTime IG.Lib.ModuleBase.StartTime
getprivate set

Gets The starting time of the program (time when program data was initialized).

DateTime IG.Lib.ModuleBase.CreationTime
getprotected set

Gets or sets craation time of the program.

Get throws an exception if the creation time has not been set before.

Setting to some value is normally automatically performed by a class constructur

and it is valid to override this later.

virtual bool IG.Lib.ModuleBase.Expires
getset

Gets or sets the flag telling whether the program expires.

TimeSpan IG.Lib.ModuleBase.ValidityPeriod
getset

Gets or sets the validity period length for the program.

Validity period is time that elapses between creation and expiration of the program.

TimeSpan IG.Lib.ModuleBase.ExpireWarnPeriod
getsetprivate

Gets or sets the length of the expiration warning period. This is the period of time between expiration of the software and time when the software actually stops working. If not set, 0 is taken.

DateTime IG.Lib.ModuleBase.ExpireTime
getset

Gets or sets the expiration time of the program. Property is automatically updated if the validity period is changed.

DateTime IG.Lib.ModuleBase.ExpireFinalTime
getset

Gets or sets the time when program will stop functioning completely.

Global property is automatically updated if the validity period is changed.

bool IG.Lib.ModuleBase.HasExpired
get

Gets the indicatin whether the program has expired.

bool IG.Lib.ModuleBase.HasExpiredFinal
get

Gets the indicatin whether the program has stopped being functional because of expiration. This happens after final expiration time has reach, which follows a certain period after the regular expiration time.

int IG.Lib.ModuleBase.DaysTillExpire
get

Gets the number of days until the expiration of the program or module (0 or negative if already expired).

int IG.Lib.ModuleBase.DaysTillExpireFinal
get

Gets the number of days until the final expiration of the program or module, when the software will stop functioning (0 or negative if already expired).

int IG.Lib.ModuleBase.NumVersionDigits
getset

Number of digits that are output in version strings.

bool IG.Lib.ModuleBase.UseSubVersion
getset

Whether or not subversion number is used.

bool IG.Lib.ModuleBase.UseSubSubVersion
getset

Whether or not sub-subversion number is used.

string IG.Lib.ModuleBase.VersionString
get

Gets the string that represents program version.

string IG.Lib.ModuleBase.DirectoryVersionString
getprivate

Gets the string representation of program version to be used in directory and file names. Sub-subversion is not included in the string.

string IG.Lib.ModuleBase.User
getset

Gets name of the user of the program.

virtual String IG.Lib.ModuleBase.SoftwareParentDirectory
getprotected

Gets the directory containing individual module or application directories.

virtual string IG.Lib.ModuleBase.BaseDirectory
getset

Gets or sets the program directory (containing all version directories, user directories, etc.). Setting of program directory should normally be left to the system.

virtual string IG.Lib.ModuleBase.VersionDirectory
getset

Gets or sets the program'result specific version directory. Setting of this directory should normally be left to the system.

virtual string IG.Lib.ModuleBase.UserDirectory
getset

Gets or sets the spedcific user'result directory for the current version of the progrm. Setting of this directory should normally be left to the system.

virtual string IG.Lib.ModuleBase.SessionDirectory
getset

Gets or sets the current session'result directory. Setting of this directory should normally be left to the system.

virtual string IG.Lib.ModuleBase.SoftwareRoot
getprotected set

Gets or sets the software root directory. Setting it should normally be left to the system.

IReporter IG.Lib.ModuleBase.Reporter
getset

IReporter IG.Lib.ModuleBase.DefaultReporter
staticget

Returns the curent global Application reporter.

DateTime IG.Lib.ModuleBase.AnnDllTestLimit
staticgetprivate
bool IG.Lib.ModuleBase.IsAnnDllTestMode
staticgetprivate

Whether dynamic testing of software is on (helps in agile software development).

bool IG.Lib.ModuleBase.LoadableScriptShellIsLoadableDefault
staticgetprivate

Basic procedure for calculation of the flag LoadableScriptShellIsLoadable.

bool IG.Lib.ModuleBase.LoadableScriptShellIsRunnableDefault
staticgetprivate

Basic procedure for calculation of the flag LoadableScriptShellIsRunnable.


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