|
NCBI C++ ToolKit
|
Search Toolkit Book for CPluginObject
namespace ncbi::objects:: More...
#include <gui/objects/PluginObject.hpp>
Inheritance diagram for CPluginObject:
Collaboration diagram for CPluginObject:Public Member Functions | |
| CPluginObject (void) | |
| constructor More... | |
| ~CPluginObject (void) | |
| destructor More... | |
| void | Reset (void) |
| overloaded Reset() - allows us to clear our derived types More... | |
| void | PostRead () |
| PostRead() - provides ability to set derived type. More... | |
| const CGBProjectHandle * | GetProject (void) const |
| access the project for this object More... | |
| const CObject * | GetObject (void) const |
| access the object for this object More... | |
| bool | IsEmpty (void) const |
| find out if this object is empty More... | |
| void | SetProject (const CGBProjectHandle *doc) |
| void | SetObject (const string &type) |
| void | SetObject (const CTypeInfo *info=NULL) |
| void | SetObject (const CObject &obj, const CGBProjectHandle *scope=NULL, const CDataHandle *dh=NULL) |
Public Member Functions inherited from CPluginObject_Base | |
| CPluginObject_Base (void) | |
| virtual | ~CPluginObject_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSetObjaddr (void) const |
| Check if a value has been assigned to Objaddr data member. More... | |
| bool | CanGetObjaddr (void) const |
| Check if it is safe to call GetObjaddr method. More... | |
| void | ResetObjaddr (void) |
| Reset Objaddr data member. More... | |
| const TObjaddr & | GetObjaddr (void) const |
| Get the Objaddr member data. More... | |
| void | SetObjaddr (const TObjaddr &value) |
| Assign a value to Objaddr data member. More... | |
| void | SetObjaddr (TObjaddr &&value) |
| TObjaddr & | SetObjaddr (void) |
| Assign a value to Objaddr data member. More... | |
| bool | IsSetSubtype (void) const |
| Check if a value has been assigned to Subtype data member. More... | |
| bool | CanGetSubtype (void) const |
| Check if it is safe to call GetSubtype method. More... | |
| void | ResetSubtype (void) |
| Reset Subtype data member. More... | |
| const TSubtype & | GetSubtype (void) const |
| Get the Subtype member data. More... | |
| void | SetSubtype (const TSubtype &value) |
| Assign a value to Subtype data member. More... | |
| void | SetSubtype (TSubtype &&value) |
| TSubtype & | SetSubtype (void) |
| Assign a value to Subtype data member. More... | |
Public Member Functions inherited from CSerialObject | |
| CSerialObject (void) | |
| virtual | ~CSerialObject (void) |
| virtual const CTypeInfo * | GetThisTypeInfo (void) const =0 |
| virtual void | Assign (const CSerialObject &source, ESerialRecursionMode how=eRecursive) |
| Set object to copy of another one. More... | |
| virtual bool | Equals (const CSerialObject &object, ESerialRecursionMode how=eRecursive) const |
| Check if both objects contain the same values. More... | |
| virtual void | DebugDump (CDebugDumpContext ddc, unsigned int depth) const |
| Define method for dumping debug information. More... | |
| void | ThrowUnassigned (TMemberIndex index) const |
| void | ThrowUnassigned (TMemberIndex index, const char *file_name, int file_line) const |
| bool | HasNamespaceName (void) const |
| Check if object data type has namespace name. More... | |
| const string & | GetNamespaceName (void) const |
| Get namespace name. More... | |
| bool | HasNamespacePrefix (void) const |
| Check if data type has namespace prefix. More... | |
| const string & | GetNamespacePrefix (void) const |
| Get namespace prefix. More... | |
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... | |
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 |
Public Member Functions inherited from CSerialUserOp | |
| virtual | ~CSerialUserOp () |
Protected Member Functions | |
| virtual void | UserOp_Assign (const CSerialUserOp &source) |
| From CSerialUserOp. More... | |
| virtual bool | UserOp_Equals (const CSerialUserOp &object) const |
| Will be called after comparing the datatool-generated members. More... | |
Protected Member Functions inherited from CObject | |
| virtual void | DeleteThis (void) |
| Virtual method "deleting" this object. More... | |
Protected Attributes | |
| CConstRef< CGBProjectHandle > | m_Project |
| we must hold CConstRef<>s of our object to make sure they don't fall out of scope More... | |
| CConstRef< CObject > | m_Object |
Private Types | |
| typedef CPluginObject_Base | Tparent |
Private Member Functions | |
| CPluginObject (const CPluginObject &value) | |
| Prohibit copy constructor and assignment operator. More... | |
| CPluginObject & | operator= (const CPluginObject &value) |
Additional Inherited Members | |
Public Types inherited from CPluginObject_Base | |
| enum class | E_memberIndex { e__allMandatory = 0 , e_objaddr , e_subtype } |
| typedef string | TObjaddr |
| typedef string | TSubtype |
| typedef Tparent::CMemberIndex< E_memberIndex, 3 > | TmemberIndex |
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 CSerialObject | |
| static void | SetVerifyDataThread (ESerialVerifyData verify) |
| static void | SetVerifyDataGlobal (ESerialVerifyData verify) |
| static string | UnassignedString (void) |
| static CStringUTF8 | UnassignedStringUTF8 (void) |
| static char | UnassignedByte (void) |
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) |
Static Public Attributes inherited from CSerialObject | |
| static const char * | ms_UnassignedStr = "<*unassigned*>" |
| static const char | ms_UnassignedByte = char(0xcd) |
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... | |
namespace ncbi::objects::
Definition at line 51 of file PluginObject.hpp.
|
private |
Definition at line 54 of file PluginObject.hpp.
|
inline |
constructor
Definition at line 105 of file PluginObject.hpp.
| CPluginObject::~CPluginObject | ( | void | ) |
destructor
Definition at line 51 of file PluginObject.cpp.
|
private |
Prohibit copy constructor and assignment operator.
access the object for this object
Definition at line 111 of file PluginObject.hpp.
References CConstRef< C, Locker >::GetPointer(), and m_Object.
Referenced by CPluginValue::GetObject(), and UserOp_Equals().
|
inline |
access the project for this object
Definition at line 118 of file PluginObject.hpp.
References CConstRef< C, Locker >::GetPointer(), and m_Project.
Referenced by CPluginValue::GetProject(), and UserOp_Equals().
|
inline |
find out if this object is empty
Definition at line 125 of file PluginObject.hpp.
|
private |
| void CPluginObject::PostRead | ( | ) |
PostRead() - provides ability to set derived type.
Definition at line 155 of file PluginObject.cpp.
References CPluginObject_Base::GetObjaddr(), m_Object, CConstRef< C, Locker >::Reset(), and NStr::StringToPtr().
|
virtual |
overloaded Reset() - allows us to clear our derived types
Reimplemented from CPluginObject_Base.
Definition at line 139 of file PluginObject.cpp.
References m_Object, m_Project, CConstRef< C, Locker >::Reset(), and CPluginObject_Base::Reset().
| void CPluginObject::SetObject | ( | const CObject & | obj, |
| const CGBProjectHandle * | scope = NULL, |
||
| const CDataHandle * | dh = NULL |
||
| ) |
Definition at line 68 of file PluginObject.cpp.
References CTypeInfo::GetName(), CConstRef< C, Locker >::GetPointer(), CSerialObject::GetThisTypeInfo(), m_Object, m_Project, NStr::PtrToString(), CConstRef< C, Locker >::Reset(), CPluginObject_Base::SetObjaddr(), and CPluginObject_Base::SetSubtype().
Definition at line 87 of file PluginObject.cpp.
References info, and SetObject().
Definition at line 97 of file PluginObject.cpp.
References m_Object, m_Project, NULL, NStr::PtrToString(), CConstRef< C, Locker >::Reset(), CPluginObject_Base::SetObjaddr(), and CPluginObject_Base::SetSubtype().
Referenced by CPluginValue::SetObject(), and SetObject().
| void CPluginObject::SetProject | ( | const CGBProjectHandle * | doc | ) |
Definition at line 58 of file PluginObject.cpp.
References CConstRef< C, Locker >::GetPointer(), m_Object, m_Project, NStr::PtrToString(), CConstRef< C, Locker >::Reset(), CPluginObject_Base::SetObjaddr(), and CPluginObject_Base::SetSubtype().
Referenced by CPluginValue::SetProject().
|
protectedvirtual |
From CSerialUserOp.
Implements CSerialUserOp.
Definition at line 110 of file PluginObject.cpp.
References CPluginObject_Base::GetObjaddr(), CPluginObject_Base::GetSubtype(), m_Object, m_Project, CPluginObject_Base::SetObjaddr(), and CPluginObject_Base::SetSubtype().
|
protectedvirtual |
Will be called after comparing the datatool-generated members.
Implements CSerialUserOp.
Definition at line 124 of file PluginObject.cpp.
References CPluginObject_Base::GetObjaddr(), GetObject(), GetProject(), and CPluginObject_Base::GetSubtype().
Definition at line 90 of file PluginObject.hpp.
Referenced by GetObject(), IsEmpty(), PostRead(), Reset(), SetObject(), SetProject(), and UserOp_Assign().
|
protected |
we must hold CConstRef<>s of our object to make sure they don't fall out of scope
Definition at line 89 of file PluginObject.hpp.
Referenced by GetProject(), IsEmpty(), Reset(), SetObject(), SetProject(), and UserOp_Assign().