Search Toolkit Book for CProjectItem
#include <objects/gbproj/ProjectItem.hpp>
Inheritance diagram for CProjectItem:
Collaboration diagram for CProjectItem:
Public Member Functions | |
| CProjectItem (void) | |
| ~CProjectItem (void) | |
| void | SetCreateDate (const CTime &time) |
| SetCreateDate() will add a descriptor for creation date, and insure that only one such descriptor exists. More... | |
| void | SetCreateDate (const CDate &date) |
| void | SetModifiedDate (const CTime &time) |
| SetModifiedDate() will add a descriptor for the update date, and insure that only one such descriptor exists. More... | |
| void | SetModifiedDate (const CDate &date) |
| void | SetObject (CSerialObject &object) |
| wrapper for setting the object pointed to by this item More... | |
| const CSerialObject * | GetObject () const |
| retrieve the object pointed to as a CObject* More... | |
| bool | IsEnabled (void) const |
| enabled flag More... | |
| void | SetParentFolder (CProjectFolder *) |
| CProjectFolder * | GetParentFolder () |
| const CProjectFolder * | GetParentFolder () const |
| void | SetUserObject (CObject *object) |
| CObject * | GetUserObject () |
| bool | HasTag (const string &tag) const |
| void | AddTag (const string &tag) |
| void | RemoveTag (const string &tag) |
| Public Member Functions inherited from CProjectItem_Base | |
| CProjectItem_Base (void) | |
| virtual | ~CProjectItem_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSetId (void) const |
| serial number - must be unique in a project (GBProject) Check if a value has been assigned to Id data member. More... | |
| bool | CanGetId (void) const |
| Check if it is safe to call GetId method. More... | |
| void | ResetId (void) |
| Reset Id data member. More... | |
| TId | GetId (void) const |
| Get the Id member data. More... | |
| void | SetId (TId value) |
| Assign a value to Id data member. More... | |
| TId & | SetId (void) |
| Assign a value to Id data member. More... | |
| bool | IsSetLabel (void) const |
| user-defined label Check if a value has been assigned to Label data member. More... | |
| bool | CanGetLabel (void) const |
| Check if it is safe to call GetLabel method. More... | |
| void | ResetLabel (void) |
| Reset Label data member. More... | |
| const TLabel & | GetLabel (void) const |
| Get the Label member data. More... | |
| void | SetLabel (const TLabel &value) |
| Assign a value to Label data member. More... | |
| void | SetLabel (TLabel &&value) |
| TLabel & | SetLabel (void) |
| Assign a value to Label data member. More... | |
| bool | IsSetDescr (void) const |
| user-defined descriptors Check if a value has been assigned to Descr data member. More... | |
| bool | CanGetDescr (void) const |
| Check if it is safe to call GetDescr method. More... | |
| void | ResetDescr (void) |
| Reset Descr data member. More... | |
| const TDescr & | GetDescr (void) const |
| Get the Descr member data. More... | |
| TDescr & | SetDescr (void) |
| Assign a value to Descr data member. More... | |
| bool | IsSetItem (void) const |
| Check if a value has been assigned to Item data member. More... | |
| bool | CanGetItem (void) const |
| Check if it is safe to call GetItem method. More... | |
| void | ResetItem (void) |
| Reset Item data member. More... | |
| const TItem & | GetItem (void) const |
| Get the Item member data. More... | |
| void | SetItem (TItem &value) |
| Assign a value to Item data member. More... | |
| TItem & | SetItem (void) |
| Assign a value to Item data member. More... | |
| bool | IsSetData_plugin (void) const |
| name of the plugin that can handle External Data for the project Check if a value has been assigned to Data_plugin data member. More... | |
| bool | CanGetData_plugin (void) const |
| Check if it is safe to call GetData_plugin method. More... | |
| void | ResetData_plugin (void) |
| Reset Data_plugin data member. More... | |
| const TData_plugin & | GetData_plugin (void) const |
| Get the Data_plugin member data. More... | |
| void | SetData_plugin (const TData_plugin &value) |
| Assign a value to Data_plugin data member. More... | |
| void | SetData_plugin (TData_plugin &&value) |
| TData_plugin & | SetData_plugin (void) |
| Assign a value to Data_plugin data member. More... | |
| bool | IsSetDisabled (void) const |
| "folder open" state Check if a value has been assigned to Disabled data member. More... | |
| bool | CanGetDisabled (void) const |
| Check if it is safe to call GetDisabled method. More... | |
| void | ResetDisabled (void) |
| Reset Disabled data member. More... | |
| TDisabled | GetDisabled (void) const |
| Get the Disabled member data. More... | |
| void | SetDisabled (TDisabled value) |
| Assign a value to Disabled data member. More... | |
| TDisabled & | SetDisabled (void) |
| Assign a value to Disabled data member. More... | |
| virtual void | Reset (void) |
| Reset the whole object. 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 |
Protected Attributes | |
| CRef< CObject > | m_UserObject |
| set< string > | m_Tags |
Private Types | |
| typedef CProjectItem_Base | Tparent |
Private Member Functions | |
| CProjectItem (const CProjectItem &value) | |
| CProjectItem & | operator= (const CProjectItem &value) |
Additional Inherited Members | |
| Public Types inherited from CProjectItem_Base | |
| enum class | E_memberIndex { e__allMandatory = 0 , e_id , e_label , e_descr , e_item , e_data_plugin , e_disabled } |
| typedef int | TId |
| typedef string | TLabel |
| typedef list< CRef< CAnnotdesc > > | TDescr |
| typedef C_Item | TItem |
| typedef string | TData_plugin |
| typedef bool | TDisabled |
| typedef Tparent::CMemberIndex< E_memberIndex, 7 > | 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... | |
| Protected Member Functions inherited from CObject | |
| virtual void | DeleteThis (void) |
| Virtual method "deleting" this object. More... | |
Detailed Description
Definition at line 59 of file ProjectItem.hpp.
Member Typedef Documentation
◆ Tparent
|
private |
Definition at line 61 of file ProjectItem.hpp.
Constructor & Destructor Documentation
◆ CProjectItem() [1/2]
| CProjectItem::CProjectItem | ( | void | ) |
Definition at line 62 of file ProjectItem.cpp.
◆ ~CProjectItem()
| CProjectItem::~CProjectItem | ( | void | ) |
Definition at line 68 of file ProjectItem.cpp.
◆ CProjectItem() [2/2]
|
private |
Member Function Documentation
◆ AddTag()
Definition at line 96 of file ProjectItem.hpp.
References set< Key, Compare >::insert(), m_Tags, and tag.
Referenced by CGBProjectHelper::AddProjectItemsFromRID(), and CVcfLoadingJob::x_CreateColumnarVCFProjectItem().
◆ GetObject()
| const CSerialObject * CProjectItem::GetObject | ( | void | ) | const |
retrieve the object pointed to as a CObject*
Definition at line 155 of file ProjectItem.cpp.
References CProjectItem_Base::C_Item::e_Annot, CProjectItem_Base::C_Item::e_Entry, CProjectItem_Base::C_Item::e_Id, CProjectItem_Base::C_Item::e_Other, CProjectItem_Base::C_Item::e_Seq_align, CProjectItem_Base::C_Item::e_Seq_align_set, CProjectItem_Base::C_Item::e_Submit, ERR_POST, CProjectItem_Base::C_Item::GetAnnot(), CProjectItem_Base::C_Item::GetEntry(), CProjectItem_Base::C_Item::GetId(), CProjectItem_Base::GetItem(), CAbstractProjectItem::GetObject(), CProjectItem_Base::C_Item::GetOther(), CProjectItem_Base::C_Item::GetSeq_align(), CProjectItem_Base::C_Item::GetSeq_align_set(), CProjectItem_Base::C_Item::GetSubmit(), CProjectItem_Base::IsSetItem(), NULL, and Warning().
Referenced by CAttachedHandles::Attach(), Convert_ProjectItem_Object(), CProjectTreeView::GetSelection(), CProjectTreeView::GetSingleObject(), CTextViewProjectItemExtension::ProjectItemAttached(), CLocalFileRestorer::RestoreFile(), s_GetFirstBioseqName(), s_SaveToSmartClient(), CPrjItemSelector_Data::Visit(), CGBDocument::x_CloseProjectItemViews(), CGBankLoadingJob::x_CreateProjectItems(), CLocalFileRestorer::x_DetachOrigObject(), and CSelectProjectOptions::x_ShowSelectProjectDialog().
◆ GetParentFolder() [1/2]
|
inline |
Definition at line 89 of file ProjectItem.hpp.
◆ GetParentFolder() [2/2]
|
inline |
Definition at line 90 of file ProjectItem.hpp.
◆ GetUserObject()
| CObject * CProjectItem::GetUserObject | ( | ) |
Definition at line 206 of file ProjectItem.cpp.
References CRef< C, Locker >::GetPointer(), and m_UserObject.
Referenced by s_DetachProjectItem().
◆ HasTag()
Definition at line 95 of file ProjectItem.hpp.
References set< Key, Compare >::end(), set< Key, Compare >::find(), m_Tags, and tag.
Referenced by CAlignProjectItemExtension::ProjectItemAttached(), CTextViewProjectItemExtension::ProjectItemAttached(), CEditProjectItemExtension::ProjectItemAttached(), and CEditProjectItemExtension::ProjectItemDetached().
◆ IsEnabled()
| bool CProjectItem::IsEnabled | ( | void | ) | const |
enabled flag
Definition at line 192 of file ProjectItem.cpp.
References CProjectItem_Base::CanGetDisabled(), and CProjectItem_Base::GetDisabled().
Referenced by CProjectTreeView::GetSelection(), CProjectTreeView::GetSingleObject(), and CProjectTreePanel::OnEnableDisable().
◆ operator=()
|
private |
◆ RemoveTag()
Definition at line 97 of file ProjectItem.hpp.
References set< Key, Compare >::erase(), m_Tags, and tag.
Referenced by CAlignProjectItemExtension::ProjectItemAttached().
◆ SetCreateDate() [1/2]
Definition at line 80 of file ProjectItem.cpp.
References CSerialObject::Assign(), CRef< C, Locker >::Reset(), CAnnotdesc_Base::SetCreate_date(), and CProjectItem_Base::SetDescr().
◆ SetCreateDate() [2/2]
SetCreateDate() will add a descriptor for creation date, and insure that only one such descriptor exists.
Definition at line 73 of file ProjectItem.cpp.
Referenced by s_CollapseProjectFolder().
◆ SetModifiedDate() [1/2]
Definition at line 111 of file ProjectItem.cpp.
References CSerialObject::Assign(), CRef< C, Locker >::Reset(), CProjectItem_Base::SetDescr(), and CAnnotdesc_Base::SetUpdate_date().
◆ SetModifiedDate() [2/2]
SetModifiedDate() will add a descriptor for the update date, and insure that only one such descriptor exists.
Definition at line 104 of file ProjectItem.cpp.
◆ SetObject()
| void CProjectItem::SetObject | ( | CSerialObject & | object | ) |
wrapper for setting the object pointed to by this item
Definition at line 135 of file ProjectItem.cpp.
References CSerialObject::GetThisTypeInfo(), CAbstractProjectItem::Set(), CProjectItem_Base::C_Item::SetAnnot(), CProjectItem_Base::C_Item::SetEntry(), CProjectItem_Base::C_Item::SetId(), CProjectItem_Base::SetItem(), CProjectItem_Base::C_Item::SetOther(), CProjectItem_Base::C_Item::SetSeq_align(), CProjectItem_Base::C_Item::SetSeq_align_set(), and CProjectItem_Base::C_Item::SetSubmit().
Referenced by CObjectLoadingTask::AddObjects(), CGBProjectHelper::AddProjectItemsFromRID(), s_CollapseProjectFolder(), CLocalFileRestorer::x_AttachNewObject(), CProjectServiceTestJob::x_CreateItems(), CGBankLoadingJob::x_CreateProjectItems(), CTreeBuilderJob::x_CreateProjectItems(), CBamLoadingJob::x_CreateProjectItems(), CVcfLoadingJob::x_CreateSeqIdProjectItem(), CGBProjectTool::x_LoadGeneralData(), and CGBProjectTool::x_LoadGffData().
◆ SetParentFolder()
|
inline |
Definition at line 88 of file ProjectItem.hpp.
◆ SetUserObject()
| void CProjectItem::SetUserObject | ( | CObject * | object | ) |
Definition at line 201 of file ProjectItem.cpp.
References m_UserObject, and CRef< C, Locker >::Reset().
Referenced by s_AttachProjectItem().
Member Data Documentation
◆ m_Tags
Definition at line 106 of file ProjectItem.hpp.
Referenced by AddTag(), HasTag(), and RemoveTag().
◆ m_UserObject
Definition at line 105 of file ProjectItem.hpp.
Referenced by GetUserObject(), and SetUserObject().
The documentation for this class was generated from the following files:
- include/objects/gbproj/ProjectItem.hpp
- src/objects/gbproj/ProjectItem.cpp
