|
NCBI C++ ToolKit
|
Search Toolkit Book for CGBProject_ver2
#include <objects/gbproj/GBProject_ver2.hpp>
Inheritance diagram for CGBProject_ver2:
Collaboration diagram for CGBProject_ver2:Public Member Functions | |
| CGBProject_ver2 (void) | |
| ~CGBProject_ver2 (void) | |
IGBProject Implementation | |
See IGNProject for comments | |
| EProjectVersion | GetVersion () const |
| retrieve this project's version; this is fixed per subclass More... | |
| void | AddItem (CProjectItem &item, CProjectFolder &folder) |
| Add an item to the current project. More... | |
| const CProjectFolder & | GetData () const |
| retrieve our project's data, in the form of a project folder this may be a contrived entity, and it is up to a project to determine what parts belong where More... | |
| CProjectFolder & | SetData () |
| bool | IsSetDescr () const |
| retrieve the descriptor set for this project More... | |
| const CProjectDescr & | GetDescr () const |
| CProjectDescr & | SetDescr () |
| void | SetDescr (CProjectDescr &descr) |
| bool | IsSetAnnot () const |
| retrieve the descriptor set for this project More... | |
| const IGBProject::TAnnot & | GetAnnot () const |
| IGBProject::TAnnot & | SetAnnot () |
| virtual bool | IsSetDataLoaders () const |
| retrieve the data loader descriptor set for this project More... | |
| virtual const TDataLoaders & | GetDataLoaders () const |
| virtual TDataLoaders & | SetDataLoaders () |
| bool | IsSetViews () const |
| retrieve the view descriptor set for this project More... | |
| const IGBProject::TViews & | GetViews () const |
| IGBProject::TViews & | SetViews () |
| virtual bool | IsSetViewSettings () const |
| view-specific settings. More... | |
| virtual const TViewSettings & | GetViewSettings () const |
| virtual TViewSettings & | SetViewSettings () |
| void | SetDirtyFlag (bool dirty) |
| bool | GetDirtyFlag () const |
| void | SetCreateDate (const CDate &date) |
| SetCreateDate() will add a descriptor for creation date. More... | |
| void | SetModifiedDate (const CDate &date) |
| SetModifiedDate() will add a descriptor for the update date. More... | |
Public Member Functions inherited from CGBProject_ver2_Base | |
| CGBProject_ver2_Base (void) | |
| virtual | ~CGBProject_ver2_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSetProject_version (void) const |
| the version for this project for this particular instance, this should always be 2 this data element *MUST* be first Check if a value has been assigned to Project_version data member. More... | |
| bool | CanGetProject_version (void) const |
| Check if it is safe to call GetProject_version method. More... | |
| void | ResetProject_version (void) |
| Reset Project_version data member. More... | |
| const TProject_version & | GetProject_version (void) const |
| Get the Project_version member data. More... | |
| void | SetProject_version (const TProject_version &value) |
| Assign a value to Project_version data member. More... | |
| void | SetProject_version (TProject_version &&value) |
| TProject_version & | SetProject_version (void) |
| Assign a value to Project_version data member. More... | |
| bool | IsSetCounter (void) const |
| next counter for project items Check if a value has been assigned to Counter data member. More... | |
| bool | CanGetCounter (void) const |
| Check if it is safe to call GetCounter method. More... | |
| void | ResetCounter (void) |
| Reset Counter data member. More... | |
| void | SetDefaultCounter (void) |
| Assign default value to Counter data member. More... | |
| TCounter | GetCounter (void) const |
| Get the Counter member data. More... | |
| void | SetCounter (TCounter value) |
| Assign a value to Counter data member. More... | |
| TCounter & | SetCounter (void) |
| Assign a value to Counter data member. More... | |
| bool | IsSetDescr (void) const |
| standard 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... | |
| void | SetDescr (TDescr &value) |
| Assign a value to Descr data member. More... | |
| TDescr & | SetDescr (void) |
| Assign a value to Descr data member. More... | |
| bool | IsSetData (void) const |
| a set of extra analyses perfromed by the user each of these may have descriptors Check if a value has been assigned to Data data member. More... | |
| bool | CanGetData (void) const |
| Check if it is safe to call GetData method. More... | |
| void | ResetData (void) |
| Reset Data data member. More... | |
| const TData & | GetData (void) const |
| Get the Data member data. More... | |
| void | SetData (TData &value) |
| Assign a value to Data data member. More... | |
| TData & | SetData (void) |
| Assign a value to Data data member. More... | |
| bool | IsSetObsolete_orig_message (void) const |
| a copy of the original plugin message used to generate this project This is deprecated. More... | |
| bool | CanGetObsolete_orig_message (void) const |
| Check if it is safe to call GetObsolete_orig_message method. More... | |
| void | ResetObsolete_orig_message (void) |
| Reset Obsolete_orig_message data member. More... | |
| const TObsolete_orig_message & | GetObsolete_orig_message (void) const |
| Get the Obsolete_orig_message member data. More... | |
| void | SetObsolete_orig_message (TObsolete_orig_message &value) |
| Assign a value to Obsolete_orig_message data member. More... | |
| TObsolete_orig_message & | SetObsolete_orig_message (void) |
| Assign a value to Obsolete_orig_message data member. More... | |
| bool | IsSetHistory (void) const |
| history of things done to this object Check if a value has been assigned to History data member. More... | |
| bool | CanGetHistory (void) const |
| Check if it is safe to call GetHistory method. More... | |
| void | ResetHistory (void) |
| Reset History data member. More... | |
| const THistory & | GetHistory (void) const |
| Get the History member data. More... | |
| THistory & | SetHistory (void) |
| Assign a value to History 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 | IsSetPlugin_param (void) const |
| optional parameter for the data-plugin Check if a value has been assigned to Plugin_param data member. More... | |
| bool | CanGetPlugin_param (void) const |
| Check if it is safe to call GetPlugin_param method. More... | |
| void | ResetPlugin_param (void) |
| Reset Plugin_param data member. More... | |
| const TPlugin_param & | GetPlugin_param (void) const |
| Get the Plugin_param member data. More... | |
| void | SetPlugin_param (const TPlugin_param &value) |
| Assign a value to Plugin_param data member. More... | |
| void | SetPlugin_param (TPlugin_param &&value) |
| TPlugin_param & | SetPlugin_param (void) |
| Assign a value to Plugin_param data member. More... | |
| bool | IsSetAnnot (void) const |
| arbitrary annotations Check if a value has been assigned to Annot data member. More... | |
| bool | CanGetAnnot (void) const |
| Check if it is safe to call GetAnnot method. More... | |
| void | ResetAnnot (void) |
| Reset Annot data member. More... | |
| const TAnnot & | GetAnnot (void) const |
| Get the Annot member data. More... | |
| TAnnot & | SetAnnot (void) |
| Assign a value to Annot data member. More... | |
| bool | IsSetLoaders (void) const |
| a set of data sources including data loader and data Check if a value has been assigned to Loaders data member. More... | |
| bool | CanGetLoaders (void) const |
| Check if it is safe to call GetLoaders method. More... | |
| void | ResetLoaders (void) |
| Reset Loaders data member. More... | |
| const TLoaders & | GetLoaders (void) const |
| Get the Loaders member data. More... | |
| TLoaders & | SetLoaders (void) |
| Assign a value to Loaders data member. More... | |
| bool | IsSetViews (void) const |
| bool | CanGetViews (void) const |
| Check if it is safe to call GetViews method. More... | |
| void | ResetViews (void) |
| Reset Views data member. More... | |
| const TViews & | GetViews (void) const |
| Get the Views member data. More... | |
| TViews & | SetViews (void) |
| Assign a value to Views data member. More... | |
| bool | IsSetView_settings (void) const |
| set of view-specific settings Check if a value has been assigned to View_settings data member. More... | |
| bool | CanGetView_settings (void) const |
| Check if it is safe to call GetView_settings method. More... | |
| void | ResetView_settings (void) |
| Reset View_settings data member. More... | |
| const TView_settings & | GetView_settings (void) const |
| Get the View_settings member data. More... | |
| TView_settings & | SetView_settings (void) |
| Assign a value to View_settings 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) noexcept |
| Assignment operator. More... | |
| bool | CanBeDeleted (void) const noexcept |
| Check if object can be deleted. More... | |
| bool | IsAllocatedInPool (void) const noexcept |
| Check if object is allocated in memory pool (not system heap) More... | |
| bool | Referenced (void) const noexcept |
| Check if object is referenced. More... | |
| bool | ReferencedOnlyOnce (void) const noexcept |
| Check if object is referenced only once. More... | |
| void | AddReference (void) const |
| Add reference to object. More... | |
| void | RemoveReference (void) const noexcept |
| 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 IGBProject | |
| virtual | ~IGBProject () |
Private Types | |
| typedef CGBProject_ver2_Base | Tparent |
Private Member Functions | |
| CGBProject_ver2 (const CGBProject_ver2 &value) | |
| CGBProject_ver2 & | operator= (const CGBProject_ver2 &value) |
Private Attributes | |
| bool | m_Dirty |
Definition at line 54 of file GBProject_ver2.hpp.
|
private |
Definition at line 58 of file GBProject_ver2.hpp.
| CGBProject_ver2::CGBProject_ver2 | ( | void | ) |
Definition at line 53 of file GBProject_ver2.cpp.
References CGBProject_ver2_Base::SetProject_version().
| CGBProject_ver2::~CGBProject_ver2 | ( | void | ) |
Definition at line 60 of file GBProject_ver2.cpp.
|
private |
|
virtual |
Add an item to the current project.
Implements IGBProject.
Definition at line 79 of file GBProject_ver2.cpp.
References CProjectFolder::AddChildItem(), CGBProject_ver2_Base::GetCounter(), CGBProject_ver2_Base::SetCounter(), and CProjectItem_Base::SetId().
|
virtual |
Implements IGBProject.
Definition at line 142 of file GBProject_ver2.cpp.
References CGBProject_ver2_Base::GetAnnot().
|
virtual |
retrieve our project's data, in the form of a project folder this may be a contrived entity, and it is up to a project to determine what parts belong where
Implements IGBProject.
Definition at line 89 of file GBProject_ver2.cpp.
References CGBProject_ver2_Base::GetData().
Referenced by CGBProject_ver2LabelHandler::GetLabel(), CTableDataGBProject::GetStringValue(), SetData(), CGBProjectHandle::x_FixIdGenerator(), and CTableDataGBProject::x_Init().
|
virtual |
Implements IGBProject.
Definition at line 160 of file GBProject_ver2.cpp.
References CGBProject_ver2_Base::GetLoaders().
|
virtual |
Implements IGBProject.
Definition at line 117 of file GBProject_ver2.cpp.
References CGBProject_ver2_Base::GetDescr().
Referenced by CGBProject_ver2LabelHandler::GetLabel().
| bool CGBProject_ver2::GetDirtyFlag | ( | ) | const |
Definition at line 235 of file GBProject_ver2.cpp.
References m_Dirty.
|
inlinevirtual |
retrieve this project's version; this is fixed per subclass
Implements IGBProject.
Definition at line 115 of file GBProject_ver2.hpp.
References IGBProject::eVersion2.
|
virtual |
Implements IGBProject.
Definition at line 179 of file GBProject_ver2.cpp.
References CGBProject_ver2_Base::GetViews().
|
virtual |
Implements IGBProject.
Definition at line 197 of file GBProject_ver2.cpp.
References CGBProject_ver2_Base::GetView_settings().
|
virtual |
retrieve the descriptor set for this project
Implements IGBProject.
Definition at line 136 of file GBProject_ver2.cpp.
References CGBProject_ver2_Base::IsSetAnnot().
|
virtual |
retrieve the data loader descriptor set for this project
Implements IGBProject.
Definition at line 154 of file GBProject_ver2.cpp.
References CGBProject_ver2_Base::IsSetLoaders().
|
virtual |
retrieve the descriptor set for this project
Implements IGBProject.
Definition at line 111 of file GBProject_ver2.cpp.
References CGBProject_ver2_Base::IsSetDescr().
Referenced by CGBProject_ver2LabelHandler::GetLabel().
|
virtual |
retrieve the view descriptor set for this project
Implements IGBProject.
Definition at line 173 of file GBProject_ver2.cpp.
References CGBProject_ver2_Base::IsSetViews().
|
virtual |
view-specific settings.
Implements IGBProject.
Definition at line 191 of file GBProject_ver2.cpp.
References CGBProject_ver2_Base::IsSetView_settings().
|
private |
|
virtual |
Implements IGBProject.
Definition at line 148 of file GBProject_ver2.cpp.
References CGBProject_ver2_Base::SetAnnot().
SetCreateDate() will add a descriptor for creation date.
Implements IGBProject.
Definition at line 209 of file GBProject_ver2.cpp.
References CProjectDescr::SetCreateDate(), SetDescr(), and SetDirtyFlag().
|
virtual |
Implements IGBProject.
Definition at line 95 of file GBProject_ver2.cpp.
References CTime::eCurrent, GetData(), info, CGBProject_ver2_Base::IsSetData(), CGBProject_ver2_Base::SetData(), and CProjectFolder_Base::SetInfo().
|
virtual |
Implements IGBProject.
Definition at line 166 of file GBProject_ver2.cpp.
References CGBProject_ver2_Base::SetLoaders().
|
virtual |
Implements IGBProject.
Definition at line 123 of file GBProject_ver2.cpp.
References CGBProject_ver2_Base::SetDescr().
Referenced by SetCreateDate(), SetDirtyFlag(), and SetModifiedDate().
| void CGBProject_ver2::SetDescr | ( | CProjectDescr & | descr | ) |
Definition at line 129 of file GBProject_ver2.cpp.
References CGBProject_ver2_Base::SetDescr().
| void CGBProject_ver2::SetDirtyFlag | ( | bool | dirty | ) |
Definition at line 223 of file GBProject_ver2.cpp.
References m_Dirty, CTime::SetCurrent(), SetDescr(), and CProjectDescr_Base::SetModified_date().
Referenced by SetCreateDate(), and SetModifiedDate().
SetModifiedDate() will add a descriptor for the update date.
Implements IGBProject.
Definition at line 216 of file GBProject_ver2.cpp.
References SetDescr(), SetDirtyFlag(), and CProjectDescr::SetModifiedDate().
|
virtual |
Implements IGBProject.
Definition at line 185 of file GBProject_ver2.cpp.
References CGBProject_ver2_Base::SetViews().
|
virtual |
Implements IGBProject.
Definition at line 203 of file GBProject_ver2.cpp.
References CGBProject_ver2_Base::SetView_settings().
|
private |
Definition at line 108 of file GBProject_ver2.hpp.
Referenced by GetDirtyFlag(), and SetDirtyFlag().