DtPatchIdentifier Class Reference

DtPatchIdentifier is used to uniquely identify a uniform patch. More...

Collaboration diagram for DtPatchIdentifier:

Public Member Functions
	DtPatchIdentifier ()
	Default CTOR. More...
	DtPatchIdentifier (const char *stringRep)
	CTOR. More...
	DtPatchIdentifier (unsigned short country, unsigned char service, unsigned short patch)
	CTOR. More...
	DtPatchIdentifier (const DtPatchIdentifier &orig)
	Copy CTOR. More...
	DtPatchIdentifier (const DtNetPatchIdentifier &netId)
	Copy CTOR. More...
virtual	~DtPatchIdentifier ()
	Virtual DTOR. More...
void	setFromNet (const DtNetPatchIdentifier &netId)
	Sets the instance equal to the value in netType prefer the DtNetEntityType constructor to this function. More...
	operator DtNetPatchIdentifier () const
	Return a network structure of this instance. More...
const char *	string () const
	Returns the string representation of the identifier (eg. 225:3:2). More...
void	setCountry (unsigned short val)
unsigned short	country () const
void	setService (unsigned char val)
unsigned char	service () const
void	setPatch (unsigned short val)
unsigned short	patch () const
bool	operator== (const DtPatchIdentifier &type) const
bool	operator!= (const DtPatchIdentifier &type) const
bool	operator< (const DtPatchIdentifier &type) const
	Returns true if the entity type is smaller. More...

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

Protected Attributes
std::string	myMutableStringRep
	This member is: 1) mutable because it is changed in const methods and used as a char buffer 2) it SHOULD be private because it is not considered part of the API and should not be used by any subclass. More...
unsigned short	myCountryCode
unsigned char	myServiceCode
unsigned short	myPatchId

Detailed Description

DtPatchIdentifier is used to uniquely identify a uniform patch.

Patches are identified by a combination of the country code, service code, and patch id. Patches within a specific country/service are indexed according to the DIG-REF-002 enumerations document.

Constructor & Destructor Documentation

DtPatchIdentifier::DtPatchIdentifier

(

)

Default CTOR.

Initializes to a null patch id, which typically means to use the default patch for the entity.

DtPatchIdentifier::DtPatchIdentifier

(

const char *

stringRep

)

CTOR.

Initializes the patch identifier from its string representation in the form: "225:3:2"

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

CTOR.

DtPatchIdentifier::DtPatchIdentifier

(

const DtPatchIdentifier &

orig

)

Copy CTOR.

DtPatchIdentifier::DtPatchIdentifier

(

const DtNetPatchIdentifier &

netId

)

Copy CTOR.

Copies the given network representation of the identifier.

virtual DtPatchIdentifier::~DtPatchIdentifier ( )

virtual

Virtual DTOR.

Member Function Documentation

unsigned short DtPatchIdentifier::country

(

)

const

static const DtPatchIdentifier& DtPatchIdentifier::nullIdentifier ( )

static

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

DtPatchIdentifier::operator DtNetPatchIdentifier

(

)

const

Return a network structure of this instance.

bool DtPatchIdentifier::operator!=

(

const DtPatchIdentifier &

type

)

const

bool DtPatchIdentifier::operator<

(

const DtPatchIdentifier &

type

)

const

Returns true if the entity type is smaller.

If there are wildcards present then true is returned if the entity is smaller and less specific.

bool DtPatchIdentifier::operator==

(

const DtPatchIdentifier &

type

)

const

unsigned short DtPatchIdentifier::patch

(

)

const

unsigned char DtPatchIdentifier::service

(

)

const

void DtPatchIdentifier::setCountry

(

unsigned short

val

)

void DtPatchIdentifier::setFromNet

(

const DtNetPatchIdentifier &

netId

)

Sets the instance equal to the value in netType prefer the DtNetEntityType constructor to this function.

void DtPatchIdentifier::setPatch

(

unsigned short

val

)

void DtPatchIdentifier::setService

(

unsigned char

val

)

const char* DtPatchIdentifier::string

(

)

const

Returns the string representation of the identifier (eg. 225:3:2).

Member Data Documentation

unsigned short DtPatchIdentifier::myCountryCode

protected

std::string DtPatchIdentifier::myMutableStringRep

mutableprotected

This member is: 1) mutable because it is changed in const methods and used as a char buffer 2) it SHOULD be private because it is not considered part of the API and should not be used by any subclass.

unsigned short DtPatchIdentifier::myPatchId

protected

unsigned char DtPatchIdentifier::myServiceCode

protected

---

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

• patchIdentifier.h