class BuildInformation in Tinman.Core

Base interface for classes that represent build information.

abstract class	BuildInformation	implements	IComparable<BuildInformation>
			IEquatable<BuildInformation>
		base of	BuildInformation_Tinman_AddOns
			BuildInformation_Tinman_AddOns_Assimp
			BuildInformation_Tinman_AddOns_DirectX
			BuildInformation_Tinman_AddOns_GDAL
			BuildInformation_Tinman_Core
			BuildInformation_Tinman_Demo
			BuildInformation_Tinman_Demo_StandAlone
			BuildInformation_Tinman_Terrain

Public / Attributes

BuildDate

The date of the build.

public abstract property	BuildDate { get }
type	string
value	[not-null]	The build date string.

Remarks:

The BuildInformation string stores the build date in the following format: YYYY/MM/DD.

ModuleName

Human-readable name of the code module this build information is referring to.

public abstract property	ModuleName { get }
type	string
value	[not-null]	The build module name string.

Remarks:

The module name is equal to the namespace name that contains the build information class.

Version

The version number of the build in the form: major.minor.

public property	Version { get }
type	string
value	[not-null]	The version number string.

VersionMajor

The major version number of the build.

public abstract property	VersionMajor { get }
type	int32
value	[>=1]	The major version number.

Remarks:

Each time the major version number is increased, the minor version number is reset to 0. Breaking changes and thus code migration can become necessary between major versions.

VersionMinor

The minor version number of the build.

public abstract property	VersionMinor { get }
type	int32
value	[>=0]	The bugfix number of the build version.

Remarks:

The minor version number is incremented after bugfixes and patches which do not affect API compatibility, thus breaking changes will not occur and code migration is not necessary.

Public / Methods

CompareTo

Compares this object with the given one.

[Pure]
public method	CompareTo (BuildInformation 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.
implements	IComparable.CompareTo

Equals

Compares this object with the given one.

[Pure]
public method	Equals (BuildInformation other)
type	bool
params	other		The object to compare to.
returns			true if this object is equal to other, false if not.
implements	IEquatable.Equals

ToString

[Pure]
public override method	ToString ()
type	string

---

public method	ToString (bool includeModuleName, bool includeVersion = true, bool includeBuildDate = true)
type	string
params	includeModuleName
	includeVersion
	includeBuildDate