GenApiVersion Struct Reference

Version information for GenICam related objects. More...

Inherits IEquatable< GenApiVersion >, IComparable< GenApiVersion >, and IComparable.

Public Member Functions
override string	ToString ()
	Gets the string representation of this version. More...
override bool	Equals (object obj)
	Checks whether the given obj is a GenApiVersion with the same version number. More...
bool	Equals (GenApiVersion other)
	Checks whether the given other is a GenApiVersion with the same version number. More...
override int	GetHashCode ()
	Gets the hash code for this GenApiVersion. More...
int	CompareTo (GenApiVersion other)
	Compares the current instance with another object of the same type 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 object. More...

Properties
short	Major [get, set]
	Gets or sets the major version number. More...
short	Minor [get, set]
	Gets or sets the minor version number. More...
short	SubMinor [get, set]
	Gets or sets the sub-minor version number. More...

Detailed Description

Version information for GenICam related objects.

The versions are managed as follows:

• GenApiVersion.Major: An increase indicates a change which is not backward compatible.
• GenApiVersion.Minor: An increase indicates a change which adds new features. It must still support old versions of the server instance.
• GenApiVersion.SubMinor: An increase indicates a bug fix. No new features are added.

Member Function Documentation

CompareTo()

int CompareTo

(

GenApiVersion

other

)

Compares the current instance with another object of the same type 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 object.

Parameters

other

Object to compare to this one.

Returns

Less than zero if this object precedes the other ; Equal to zero of both are equal; Greater than zero if this object follows the other one.

Equals() [1/2]

bool Equals

(

GenApiVersion

other

)

Checks whether the given other is a GenApiVersion with the same version number.

Parameters

other

Object to test for equality.

Returns

true if other is equal to this object; false otherwise.

Equals() [2/2]

override bool Equals

(

object

obj

)

Checks whether the given obj is a GenApiVersion with the same version number.

Parameters

obj	Object to test for equality.

Returns

true if obj is equal to this object; false otherwise.

GetHashCode()

override int GetHashCode

(

)

Gets the hash code for this GenApiVersion.

Returns

Hash code.

ToString()

override string ToString

(

)

Gets the string representation of this version.

Returns

Version string.

Property Documentation

Major

short Major

getset

Gets or sets the major version number.

Positive integer value containing the version number.

Exceptions

ArgumentOutOfRangeException

The value is smaller than zero.

Minor

short Minor

getset

Gets or sets the minor version number.

Positive integer value containing the version number.

Exceptions

ArgumentOutOfRangeException

The value is smaller than zero.

SubMinor

short SubMinor

getset

Gets or sets the sub-minor version number.

Positive integer value containing the version number.

Exceptions

ArgumentOutOfRangeException

The value is smaller than zero.