CkptObjectKey Class Reference

Key value for referencing an object in a CkptContainer. More...

#include <CkptObjectKey.h>

List of all members.

Public Member Functions
	CkptObjectKey ()
	CkptObjectKey (unsigned long ulongKeyVal)
	Constructs a CkptObjectKey from an unsigned long value.
	CkptObjectKey (std::string stringKeyVal)
	Constructs a CkptObjectKey from an STL string object.
	CkptObjectKey (const CkptObjectKey &rKey)
	Copy Constructor.
virtual	~CkptObjectKey ()
CkptObjectKey &	operator= (const CkptObjectKey &rhs)
bool	operator== (const CkptObjectKey &rKey)
bool	operator!= (const CkptObjectKey &rKey)
SaCkptSectionIdT *	sectionIdValue ()
	Get the value of a CkptObjectKey as a SaCkptSectionIdT.
Static Public Attributes
static const unsigned int	MAX_SECTION_NAME_LENGTH = 64
	The maximum size of an object key, in bytes.
Private Attributes
SaCkptSectionIdT	_sectionId
char *	_sectName
	the key, as a CKPT Section ID

---

Detailed Description

Key value for referencing an object in a CkptContainer.

Corresponds to a sectionId within the associated container.

Definition at line 12 of file CkptObjectKey.h.

---

Constructor & Destructor Documentation

CkptObjectKey::CkptObjectKey

(

)

[inline]

Definition at line 16 of file CkptObjectKey.h.

References _sectionId, and _sectName.

CkptObjectKey::CkptObjectKey

(

unsigned long

ulongKeyVal

)

[inline]

Constructs a CkptObjectKey from an unsigned long value.

Definition at line 25 of file CkptObjectKey.h.

References _sectionId, and _sectName.

CkptObjectKey::CkptObjectKey

(

std::string

stringKeyVal

)

[inline]

Constructs a CkptObjectKey from an STL string object.

Definition at line 36 of file CkptObjectKey.h.

References _sectionId, _sectName, and MAX_SECTION_NAME_LENGTH.

CkptObjectKey::CkptObjectKey

(

const CkptObjectKey &

rKey

)

[inline]

Copy Constructor.

Definition at line 45 of file CkptObjectKey.h.

References _sectionId, and _sectName.

virtual CkptObjectKey::~CkptObjectKey

(

)

[inline, virtual]

Definition at line 52 of file CkptObjectKey.h.

References _sectName.

---

Member Function Documentation

CkptObjectKey& CkptObjectKey::operator=

(

const CkptObjectKey &

rhs

)

[inline]

Definition at line 56 of file CkptObjectKey.h.

References _sectionId, and _sectName.

bool CkptObjectKey::operator==

(

const CkptObjectKey &

rKey

)

[inline]

Definition at line 70 of file CkptObjectKey.h.

References _sectionId.

bool CkptObjectKey::operator!=

(

const CkptObjectKey &

rKey

)

[inline]

Definition at line 75 of file CkptObjectKey.h.

SaCkptSectionIdT* CkptObjectKey::sectionIdValue

(

)

[inline]

Get the value of a CkptObjectKey as a SaCkptSectionIdT.

Returns:

the key value as a CKPT Section Id

Definition at line 83 of file CkptObjectKey.h.

References _sectionId.

Referenced by CkptContainer::get(), CkptContainer::persist(), and CkptContainer::remove().

---

Member Data Documentation

const unsigned int CkptObjectKey::MAX_SECTION_NAME_LENGTH = 64 [static]

The maximum size of an object key, in bytes.

Definition at line 15 of file CkptObjectKey.h.

Referenced by CkptObjectKey().

SaCkptSectionIdT CkptObjectKey::_sectionId [private]

Definition at line 86 of file CkptObjectKey.h.

Referenced by CkptObjectKey(), operator=(), operator==(), and sectionIdValue().

char* CkptObjectKey::_sectName [private]

the key, as a CKPT Section ID

Definition at line 87 of file CkptObjectKey.h.

Referenced by CkptObjectKey(), operator=(), and ~CkptObjectKey().

---

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

• CkptObjectKey.h

---