class TinmanCoreModule in Tinman.Core

Module descriptor for: Tinman - Core

sealed class

TinmanCoreModule

extends

TinmanModule

Public / Constants

Instance

Singleton instance of TinmanCoreModule.

public static readonly field	Instance
type	TinmanCoreModule

Public / Attributes

ConfigDocumentation

Returns the config documentation for this module.

public property	ConfigDocumentation { get }
type	ConfigDoc
value		The ConfigDoc object or null if no documentation has been loaded yet.
inherited	TinmanModule.ConfigDocumentation

ConfigTypes

Returns all ConfigType s this module owns.

public property	ConfigTypes { get }
type	ConfigType[]
value	[not-null]	The list of config types.
inherited	TinmanModule.ConfigTypes

Guid

Returns the GUID of this module.

public property	Guid { get }
type	GUID
value		The GUID.
inherited	TinmanModule.Guid

Info

The build information object of this library module.

public override property	Info { get }
type	BuildInformation
value	[not-null]	The build information object.
implements	TinmanModule.Info

SettingsApp

Canonical path to directory where to put application-specific settings.

public property	SettingsApp { get }
type	Path
value	[not-null]	The settings directory.
inherited	TinmanModule.SettingsApp

Remarks:

The directory will be created, if necessary.

SettingsUser

Canonical path to directory where to put user-specific settings.

public property	SettingsUser { get }
type	Path
value	[not-null]	The settings directory.
inherited	TinmanModule.SettingsUser

Remarks:

The directory will be created, if necessary.

Public / Methods

CompareTo

Compares this object with the given one.

[Pure]
public method	CompareTo (TinmanModule other)
type	int32
params	other		The object to compare to.
returns			< 0 : if this object is less than other, = 0 : if this object is equal to other, > 0 : if this object is greater than other.
inherited	TinmanModule.CompareTo

PleaseIncludeInBinaryThanks

This is a no-op method that forces the compiler / linker to include this type in the resulting binary.

public override method	PleaseIncludeInBinaryThanks ()
overrides	TinmanModule.PleaseIncludeInBinaryThanks

Remarks:

Calling this stub method makes sure that all lazy constructor calls have been made.

To initialize everything, an application needs to call this method on its root module(s) (see TinmanModule), followed by a call to PleaseIncludeInBinaryThanksAll.

Resource

Returns the canonical path to the given embedded resource.

public method	Resource (string resourceName)
type	Path
params	resourceName	[not-null]	The name of the embedded resource.
returns		[not-null]	The canonical resource path.
inherited	TinmanModule.Resource

---

Returns the canonical path to the given embedded resource.

public method	Resource (Path resourceName)
type	Path
params	resourceName	[not-null]	The name of the embedded resource.
returns		[not-null]	The canonical resource path.
inherited	TinmanModule.Resource

ToString

[Pure]
public override method	ToString ()
type	string
inherited	TinmanModule.ToString

---

public method	ToString (bool includeBuildDate)
type	string
params	includeBuildDate
inherited	TinmanModule.ToString