ProductVersion_t Class Reference

<<extension>> Type used to represent the current version of RTI Connext. More...

Inherits Struct, and Comparable< ProductVersion_t >.

Public Member Functions
	ProductVersion_t ()
	Constructor. More...
String	toVersionString ()
String	toVersionString (boolean isMicro)
String	toString ()

Public Attributes
char	major
	Major product version. More...
char	minor
	Minor product version. More...
char	release
	Release letter for product version. More...
char	revision
	Revision number of product. More...

Static Public Attributes
static final ProductVersion_t	PRODUCTVERSION_UNKNOWN
	The value used when the product version is unknown. More...

Detailed Description

<<extension>> Type used to represent the current version of RTI Connext.

Constructor & Destructor Documentation

ProductVersion_t()

ProductVersion_t

(

)

Constructor.

Member Function Documentation

toVersionString() [1/2]

String toVersionString

(

)

A convenience method since most users of this API will not be using Micro.

Returns

Returns toVersionString(boolean) with false as the argument.

References ProductVersion_t.toVersionString().

Referenced by ProductVersion_t.toVersionString().

toVersionString() [2/2]

String toVersionString

(

boolean

isMicro

)

Provide a simple string representation of an RTI version number. This method will drop revisions that are zero, following the RTI convention.

Parameters

isMicro

true if the string representation should be created for a Micro version, false otherwise.

Returns

The version as a string.

References ProductVersion_t.major, ProductVersion_t.minor, ProductVersion_t.release, and ProductVersion_t.revision.

toString()

String toString

(

)

Provide a string representation for an instance of this type.

References ProductVersion_t.major, ProductVersion_t.minor, ProductVersion_t.release, and ProductVersion_t.revision.

Member Data Documentation

PRODUCTVERSION_UNKNOWN

final ProductVersion_t PRODUCTVERSION_UNKNOWN

static

Initial value:

=
                new ProductVersion_t((char)0, (char)0, (char)0, (char)0)

The value used when the product version is unknown.

major

char major

Major product version.

Referenced by ProductVersion_t.toString(), and ProductVersion_t.toVersionString().

minor

char minor

Minor product version.

Referenced by ProductVersion_t.toString(), and ProductVersion_t.toVersionString().

release

char release

Release letter for product version.

Referenced by ProductVersion_t.toString(), and ProductVersion_t.toVersionString().

revision

char revision

Revision number of product.

Referenced by ProductVersion_t.toString(), and ProductVersion_t.toVersionString().