An IComparable representation of the server's version. More...

Inheritance diagram for AMPS.Client.VersionInfo:

Public Member Functions
	VersionInfo ()
	Initializes a new instance of the VersionInfo class with the default version string. More...

	VersionInfo (string version)
	Initializes a new instance of the VersionInfo class with the specified version string. More...

int	getOldStyleVersion ()
	Gets the old-style version as an integer. More...

ulong	getVersion ()
	Gets the version number. More...

int	CompareTo (VersionInfo info)
	Compares the current instance with another VersionInfo object and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other VersionInfo. More...

bool	Equals (VersionInfo info)
	Determines whether the specified VersionInfo object is equal to the current VersionInfo object. More...

override bool	Equals (Object obj)
	Determines whether the specified object is equal to the current object. More...

override int	GetHashCode ()
	Serves as the default hash function. More...

Static Public Member Functions
static bool	operator> (VersionInfo left, VersionInfo right)
	Determines whether two specified VersionInfo objects have the same value. More...

static bool	operator>= (VersionInfo left, VersionInfo right)
	Determines whether two specified VersionInfo objects have the same value. More...

static bool	operator< (VersionInfo left, VersionInfo right)
	Determines whether two specified VersionInfo objects have the same value More...

static bool	operator<= (VersionInfo left, VersionInfo right)
	Determines whether two specified VersionInfo objects have the same value. More...

static bool	operator== (VersionInfo left, VersionInfo right)
	Determines whether two specified VersionInfo objects have the same value. More...

static bool	operator!= (VersionInfo left, VersionInfo right)
	Determines whether two specified VersionInfo objects have different values. More...

Properties
string	VersionString `[get, set]`
	Gets or sets the version string. More...

Detailed Description

An IComparable representation of the server's version.

Constructor & Destructor Documentation

◆ VersionInfo() [1/2]

AMPS.Client.VersionInfo.VersionInfo ( )

inline

Initializes a new instance of the VersionInfo class with the default version string.

◆ VersionInfo() [2/2]

AMPS.Client.VersionInfo.VersionInfo ( string version )

inline

Initializes a new instance of the VersionInfo class with the specified version string.

Parameters

version The version string.

Member Function Documentation

◆ CompareTo()

int AMPS.Client.VersionInfo.CompareTo ( VersionInfo info )

inline

Compares the current instance with another VersionInfo object and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other VersionInfo.

Parameters

info	A VersionInfo object to compare with this instance.

Returns: A value that indicates the relative order of the objects being compared. The return value has the following meanings: Less than zero: This instance precedes info in the sort order. Zero: This instance occurs in the same position in the sort order as info . Greater than zero: This instance follows info in the sort order.

◆ Equals() [1/2]

override bool AMPS.Client.VersionInfo.Equals ( Object obj )

inline

Determines whether the specified object is equal to the current object.

Parameters

obj	The object to compare with the current object.

Returns: True if the specified object is equal to the current object; otherwise, false.

◆ Equals() [2/2]

bool AMPS.Client.VersionInfo.Equals ( VersionInfo info )

inline

Determines whether the specified VersionInfo object is equal to the current VersionInfo object.

Parameters

info	The VersionInfo object to compare with the current VersionInfo object.

Returns: True if the specified VersionInfo is equal to the current VersionInfo; otherwise, false.

◆ GetHashCode()

override int AMPS.Client.VersionInfo.GetHashCode ( )

inline

Serves as the default hash function.

Returns: A hash code for the current object.

◆ getOldStyleVersion()

int AMPS.Client.VersionInfo.getOldStyleVersion ( )

inline

Gets the old-style version as an integer.

Returns: The old-style version as an integer.

◆ getVersion()

ulong AMPS.Client.VersionInfo.getVersion ( )

inline

Gets the version number.

Returns: The version number.

◆ operator!=()

static bool AMPS.Client.VersionInfo.operator!=	(	VersionInfo	left,
		VersionInfo	right
	)

inlinestatic

Determines whether two specified VersionInfo objects have different values.

Parameters

left	The first VersionInfo to compare.
right	The second VersionInfo to compare.

Returns: true if the value of left is different from the value of right ; otherwise, false.

◆ operator<()

static bool AMPS.Client.VersionInfo.operator<	(	VersionInfo	left,
		VersionInfo	right
	)

inlinestatic

Determines whether two specified VersionInfo objects have the same value

Parameters

left	The first VersionInfo to compare.
right	The second VersionInfo to compare.

Returns: true if the value of left is the same as the value of right ; otherwise, false.

◆ operator<=()

static bool AMPS.Client.VersionInfo.operator<=	(	VersionInfo	left,
		VersionInfo	right
	)

inlinestatic

Determines whether two specified VersionInfo objects have the same value.

Parameters

left	The first VersionInfo to compare.
right	The second VersionInfo to compare.

Returns: true if the value of left is the same as the value of right ; otherwise, false.

◆ operator==()

static bool AMPS.Client.VersionInfo.operator==	(	VersionInfo	left,
		VersionInfo	right
	)

inlinestatic

Determines whether two specified VersionInfo objects have the same value.

Parameters

left	The first VersionInfo to compare.
right	The second VersionInfo to compare.

Returns: true if the value of left is the same as the value of right ; otherwise, false.

◆ operator>()

static bool AMPS.Client.VersionInfo.operator>	(	VersionInfo	left,
		VersionInfo	right
	)

inlinestatic

Determines whether two specified VersionInfo objects have the same value.

Parameters

left	The first VersionInfo to compare.
right	The second VersionInfo to compare.

Returns: True if the value of left is the same as the value of right ; otherwise, false.

◆ operator>=()

static bool AMPS.Client.VersionInfo.operator>=	(	VersionInfo	left,
		VersionInfo	right
	)

inlinestatic

Determines whether two specified VersionInfo objects have the same value.

Parameters

left	The first VersionInfo to compare.
right	The second VersionInfo to compare.

Returns: True if the value of left is the same as the value of right ; otherwise, false.

Property Documentation

◆ VersionString

string AMPS.Client.VersionInfo.VersionString

getset

Gets or sets the version string.

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

AMPS.Client/VersionInfo.cs

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ VersionInfo() [1/2]

◆ VersionInfo() [2/2]

Member Function Documentation

◆ CompareTo()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ getOldStyleVersion()

◆ getVersion()

◆ operator!=()

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

Property Documentation

◆ VersionString