Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
SiliconStudio.Assets.PackageVersionRange Class Reference

A dependency to a range of version. More...

Public Member Functions

 PackageVersionRange ()
 Initializes a new instance of the PackageVersionRange class. More...
 
 PackageVersionRange (PackageVersion version)
 Initializes a new instance of the PackageVersionRange class. More...
 
 PackageVersionRange (PackageVersion minVersion, bool minVersionInclusive)
 Initializes a new instance of the PackageVersionRange class. More...
 
string ToPrettyPrint ()
 Display a pretty version of the dependency. More...
 
override string ToString ()
 

Static Public Member Functions

static PackageVersionRange GetSafeRange (PackageVersion version)
 The safe range is defined as the highest build and revision for a given major and minor version More...
 
static bool TryParse (string value, out PackageVersionRange result)
 Tries to parse a version dependency. More...
 

Properties

PackageVersion MinVersion [get, set]
 Gets or sets the minimum version. More...
 
bool IsMinInclusive [get, set]
 Gets or sets a value indicating whether the min version is inclusive. More...
 
PackageVersion MaxVersion [get, set]
 Gets or sets the maximum version. More...
 
bool IsMaxInclusive [get, set]
 Gets or sets a value indicating whether the max version is inclusive. More...
 

Detailed Description

A dependency to a range of version.

The version string is either a simple version or an arithmetic range

e.g.
1.0 –> 1.0 ≤ x
(,1.0] –> x ≤ 1.0
(,1.0) –> x < 1.0
[1.0] –> x == 1.0
(1.0,) –> 1.0 < x
(1.0, 2.0) –> 1.0 < x < 2.0
[1.0, 2.0] –> 1.0 ≤ x ≤ 2.0

Definition at line 38 of file PackageVersionRange.cs.

Constructor & Destructor Documentation

SiliconStudio.Assets.PackageVersionRange.PackageVersionRange ( )

Initializes a new instance of the PackageVersionRange class.

Definition at line 43 of file PackageVersionRange.cs.

SiliconStudio.Assets.PackageVersionRange.PackageVersionRange ( PackageVersion  version)

Initializes a new instance of the PackageVersionRange class.

Parameters
versionThe exact version.

Definition at line 51 of file PackageVersionRange.cs.

SiliconStudio.Assets.PackageVersionRange.PackageVersionRange ( PackageVersion  minVersion,
bool  minVersionInclusive 
)

Initializes a new instance of the PackageVersionRange class.

Parameters
minVersionThe minimum version.
minVersionInclusiveif set to true the minimum version is inclusive

Definition at line 64 of file PackageVersionRange.cs.

Member Function Documentation

static PackageVersionRange SiliconStudio.Assets.PackageVersionRange.GetSafeRange ( PackageVersion  version)
static

The safe range is defined as the highest build and revision for a given major and minor version

Definition at line 101 of file PackageVersionRange.cs.

References SiliconStudio.Assets.PackageVersion.Version.

string SiliconStudio.Assets.PackageVersionRange.ToPrettyPrint ( )

Display a pretty version of the dependency.

Returns
A pretty version of the dependency.

Definition at line 226 of file PackageVersionRange.cs.

override string SiliconStudio.Assets.PackageVersionRange.ToString ( )

Definition at line 276 of file PackageVersionRange.cs.

static bool SiliconStudio.Assets.PackageVersionRange.TryParse ( string  value,
out PackageVersionRange  result 
)
static

Tries to parse a version dependency.

Parameters
valueThe version dependency as a string.
resultThe parsed result.
Returns
true if successfuly parsed, false otherwise.
Exceptions
System.ArgumentNullExceptionvalue

Definition at line 118 of file PackageVersionRange.cs.

References SiliconStudio.Assets.PackageVersion.TryParse().

Property Documentation

bool SiliconStudio.Assets.PackageVersionRange.IsMaxInclusive
getset

Gets or sets a value indicating whether the max version is inclusive.

true if the max version is inclusive; otherwise, false.

Definition at line 96 of file PackageVersionRange.cs.

bool SiliconStudio.Assets.PackageVersionRange.IsMinInclusive
getset

Gets or sets a value indicating whether the min version is inclusive.

true if the min version is inclusive; otherwise, false.

Definition at line 82 of file PackageVersionRange.cs.

PackageVersion SiliconStudio.Assets.PackageVersionRange.MaxVersion
getset

Gets or sets the maximum version.

The maximum version.

Definition at line 89 of file PackageVersionRange.cs.

PackageVersion SiliconStudio.Assets.PackageVersionRange.MinVersion
getset

Gets or sets the minimum version.

The minimum version.

Definition at line 75 of file PackageVersionRange.cs.


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