NCBI C++ ToolKit
Public Types | Public Member Functions | Static Protected Member Functions | List of all members
CScopeInfo_Ref< Info > Class Template Reference

Search Toolkit Book for CScopeInfo_Ref

#include <objmgr/tse_handle.hpp>

+ Inheritance diagram for CScopeInfo_Ref< Info >:
+ Collaboration diagram for CScopeInfo_Ref< Info >:

Public Types

typedef Info TScopeInfo
 
- Public Types inherited from CRef< CScopeInfo_Base, CScopeInfoLocker >
typedef CScopeInfo_Base element_type
 Define alias element_type. More...
 
typedef element_type TObjectType
 Define alias TObjectType. More...
 
typedef CScopeInfoLocker locker_type
 Define alias for locking type. More...
 
typedef CRef< CScopeInfo_Base, CScopeInfoLockerTThisType
 Alias for this template type. More...
 
using enable_if_derived = typename std::enable_if< std::is_convertible< T *, TObjectType * >::value >
 Helper template to template enable methods only for derived types. More...
 

Public Member Functions

 CScopeInfo_Ref (void)
 
 CScopeInfo_Ref (TScopeInfo &info)
 
void Reset (void)
 
void Reset (TScopeInfo *info)
 
TScopeInfooperator* (void)
 
const TScopeInfooperator* (void) const
 
TScopeInfoGetNCObject (void) const
 
TScopeInfooperator-> (void)
 
const TScopeInfooperator-> (void) const
 
- Public Member Functions inherited from CScopeInfo_RefBase
 CScopeInfo_RefBase (void)
 
 CScopeInfo_RefBase (CScopeInfo_Base *info)
 
bool IsValid (void) const
 
bool IsRemoved (void) const
 
- Public Member Functions inherited from CRef< CScopeInfo_Base, CScopeInfoLocker >
 CRef (void) THROWS_NONE
 Constructor for null pointer. More...
 
 CRef (ENull) THROWS_NONE
 Constructor for ENull pointer. More...
 
 CRef (TObjectType *ptr)
 Constructor for explicit type conversion from pointer to object. More...
 
 CRef (TObjectType *ptr, const locker_type &locker_value)
 Constructor for explicit type conversion from pointer to object. More...
 
 CRef (const TThisType &ref)
 Copy constructor from an existing CRef object. More...
 
 CRef (const CRef< TDerived, CScopeInfoLocker > &ref)
 Copy constructor from an existing CRef object of derived type. More...
 
 CRef (TThisType &&ref)
 Move constructor from an existing CRef object. More...
 
 CRef (CRef< TDerived, CScopeInfoLocker > &&ref)
 Move constructor from an existing CRef object of derived type. More...
 
 ~CRef (void)
 Destructor. More...
 
const locker_typeGetLocker (void) const
 Get reference to locker object. More...
 
bool operator! (void) const THROWS_NONE
 Check if CRef is empty – not pointing to any object, which means having a null value. More...
 
bool Empty (void) const THROWS_NONE
 Check if CRef is empty – not pointing to any object, which means having a null value. More...
 
bool NotEmpty (void) const THROWS_NONE
 Check if CRef is not empty – pointing to an object and has a non-null value. More...
 
bool IsNull (void) const THROWS_NONE
 Check if pointer is null – same effect as Empty(). More...
 
bool NotNull (void) const THROWS_NONE
 Check if pointer is not null – same effect as NotEmpty(). More...
 
void Swap (TThisType &ref)
 Swaps the pointer with another reference. More...
 
void Reset (void)
 Reset reference object. More...
 
void Reset (TObjectType *newPtr)
 Reset reference object to new pointer. More...
 
TObjectTypeReleaseOrNull (void)
 Release a reference to the object and return a pointer to the object. More...
 
TObjectTypeRelease (void)
 Release a reference to the object and return a pointer to the object. More...
 
void AtomicResetFrom (const TThisType &ref)
 Reset reference object to new pointer. More...
 
void AtomicReleaseTo (TThisType &ref)
 Release referenced object to another CRef<> object. More...
 
TThisTypeoperator= (const TThisType &ref)
 Assignment operator for references. More...
 
TThisTypeoperator= (const CRef< TDerived, CScopeInfoLocker > &ref)
 Assignment operator for references of derived types. More...
 
TThisTypeoperator= (TThisType &&ref)
 Move assignment operator for references. More...
 
TThisTypeoperator= (CRef< TDerived, CScopeInfoLocker > &&ref)
 Move assignment operator for references of derived types. More...
 
TThisTypeoperator= (TObjectType *ptr)
 Assignment operator for references with right hand side set to a pointer. More...
 
TThisTypeoperator= (ENull)
 Assignment operator with right hand side set to ENull. More...
 
TObjectTypeGetNonNullPointer (void)
 Get pointer value and throw a null pointer exception if pointer is null. More...
 
const TObjectTypeGetNonNullPointer (void) const
 Get pointer value and throw a null pointer exception if pointer is null – constant version. More...
 
