バージョン値構造体。 [詳解]

#include <Version.h>

公開型
typedef std::uint32_t	value_type
	内部値の表現型。 [詳解]

公開メンバ関数
value_type	major () const
	メジャーバージョン値を取得する。 [詳解]

value_type	minor () const
	マイナーバージョン値を取得する。 [詳解]

value_type	patch () const
	パッチバージョン値を取得する。 [詳解]

std::wstring	toString (bool withoutPatch=false) const
	バージョン値を文字列化する。 [詳解]

静的公開メンバ関数
static bool	canMake (value_type major, value_type minor, value_type patch=0)
	バージョン値を作成可能な各バージョン値であるか否かを調べる。 [詳解]

static Version	make (value_type major, value_type minor, value_type patch=0)
	各バージョン値からバージョン値を作成する。 [詳解]

static bool	canMake (const wchar_t *src)
	バージョン値を作成可能なバージョン文字列であるか否かを調べる。 [詳解]

static Version	make (const wchar_t *src)
	バージョン文字列からバージョン値を作成する。 [詳解]

static Version	zero ()
	"0.00.00" のバージョン値を作成する。 [詳解]

公開変数類
value_type	value
	内部値。 libam のアプリバージョン値と同等のフォーマット。 [詳解]

静的公開変数類
static const value_type	PatchLimit
	パッチバージョン値の最大許容値。 [詳解]

static const value_type	MinorLimit
	マイナーバージョン値の最大許容値。 [詳解]

static const value_type	MajorLimit
	メジャーバージョン値の最大許容値。 [詳解]

関連関数
（これらはメソッドではありません）
bool	operator== (const Version &l, const Version &r)
	等価比較演算子のオーバロード。 [詳解]

bool	operator!= (const Version &l, const Version &r)
	非等価比較演算子のオーバロード。 [詳解]

bool	operator< (const Version &l, const Version &r)
	小なり比較演算子のオーバロード。 [詳解]

bool	operator> (const Version &l, const Version &r)
	大なり比較演算子のオーバロード。 [詳解]

bool	operator<= (const Version &l, const Version &r)
	小なり等価比較演算子のオーバロード。 [詳解]

bool	operator>= (const Version &l, const Version &r)
	大なり等価比較演算子のオーバロード。 [詳解]

詳解

バージョン値構造体。

覚え書き: memcpy 可能。

型定義メンバ詳解

typedef std::uint32_t amdaemon::Version::value_type

内部値の表現型。

関数詳解

static bool amdaemon::Version::canMake	(	value_type	major,
		value_type	minor,
		value_type	patch = `0`
	)

static

バージョン値を作成可能な各バージョン値であるか否かを調べる。

引数

[in]	major	メジャーバージョン値。 MajorLimit 以下。
[in]	minor	マイナーバージョン値。 MinorLimit 以下。
[in]	patch	パッチバージョン値。 PatchLimit 以下。

戻り値

true	作成可能である場合。
false	作成不可能である場合。

参照: make(value_type, value_type, value_type)

この関数が true を返す場合、同じ引数を静的メンバ関数 make に渡すことで例外を発生させることなくバージョン値を作成可能であることが保証される。

static Version amdaemon::Version::make	(	value_type	major,
		value_type	minor,
		value_type	patch = `0`
	)

static

各バージョン値からバージョン値を作成する。

引数

[in]	major	メジャーバージョン値。 MajorLimit 以下。
[in]	minor	マイナーバージョン値。 MinorLimit 以下。
[in]	patch	パッチバージョン値。 PatchLimit 以下。

戻り値: バージョン値。

参照: canMake(value_type, value_type, value_type)

例外

Exception

引数 major に MajorLimit より大きい値を指定した場合。
引数 minor に MinorLimit より大きい値を指定した場合。
引数 patch に PatchLimit より大きい値を指定した場合。

static bool amdaemon::Version::canMake ( const wchar_t * src )

static

バージョン値を作成可能なバージョン文字列であるか否かを調べる。

引数

[in] src バージョン文字列。 "1.23.45", "6.78" 等。

戻り値

true	作成可能である場合。
false	作成不可能である場合。

参照: make(const wchar_t*)

この関数が true を返す場合、同じ引数を静的メンバ関数 make に渡すことで例外を発生させることなくバージョン値を作成可能であることが保証される。

static Version amdaemon::Version::make ( const wchar_t * src )

static

バージョン文字列からバージョン値を作成する。

引数

[in] src バージョン文字列。 "1.23.45", "6.78" 等。

戻り値: バージョン値。

参照: canMake(const wchar_t*)

例外

Exception

引数 src に nullptr を指定した場合。
引数 src のフォーマットが不正である場合。
引数 src の構成数値が許容範囲外である場合。
メジャーバージョン値、マイナーバージョン値、パッチバージョン値を表す 10進数文字列を文字 '.' で連結した文字列からバージョン値を作成する。
パッチバージョン値は省略可能であり、その場合は 0 が指定されたものとみなす。

static Version amdaemon::Version::zero ( )

inlinestatic

"0.00.00" のバージョン値を作成する。

戻り値: "0.00.00" のバージョン値。

value_type amdaemon::Version::major ( ) const

inline

メジャーバージョン値を取得する。

戻り値: メジャーバージョン値。

value_type amdaemon::Version::minor ( ) const

inline

マイナーバージョン値を取得する。

戻り値: マイナーバージョン値。

value_type amdaemon::Version::patch ( ) const

inline

パッチバージョン値を取得する。

戻り値: パッチバージョン値。

std::wstring amdaemon::Version::toString ( bool withoutPatch = false ) const

バージョン値を文字列化する。

引数

[in] withoutPatch パッチバージョンを含めないならば true 。

戻り値: バージョン文字列。 "1.02.03" 等。

フレンドと関連関数の詳解

bool operator==	(	const Version &	l,
		const Version &	r
	)

引数

[in]	l	左辺値。
[in]	r	右辺値。

戻り値: 比較結果値。

bool operator!=	(	const Version &	l,
		const Version &	r
	)

引数

[in]	l	左辺値。
[in]	r	右辺値。

戻り値: 比較結果値。

bool operator<	(	const Version &	l,
		const Version &	r
	)

引数

[in]	l	左辺値。
[in]	r	右辺値。

戻り値: 比較結果値。

bool operator>	(	const Version &	l,
		const Version &	r
	)

引数

[in]	l	左辺値。
[in]	r	右辺値。

戻り値: 比較結果値。

bool operator<=	(	const Version &	l,
		const Version &	r
	)

引数

[in]	l	左辺値。
[in]	r	右辺値。

戻り値: 比較結果値。

bool operator>=	(	const Version &	l,
		const Version &	r
	)

引数

[in]	l	左辺値。
[in]	r	右辺値。

戻り値: 比較結果値。

メンバ詳解

const value_type amdaemon::Version::PatchLimit

static

パッチバージョン値の最大許容値。

const value_type amdaemon::Version::MinorLimit

static

マイナーバージョン値の最大許容値。

const value_type amdaemon::Version::MajorLimit

static

メジャーバージョン値の最大許容値。

value_type amdaemon::Version::value

内部値。 libam のアプリバージョン値と同等のフォーマット。

この構造体詳解は次のファイルから抽出されました:

Version.h

公開型

公開メンバ関数

静的公開メンバ関数

公開変数類

静的公開変数類

関連関数

詳解

型定義メンバ詳解

関数詳解

フレンドと関連関数の詳解

メンバ詳解