NCBI C++ ToolKit
Public Types | Public Member Functions | List of all members
IGBProject Class Referenceabstract

Represents ASN.1 type GBProject defined in file gui_objects.asn

Search Toolkit Book for IGBProject

IGBProject - abstract interface for a project used by CGBProjectHandle. More...

#include <objects/gbproj/igbproject.hpp>

+ Inheritance diagram for IGBProject:

Public Types

enum  EProjectVersion { eVersion_Invalid = -1 , eVersion_Unknown = 0 , eVersion1 = 1 , eVersion2 = 2 }
 
typedef CProjectDescr TDescr
 
typedef CProjectFolder TData
 
typedef list< CRef< CProjectAnnot > > TAnnot
 
typedef list< CRef< CViewDescriptor > > TViews
 
typedef list< CRef< CLoaderDescriptor > > TDataLoaders
 
typedef list< CRef< CUser_object > > TViewSettings
 

Public Member Functions

virtual ~IGBProject ()
 
virtual EProjectVersion GetVersion () const =0
 retrieve this project's version; this is fixed per subclass More...
 
virtual void AddItem (CProjectItem &item, CProjectFolder &folder)=0
 Add an item to the current project. More...
 
virtual const CProjectFolderGetData () const =0
 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...
 
virtual CProjectFolderSetData ()=0
 
virtual bool IsSetDescr () const =0
 retrieve our project's descriptor set More...
 
virtual const CProjectDescrGetDescr () const =0
 
virtual CProjectDescrSetDescr ()=0
 
virtual bool IsSetAnnot () const =0
 retrieve a set of annotations for this project More...
 
virtual const TAnnotGetAnnot () const =0
 
virtual TAnnotSetAnnot ()=0
 
virtual void SetCreateDate (const CDate &date)=0
 SetCreateDate() will add a descriptor for creation date. More...
 
virtual void SetModifiedDate (const CDate &date)=0
 SetModifiedDate() will add a descriptor for the update date. More...
 
virtual bool IsSetDataLoaders () const =0
 data loader info. More...
 
virtual const TDataLoadersGetDataLoaders () const =0
 
virtual TDataLoadersSetDataLoaders ()=0
 
virtual bool IsSetViews () const =0
 view info More...
 
virtual const TViewsGetViews () const =0
 
virtual TViewsSetViews ()=0
 
virtual bool IsSetViewSettings () const =0
 view-specific settings. More...
 
virtual const TViewSettingsGetViewSettings () const =0
 
virtual TViewSettingsSetViewSettings ()=0
 

Detailed Description

IGBProject - abstract interface for a project used by CGBProjectHandle.

Definition at line 56 of file igbproject.hpp.

Member Typedef Documentation

◆ TAnnot

Definition at line 68 of file igbproject.hpp.

◆ TData

Definition at line 67 of file igbproject.hpp.

◆ TDataLoaders

Definition at line 70 of file igbproject.hpp.

◆ TDescr

Definition at line 66 of file igbproject.hpp.

◆ TViews

Definition at line 69 of file igbproject.hpp.

◆ TViewSettings

Definition at line 71 of file igbproject.hpp.

Member Enumeration Documentation

◆ EProjectVersion

Enumerator
eVersion_Invalid 
eVersion_Unknown 
eVersion1 
eVersion2 

Definition at line 59 of file igbproject.hpp.

Constructor & Destructor Documentation

◆ ~IGBProject()

virtual IGBProject::~IGBProject ( )
inlinevirtual

Definition at line 74 of file igbproject.hpp.

Member Function Documentation

◆ AddItem()

virtual void IGBProject::AddItem ( CProjectItem item,
CProjectFolder folder 
)
pure virtual

Add an item to the current project.

Implemented in CGBProject_ver2, and CGBProject.

◆ GetAnnot()

virtual const TAnnot& IGBProject::GetAnnot ( ) const
pure virtual

Implemented in CGBProject_ver2, and CGBProject.

Referenced by CGBProjectHandle::GetAnnot().

◆ GetData()

virtual const CProjectFolder& IGBProject::GetData ( ) const
pure 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