TObjectTypeGetPointerOrNull (void) THROWS_NONE
 Get pointer value. More...
 
const TObjectTypeGetPointerOrNull (void) const THROWS_NONE
 Get pointer value – constant version. More...
 
TObjectTypeGetPointer (void) THROWS_NONE
 Get pointer,. More...
 
const TObjectTypeGetPointer (void) const THROWS_NONE
 Get pointer – constant version,. More...
 
TObjectTypeGetObject (void)
 Get object. More...
 
const TObjectTypeGetObject (void) const
 Get object – constant version. More...
 
TObjectTypeoperator* (void)
 Dereference operator returning object. More...
 
const TObjectTypeoperator* (void) const
 Dereference operator returning object – constant version. More...
 
TObjectTypeoperator-> (void)
 Reference operator. More...
 
const TObjectTypeoperator-> (void) const
 Reference operator – constant version. More...
 
 operator TObjectType * (void)
 Dereference operator returning pointer. More...
 
 operator const TObjectType * (void) const
 Dereference operator returning pointer – constant version. More...
 
TObjectTypeGetNonNullNCPointer (void) const
 Get pointer value and throw a null pointer exception if pointer is null. More...
 
TObjectTypeGetNCPointerOrNull (void) const THROWS_NONE
 Get pointer value. More...
 
TObjectTypeGetNCPointer (void) const THROWS_NONE
 Get pointer,. More...
 
TObjectTypeGetNCObject (void) const
 Get object. More...
 

Static Protected Member Functions

static CScopeInfo_BasetoBase (TScopeInfo *info)
 
static TScopeInfotoInfo (CScopeInfo_Base *base)
 
static const TScopeInfotoInfo (const CScopeInfo_Base *base)
 

Additional Inherited Members

- Static Public Member Functions inherited from CRef< CScopeInfo_Base, CScopeInfoLocker >
static void ThrowNullPointerException (void)
 

Detailed Description

template<class Info>
class CScopeInfo_Ref< Info >

Definition at line 641 of file tse_handle.hpp.

Member Typedef Documentation

◆ TScopeInfo

template<class Info >
typedef Info CScopeInfo_Ref< Info >::TScopeInfo

Definition at line 644 of file tse_handle.hpp.

Constructor & Destructor Documentation

◆ CScopeInfo_Ref() [1/2]

template<class Info >
CScopeInfo_Ref< Info >::CScopeInfo_Ref ( void  )
inline

Definition at line 646 of file tse_handle.hpp.

◆ CScopeInfo_Ref() [2/2]

template<class Info >
CScopeInfo_Ref< Info >::CScopeInfo_Ref ( TScopeInfo info)
inlineexplicit

Definition at line 649 of file tse_handle.hpp.

Member Function Documentation

◆ GetNCObject()

template<class Info >
TScopeInfo& CScopeInfo_Ref< Info >::GetNCObject ( void  ) const
inline

◆ operator*() [1/2]

template<class Info >
TScopeInfo& CScopeInfo_Ref< Info >::operator* ( void  )
inline

Definition at line 663 of file tse_handle.hpp.

◆ operator*() [2/2]

template<class Info >
const TScopeInfo& CScopeInfo_Ref< Info >::operator* ( void  ) const
inline

Definition at line 667 of file tse_handle.hpp.

◆ operator->() [1/2]

template<class Info >
TScopeInfo* CScopeInfo_Ref< Info >::operator-> ( void  )
inline

Definition at line 676 of file tse_handle.hpp.

◆ operator->() [2/2]

template<class Info >
const TScopeInfo* CScopeInfo_Ref< Info >::operator-> ( void  ) const
inline

Definition at line 680 of file tse_handle.hpp.

◆ Reset() [1/2]

template<class Info >
void CScopeInfo_Ref< Info >::Reset ( TScopeInfo info)
inline

Definition at line 658 of file tse_handle.hpp.

◆ Reset() [2/2]

template<class Info >
void CScopeInfo_Ref< Info >::Reset ( void  )
inline

◆ toBase()

template<class Info >
static CScopeInfo_Base* CScopeInfo_Ref< Info >::toBase ( TScopeInfo info)
inlinestaticprotected

Definition at line 686 of file tse_handle.hpp.

Referenced by CScopeInfo_Ref< CSeq_annot_ScopeInfo >::Reset().

◆ toInfo() [1/2]

template<class Info >
static const TScopeInfo* CScopeInfo_Ref< Info >::toInfo ( const CScopeInfo_Base base)
inlinestaticprotected

Definition at line 694 of file tse_handle.hpp.

◆ toInfo() [2/2]

template<class Info >
static TScopeInfo* CScopeInfo_Ref< Info >::toInfo ( CScopeInfo_Base base)
inlinestaticprotected

The documentation for this class was generated from the following file:
Modified on Mon Jul 22 05:04:11 2024 by modify_doxy.py rev. 669887