Version: 6.3.1
Public Member Functions | Private Member Functions | Private Attributes

SUIT_DataObjectKeyHandle Class Reference

#include <SUIT_DataObjectKey.h>

Public Member Functions

 SUIT_DataObjectKeyHandle ()
 SUIT_DataObjectKeyHandle (SUIT_DataObjectKey *)
 SUIT_DataObjectKeyHandle (const SUIT_DataObjectKeyHandle &)
 ~SUIT_DataObjectKeyHandle ()
void nullify ()
bool isNull () const
bool operator< (const SUIT_DataObjectKeyHandle &) const
bool operator== (const SUIT_DataObjectKeyHandle &) const
SUIT_DataObjectKeyHandleoperator= (const SUIT_DataObjectKeyHandle &)

Private Member Functions

void beginScope ()
void endScope ()

Private Attributes

SUIT_DataObjectKeymyKey

Detailed Description

Wrapper around the pointer of class SUIT_DataObjectKey.


Constructor & Destructor Documentation

SUIT_DataObjectKeyHandle::SUIT_DataObjectKeyHandle ( )

Constructor.

SUIT_DataObjectKeyHandle::SUIT_DataObjectKeyHandle ( SUIT_DataObjectKey key)

Constructor. Initialize by key key.

References beginScope().

SUIT_DataObjectKeyHandle::SUIT_DataObjectKeyHandle ( const SUIT_DataObjectKeyHandle other)

Copy Constructor.

References beginScope(), and myKey.

SUIT_DataObjectKeyHandle::~SUIT_DataObjectKeyHandle ( )

Destructor.

References nullify().


Member Function Documentation

void SUIT_DataObjectKeyHandle::nullify ( )

Nullify key.

References endScope().

bool SUIT_DataObjectKeyHandle::isNull ( ) const

Checks: Is key null?

Return values:
TRUE- if null, esle false.

References myKey.

bool SUIT_DataObjectKeyHandle::operator< ( const SUIT_DataObjectKeyHandle kw) const

Operator less.

Return values:
boolean.TRUE - If current key less than kw.

References _typeinfo, SUIT_DataObjectKey.isLess(), and myKey.

bool SUIT_DataObjectKeyHandle::operator== ( const SUIT_DataObjectKeyHandle kw) const

Operator is equal.

Return values:
boolean.TRUE - If current key equal kw.

References SUIT_DataObjectKey.isEqual(), and myKey.

SUIT_DataObjectKeyHandle & SUIT_DataObjectKeyHandle::operator= ( const SUIT_DataObjectKeyHandle kw)

Copy value of key kw to current.

References beginScope(), endScope(), and myKey.

void SUIT_DataObjectKeyHandle::beginScope ( ) [private]

Inctrement reference counter for current key.

References myKey, and SUIT_DataObjectKey.refCounter.

void SUIT_DataObjectKeyHandle::endScope ( ) [private]

Decrement reference counter for current key.

References myKey, and SUIT_DataObjectKey.refCounter.


Field Documentation

Copyright © 2007-2011 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS