TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual

class BuildInformation_Tinman_AddOns_DirectX in Tinman.AddOns.DirectX

Module 'Tinman.AddOns.DirectX' - version 1.0 - built on 2017/10/06

sealed class BuildInformation_Tinman_AddOns_DirectX extends BuildInformation

Public / Attributes

BuildDate

The date of the build.

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

Remarks:

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

Instance

Singleton instance of BuildInformation_Tinman_AddOns_DirectX.

public static readonly field Instance
type BuildInformation

ModuleName

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

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

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.
inherited BuildInformation.Version

VersionMajor

The major version number of the build.

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

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 override property VersionMinor { get }
type int32
value [>=0] The bugfix number of the build version.
implements BuildInformation.VersionMinor

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.
inherited BuildInformation.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.
inherited BuildInformation.Equals

ToString

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

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