CGBProject_Base Class Reference

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

Search Toolkit Book for CGBProject_Base

Version 1 (unversioned) project This project description is frozen as of 12/1/2005 and should not be modified. More...

#include <gui/objects/GBProject_.hpp>

Inheritance diagram for CGBProject_Base:

Collaboration diagram for CGBProject_Base:

Public Types
enum class	E_memberIndex {   e__allMandatory = 0 , e_counter , e_descr , e_core ,   e_extra , e_orig_message , e_history , e_data_plugin ,   e_plugin_param , e_annot , e_loaders , e_views }
typedef int	TCounter
typedef CProjectDescr	TDescr
typedef CProjectItem	TCore
typedef CProjectFolder	TExtra
typedef CPluginMessage	TOrig_message
typedef list< CRef< CProjectHistoryItem > >	THistory
typedef string	TData_plugin
typedef string	TPlugin_param
typedef list< CRef< CProjectAnnot > >	TAnnot
typedef list< CRef< CLoaderDescriptor > >	TLoaders
typedef list< CRef< CViewDescriptor > >	TViews
typedef Tparent::CMemberIndex< E_memberIndex, 12 >	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...

Public Member Functions
	CGBProject_Base (void)
virtual	~CGBProject_Base (void)
	DECLARE_INTERNAL_TYPE_INFO ()
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	IsSetCore (void) const
	the core item we wrap Check if a value has been assigned to Core data member. More...
bool	CanGetCore (void) const
	Check if it is safe to call GetCore method. More...
void	ResetCore (void)
	Reset Core data member. More...
const TCore &	GetCore (void) const
	Get the Core member data. More...
void	SetCore (TCore &value)
	Assign a value to Core data member. More...
TCore &	SetCore (void)
	Assign a value to Core data member. More...
bool	IsSetExtra (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 Extra data member. More...
bool	CanGetExtra (void) const
	Check if it is safe to call GetExtra method. More...
void	ResetExtra (void)
	Reset Extra data member. More...
const TExtra &	GetExtra (void) const
	Get the Extra member data. More...
void	SetExtra (TExtra &value)
	Assign a value to Extra data member. More...
TExtra &	SetExtra (void)
	Assign a value to Extra data member. More...
bool	IsSetOrig_message (void) const
	a copy of the original plugin message used to generate this project Check if a value has been assigned to Orig_message data member. More...
bool	CanGetOrig_message (void) const
	Check if it is safe to call GetOrig_message method. More...
void	ResetOrig_message (void)
	Reset Orig_message data member. More...
const TOrig_message &	GetOrig_message (void) const
	Get the Orig_message member data. More...
void	SetOrig_message (TOrig_message &value)
	Assign a value to Orig_message data member. More...
TOrig_message &	SetOrig_message (void)
	Assign a value to 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...
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

Private Types
typedef CSerialObject	Tparent

Private Member Functions
	CGBProject_Base (const CGBProject_Base &)
CGBProject_Base &	operator= (const CGBProject_Base &)

Private Attributes
Uint4	m_set_State [1]
int	m_Counter
CRef< TDescr >	m_Descr
CRef< TCore >	m_Core
CRef< TExtra >	m_Extra
CRef< TOrig_message >	m_Orig_message
list< CRef< CProjectHistoryItem > >	m_History
string	m_Data_plugin
string	m_Plugin_param
list< CRef< CProjectAnnot > >	m_Annot
list< CRef< CLoaderDescriptor > >	m_Loaders
list< CRef< CViewDescriptor > >	m_Views

Additional Inherited Members
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

Version 1 (unversioned) project This project description is frozen as of 12/1/2005 and should not be modified.

Further, its core dependencies should also not be changed in any breaking way.

CGBProject_Base –

Definition at line 93 of file GBProject_.hpp.

---

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

• include/gui/objects/GBProject_.hpp
• src/gui/objects/GBProject_.cpp