Search Toolkit Book for CIdentityRelation

#include <gui/objutils/relation.hpp>

Inheritance diagram for CIdentityRelation:

Collaboration diagram for CIdentityRelation:

Public Member Functions
virtual string	GetName () const

virtual string	GetDescription () const

virtual string	GetTypeName () const

virtual string	GetRelatedTypeName () const

virtual void	GetRelated (objects::CScope &scope, const CObject &obj, TObjects &related, TFlags flags=eDefault, ICanceled *cancel=NULL) const

virtual string	GetProperty (const string &) const

virtual void	Dump (ostream &ostream) const

Public Member Functions inherited from CRelation
	CRelation ()

void	WriteObject (CObjectOStream &out) const

Public Member Functions inherited from CObject
	CObject (void)
	Constructor. More...

	CObject (const CObject &src)
	Copy constructor. More...

virtual	~CObject (void)
	Destructor. More...

CObject &	operator= (const CObject &src) THROWS_NONE
	Assignment operator. More...

bool	CanBeDeleted (void) const THROWS_NONE
	Check if object can be deleted. More...

bool	IsAllocatedInPool (void) const THROWS_NONE
	Check if object is allocated in memory pool (not system heap) More...

bool	Referenced (void) const THROWS_NONE
	Check if object is referenced. More...

bool	ReferencedOnlyOnce (void) const THROWS_NONE
	Check if object is referenced only once. More...

void	AddReference (void) const
	Add reference to object. More...

void	RemoveReference (void) const
	Remove reference to object. More...

void	ReleaseReference (void) const
	Remove reference without deleting object. More...

virtual void	DoNotDeleteThisObject (void)
	Mark this object as not allocated in heap – do not delete this object. More...

virtual void	DoDeleteThisObject (void)
	Mark this object as allocated in heap – object can be deleted. More...

void *	operator new (size_t size)
	Define new operator for memory allocation. More...

void *	operator new[] (size_t size)
	Define new[] operator for 'array' memory allocation. More...

void	operator delete (void *ptr)
	Define delete operator for memory deallocation. More...

void	operator delete[] (void *ptr)
	Define delete[] operator for memory deallocation. More...

void *	operator new (size_t size, void *place)
	Define new operator. More...

void	operator delete (void ptr, void place)
	Define delete operator. More...

void *	operator new (size_t size, CObjectMemoryPool *place)
	Define new operator using memory pool. More...

void	operator delete (void ptr, CObjectMemoryPool place)
	Define delete operator. More...

virtual void	DebugDump (CDebugDumpContext ddc, unsigned int depth) const
	Define method for dumping debug information. More...

Public Member Functions inherited from CDebugDumpable
	CDebugDumpable (void)

virtual	~CDebugDumpable (void)

void	DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const

void	DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const

void	DumpToConsole (void) const

Static Public Attributes
static const char *	m_Name = "IdentityRelation"

Static Public Attributes inherited from CObject
static const TCount	eCounterBitsCanBeDeleted = 1 << 0
	Define possible object states. More...

static const TCount	eCounterBitsInPlainHeap = 1 << 1
	Heap signature was found. More...

static const TCount	eCounterBitsPlaceMask
	Mask for 'in heap' state flags. More...

static const int	eCounterStep = 1 << 2
	Skip over the "in heap" bits. More...

static const TCount	eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
	Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...

static const TCount	eCounterStateMask
	Valid object, and object in heap. More...

Additional Inherited Members
Public Types inherited from CRelation
enum	{ fConvert_All = 0x01 , fConvert_Best = 0x02 , fConvert_NoExpensive = 0x03 , eDefault = fConvert_Best }

typedef int	TFlags

typedef vector< SObject >	TObjects

Public Types inherited from CObject
enum	EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
	Control filling of newly allocated memory. More...

typedef CObjectCounterLocker	TLockerType
	Default locker type for CRef. More...

typedef atomic< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...

typedef Uint8	TCount
	Alias for value type of counter. More...

Static Public Member Functions inherited from CRelation
static const CRelation *	ReadObject (CObjectIStream &in)

Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (void)
	Define method to throw null pointer exception. More...

static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (const type_info &type)

static EAllocFillMode	GetAllocFillMode (void)

static void	SetAllocFillMode (EAllocFillMode mode)

static void	SetAllocFillMode (const string &value)
	Set mode from configuration parameter value. More...

Static Public Member Functions inherited from CDebugDumpable
static void	EnableDebugDump (bool on)

Protected Member Functions inherited from CRelation
virtual void	ToUserObject (objects::CUser_object &) const

virtual void	FromUserObject (const objects::CUser_object &)

Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...

Static Protected Member Functions inherited from CRelation
static objects::CUser_object *	UserObjectFromRelation (const CRelation &relation)

static const CRelation *	RelationFromUserObject (const objects::CUser_object &user_obj)

Detailed Description

Definition at line 167 of file relation.hpp.

Member Function Documentation

◆ Dump()

void CIdentityRelation::Dump ( ostream & ostream ) const

virtual

Reimplemented from CRelation.

Definition at line 132 of file relation.cpp.

◆ GetDescription()

virtual string CIdentityRelation::GetDescription ( void ) const

inlinevirtual

Implements CRelation.

Definition at line 171 of file relation.hpp.

◆ GetName()

virtual string CIdentityRelation::GetName ( void ) const

inlinevirtual

Implements CRelation.

Definition at line 170 of file relation.hpp.

References m_Name.

◆ GetProperty()

virtual string CIdentityRelation::GetProperty ( const string & ) const

inlinevirtual

Reimplemented from CRelation.

Definition at line 180 of file relation.hpp.

◆ GetRelated()

void CIdentityRelation::GetRelated	(	objects::CScope &	scope,
		const CObject &	obj,
		TObjects &	related,
		TFlags	flags = `eDefault`,
		ICanceled *	cancel = `NULL`
	)		const

virtual

Implements CRelation.

Definition at line 123 of file relation.cpp.

◆ GetRelatedTypeName()

virtual string CIdentityRelation::GetRelatedTypeName ( ) const

inlinevirtual

Implements CRelation.

Definition at line 174 of file relation.hpp.

◆ GetTypeName()

virtual string CIdentityRelation::GetTypeName ( ) const

inlinevirtual

Implements CRelation.

Definition at line 173 of file relation.hpp.

Member Data Documentation

◆ m_Name

const char * CIdentityRelation::m_Name = "IdentityRelation"

static

Definition at line 183 of file relation.hpp.

Referenced by CObjectConverter::FindRelations(), GetName(), and CRelation::RelationFromUserObject().

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

include/gui/objutils/relation.hpp
src/gui/objutils/relation.cpp

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Dump()

◆ GetDescription()

◆ GetName()

◆ GetProperty()

◆ GetRelated()

◆ GetRelatedTypeName()

◆ GetTypeName()

Member Data Documentation

◆ m_Name