diguyPatchIdentifier Class Reference

This class represents the patch identifier (country:service:id) for a patch. More...

#include <diguyPatchIdentifier.h>

Public Member Functions
	diguyPatchIdentifier ()
	Default CTOR. More...
	diguyPatchIdentifier (const char *patch_id_str)
	CTOR. More...
	diguyPatchIdentifier (unsigned short country, unsigned char service, unsigned short patch)
	CTOR. More...
	diguyPatchIdentifier (const diguyPatchIdentifier &other)
	Copy CTOR. More...
	~diguyPatchIdentifier ()
	DTOR. More...
diguyPatchIdentifier &	operator= (const diguyPatchIdentifier &rhs)
	Assignment operator. More...
bool	operator< (const diguyPatchIdentifier &rhs) const
	Less-than operator (so identifier can be used in maps and sets). More...
void	set_from_string (const char *patch_id_str)
	Set the identifier to the values given in the input string. More...
const char *	get_as_string () const
	Get the identifier as its string representation. More...
bdiPatchIdentifier *	get_scripted_object ()
	The functions and variables past this point are for internal use only. More...
const bdiPatchIdentifier *	get_scripted_object () const
bool	operator== (const diguyPatchIdentifier &rhs) const
	Equality operators. More...
bool	operator!= (const diguyPatchIdentifier &rhs) const
void	set_country (unsigned short country)
	Individual value setters and getters. More...
unsigned short	get_country () const
void	set_service (unsigned char service)
unsigned char	get_service () const
void	set_patch (unsigned short patch)
unsigned short	get_patch () const

Static Public Member Functions
static const diguyPatchIdentifier &	nullIdentifier ()
	Return the null patch identifier (-1:-1:-1). More...

Private Member Functions
	diguyPatchIdentifier (bdiPatchIdentifier *scripted_object)
	Private CTOR. More...

Private Attributes
bdiPatchIdentifier *	m_scripted_object
	Pointer to the internal data. More...
bool	m_own_scripted_object

Friends
class	bdiPatchIdentifier

Detailed Description

This class represents the patch identifier (country:service:id) for a patch.

Constructor & Destructor Documentation

diguyPatchIdentifier::diguyPatchIdentifier

(

)

Default CTOR.

Constructs a new null identifier (-1:-1:-1).

diguyPatchIdentifier::diguyPatchIdentifier

(

const char *

patch_id_str

)

CTOR.

Constructs a new identifier and parses input string for values. Input string is expected to be in the following format: ushort:uchar:ushort

diguyPatchIdentifier::diguyPatchIdentifier	(	unsigned short	country,
		unsigned char	service,
		unsigned short	patch
	)

CTOR.

Constructs a new identifier with the given values.

diguyPatchIdentifier::diguyPatchIdentifier

(

const diguyPatchIdentifier &

other

)

Copy CTOR.

diguyPatchIdentifier::~diguyPatchIdentifier

(

)

DTOR.

diguyPatchIdentifier::diguyPatchIdentifier ( bdiPatchIdentifier *  scripted_object )

private

Private CTOR.

Member Function Documentation

diguyPatchIdentifier& diguyPatchIdentifier::operator=

(

const diguyPatchIdentifier &

rhs

)

Assignment operator.

bool diguyPatchIdentifier::operator==

(

const diguyPatchIdentifier &

rhs

)

const

Equality operators.

bool diguyPatchIdentifier::operator!=

(

const diguyPatchIdentifier &

rhs

)

const

bool diguyPatchIdentifier::operator<

(

const diguyPatchIdentifier &

rhs

)

const

Less-than operator (so identifier can be used in maps and sets).

void diguyPatchIdentifier::set_from_string

(

const char *

patch_id_str

)

Set the identifier to the values given in the input string.

Input string is expected to be in the following format: ushort:uchar:ushort

const char* diguyPatchIdentifier::get_as_string

(

)

const

Get the identifier as its string representation.

String representatino is: country:service:patch

void diguyPatchIdentifier::set_country

(

unsigned short

country

)

Individual value setters and getters.

unsigned short diguyPatchIdentifier::get_country

(

)

const

void diguyPatchIdentifier::set_service

(

unsigned char

service

)

unsigned char diguyPatchIdentifier::get_service

(

)

const

void diguyPatchIdentifier::set_patch

(

unsigned short

patch

)

unsigned short diguyPatchIdentifier::get_patch

(

)

const

static const diguyPatchIdentifier& diguyPatchIdentifier::nullIdentifier ( )

static

Return the null patch identifier (-1:-1:-1).

bdiPatchIdentifier* diguyPatchIdentifier::get_scripted_object ( )

inline

The functions and variables past this point are for internal use only.

No external access to them is expected or necessary.

const bdiPatchIdentifier* diguyPatchIdentifier::get_scripted_object ( ) const

inline

Friends And Related Function Documentation

friend class bdiPatchIdentifier

friend

Member Data Documentation

bdiPatchIdentifier* diguyPatchIdentifier::m_scripted_object

private

Pointer to the internal data.

bool diguyPatchIdentifier::m_own_scripted_object

private

---

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

• E:/nightly/2751/include/diguyPatchIdentifier.h