Implemented in CGBProject_ver2, and CGBProject.

Referenced by CGBProjectHandle::GetData().

◆ GetDataLoaders()

virtual const TDataLoaders& IGBProject::GetDataLoaders ( ) const
pure virtual

Implemented in CGBProject_ver2, and CGBProject.

◆ GetDescr()

virtual const CProjectDescr& IGBProject::GetDescr ( ) const
pure virtual

Implemented in CGBProject_ver2, and CGBProject.

Referenced by CGBProjectHandle::GetDescr().

◆ GetVersion()

virtual EProjectVersion IGBProject::GetVersion ( ) const
pure virtual

retrieve this project's version; this is fixed per subclass

Implemented in CGBProject_ver2, and CGBProject.

Referenced by CGBProjectHandle::GetVersion(), CGBProjectHandle::Save(), and CGBDocument::x_SaveFile().

◆ GetViews()

virtual const TViews& IGBProject::GetViews ( ) const
pure virtual

Implemented in CGBProject_ver2, and CGBProject.

◆ GetViewSettings()

virtual const TViewSettings& IGBProject::GetViewSettings ( ) const
pure virtual

Implemented in CGBProject_ver2, and CGBProject.

◆ IsSetAnnot()

virtual bool IGBProject::IsSetAnnot ( ) const
pure virtual

retrieve a set of annotations for this project

Implemented in CGBProject_ver2, and CGBProject.

Referenced by CGBProjectHandle::IsSetAnnot().

◆ IsSetDataLoaders()

virtual bool IGBProject::IsSetDataLoaders ( ) const
pure virtual

data loader info.

Implemented in CGBProject_ver2, and CGBProject.

◆ IsSetDescr()

virtual bool IGBProject::IsSetDescr ( ) const
pure virtual

retrieve our project's descriptor set

Implemented in CGBProject_ver2, and CGBProject.

◆ IsSetViews()

virtual bool IGBProject::IsSetViews ( ) const
pure virtual

view info

Implemented in CGBProject_ver2, and CGBProject.

◆ IsSetViewSettings()

virtual bool IGBProject::IsSetViewSettings ( ) const
pure virtual

view-specific settings.

Implemented in CGBProject_ver2, and CGBProject.

◆ SetAnnot()

virtual TAnnot& IGBProject::SetAnnot ( )
pure virtual

Implemented in CGBProject_ver2, and CGBProject.

Referenced by CGBProjectHandle::SetAnnot().

◆ SetCreateDate()

virtual void IGBProject::SetCreateDate ( const CDate date)
pure virtual

SetCreateDate() will add a descriptor for creation date.

Implemented in CGBProject_ver2, and CGBProject.

Referenced by CGBProjectHandle::SetCreateDate().

◆ SetData()

virtual CProjectFolder& IGBProject::SetData ( )
pure virtual

Implemented in CGBProject_ver2, and CGBProject.

Referenced by CGBProjectHandle::SetData().

◆ SetDataLoaders()

virtual TDataLoaders& IGBProject::SetDataLoaders ( )
pure virtual

Implemented in CGBProject_ver2, and CGBProject.

◆ SetDescr()

virtual CProjectDescr& IGBProject::SetDescr ( )
pure virtual

Implemented in CGBProject_ver2, and CGBProject.

Referenced by CGBProjectHandle::SetDescr().

◆ SetModifiedDate()

virtual void IGBProject::SetModifiedDate ( const CDate date)
pure virtual

SetModifiedDate() will add a descriptor for the update date.

Implemented in CGBProject_ver2, and CGBProject.

Referenced by CGBProjectHandle::SetModifiedDate().

◆ SetViews()

virtual TViews& IGBProject::SetViews ( )
pure virtual

Implemented in CGBProject_ver2, and CGBProject.

◆ SetViewSettings()

virtual TViewSettings& IGBProject::SetViewSettings ( )
pure virtual

Implemented in CGBProject_ver2, and CGBProject.


The documentation for this class was generated from the following file:
Modified on Fri Apr 12 17:16:30 2024 by modify_doxy.py rev. 669887