Search Toolkit Book for CGBProjectHandle

#include <gui/objects/GBProjectHandle.hpp>

Inheritance diagram for CGBProjectHandle:

Collaboration diagram for CGBProjectHandle:

Public Types
typedef CAtomicCounter::TValue	TId

typedef IGBProject::TAnnot	TAnnot

typedef IGBProject::TData	TData

typedef IGBProject::TDataLoaders	TDataLoaders

Public Types inherited from CGBProjectHandle_Base
enum class	E_memberIndex { e__allMandatory = 0 , e_filename , e_disabled }

typedef string	TFilename

typedef bool	TDisabled

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...

Public Member Functions
	CGBProjectHandle (void)

	CGBProjectHandle (CGBProject_ver2 &proj_impl)

virtual	~CGBProjectHandle (void)

IGBProject::EProjectVersion	GetVersion () const
	retrieve this project's version this is fixed per subclass More...

void	AddDataLoader (CLoaderDescriptor &loader)

const TDataLoaders &	GetDataLoaders () const

TDataLoaders &	GetDataLoaders ()

CRef< CLoaderDescriptor >	FindDataLoaderByLabel (const string &label)

CProjectFolder *	FindProjectFolderById (CProjectFolder::TId id)

CProjectItem *	FindProjectItemById (CProjectItem::TId id)

string	GetViewSettings (const string &view_type, const string &view_ins_id) const

void	SaveViewSettings (const string &view_type, const string &view_ins_id, const string &settings)

Named serialization interface
const IGBProject &	GetProject () const

IGBProject &	SetProject ()

bool	IsLoaded () const
	check to see if our project is loaded More...

void	SetLoaded (bool loaded=true)

bool	IsDirty () const

void	SetDirty (bool dirty=true)

bool	GetDataModified () const

void	SetDataModified (bool modified=true)

bool	Load (CNcbiIstream &istr, ICanceled *canceledCallback)
	force a project to be loaded from an external stream More...

void	Save (CNcbiOstream &ostr, ESerialDataFormat fmt) const
	Serialize to a stream in a given format. More...

virtual void	SetScope (CScope *scope)
	establish a tie to the object manager via a scope More...

virtual CScope *	GetScope () const

IGBProject forwarded interface
void	AddItem (CProjectItem &item, CProjectFolder &parent_folder)

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	IsSetAnnot () const
	retrieve a set of annotations for this project More...

const IGBProject::TAnnot &	GetAnnot () const

IGBProject::TAnnot &	SetAnnot ()

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 CGBProjectHandle_Base
	CGBProjectHandle_Base (void)

virtual	~CGBProjectHandle_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

bool	IsSetFilename (void) const
	URI for the project this can be a local file (default) or an http:// or ftp:// link Check if a value has been assigned to Filename data member. More...

bool	CanGetFilename (void) const
	Check if it is safe to call GetFilename method. More...

void	ResetFilename (void)
	Reset Filename data member. More...

const TFilename &	GetFilename (void) const
	Get the Filename member data. More...

void	SetFilename (const TFilename &value)
	Assign a value to Filename data member. More...

void	SetFilename (TFilename &&value)

TFilename &	SetFilename (void)
	Assign a value to Filename data member. More...

bool	IsSetDisabled (void) const
	flag: is this project disabled? 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...

void	SetDefaultDisabled (void)
	Assign default value to 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

Static Public Attributes
static TId	sm_NullId = 0

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
void	x_LinkChildFolders (CProjectFolder &folder)

void	x_FixIdGenerator (CGBProject_ver2 &project)

Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...

Protected Attributes
CIRef< IGBProject >	m_Project
	the pointer to the actual project More...

TId	m_Id
	unique runtime identifier for this project More...

bool	m_Dirty
	Dirty flag indicates whether the project has unsaved changes. More...

bool	m_DataModified = false

CAtomicCounter_WithAutoInit	m_Loaded

CRef< CScope >	m_Scope

string	m_Title
	the Scope associated with the Project More...

string	m_ShortTitle

Static Protected Attributes
static CAtomicCounter	sm_Counter
	auto incremented ID counter More...

Private Types
typedef CGBProjectHandle_Base	Tparent

Private Member Functions
	CGBProjectHandle (const CGBProjectHandle &value)

CGBProjectHandle &	operator= (const CGBProjectHandle &value)

State Management and Inspection
ID already defined in projects
TId	GetId () const

const CProjectDescr &	GetDescr () const
	retrieve our project's descriptor set More...

CProjectDescr &	SetDescr ()

const string &	GetTitle (void) const
	Get a description of our contents. More...

const string &	GetShortTitle (void) const

virtual void	Clear (void)
	Clear project. More...

bool	IsProjectItemLabelUnique (const string &label) const

string	MakeUniqueItemLabel (const string &label) const
	Create a unique label for a project item. More...

string	MakeUniqueFolderLabel (const string &label, objects::CProjectFolder &parent_folder) const
	Create a label for a folder that will be unique in the scope of the parent folder. More...

string	MakeUniqueDataLoaderLabel (const string &label) const
	Create a unique label for a data loader. More...

static TId	GetNextId ()
	Retrieve the unique ID for our project. More...

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)

Detailed Description

Definition at line 68 of file GBProjectHandle.hpp.

Member Typedef Documentation

◆ TAnnot

typedef IGBProject::TAnnot CGBProjectHandle::TAnnot

Definition at line 73 of file GBProjectHandle.hpp.

◆ TData

typedef IGBProject::TData CGBProjectHandle::TData

Definition at line 74 of file GBProjectHandle.hpp.

◆ TDataLoaders

typedef IGBProject::TDataLoaders CGBProjectHandle::TDataLoaders

Definition at line 75 of file GBProjectHandle.hpp.

◆ TId

typedef CAtomicCounter::TValue CGBProjectHandle::TId

Definition at line 72 of file GBProjectHandle.hpp.

◆ Tparent

typedef CGBProjectHandle_Base CGBProjectHandle::Tparent

private

Definition at line 70 of file GBProjectHandle.hpp.

Constructor & Destructor Documentation

◆ CGBProjectHandle() [1/3]

CGBProjectHandle::CGBProjectHandle ( void )

Definition at line 295 of file GBProjectHandle.cpp.

References CLabel::HasHandler(), CLabel::RegisterLabelHandler(), and CGBProjectHandle_Base::SetFilename().

◆ CGBProjectHandle() [2/3]

CGBProjectHandle::CGBProjectHandle ( CGBProject_ver2 & proj_impl )

Definition at line 308 of file GBProjectHandle.cpp.

References CLabel::HasHandler(), m_Project, CLabel::RegisterLabelHandler(), SetData(), CGBProjectHandle_Base::SetFilename(), and x_LinkChildFolders().

◆ ~CGBProjectHandle()

CGBProjectHandle::~CGBProjectHandle ( void )

virtual

Definition at line 325 of file GBProjectHandle.cpp.

◆ CGBProjectHandle() [3/3]

CGBProjectHandle::CGBProjectHandle ( const CGBProjectHandle & value )

private

Member Function Documentation

◆ AddDataLoader()

void CGBProjectHandle::AddDataLoader ( CLoaderDescriptor & loader )

Definition at line 636 of file GBProjectHandle.cpp.

References m_Project.

◆ AddItem()

void CGBProjectHandle::AddItem	(	CProjectItem &	item,
		CProjectFolder &	parent_folder
	)

Definition at line 728 of file GBProjectHandle.cpp.

References m_Project.

◆ Clear()

void CGBProjectHandle::Clear ( void )

virtual

Clear project.

Definition at line 564 of file GBProjectHandle.cpp.

References m_Loaded, m_Project, m_Scope, CRef< C, Locker >::Reset(), and CAtomicCounter::Set().

◆ FindDataLoaderByLabel()

CRef< CLoaderDescriptor > CGBProjectHandle::FindDataLoaderByLabel ( const string & label )

Definition at line 654 of file GBProjectHandle.cpp.

References label, m_Project, and NON_CONST_ITERATE.

◆ FindProjectFolderById()

CProjectFolder * CGBProjectHandle::FindProjectFolderById ( CProjectFolder::TId id )

Definition at line 669 of file GBProjectHandle.cpp.

References CProjectFolder::FindChildFolderById(), CProjectFolder::GetId(), and SetData().

◆ FindProjectItemById()

CProjectItem * CGBProjectHandle::FindProjectItemById ( CProjectItem::TId id )

Definition at line 677 of file GBProjectHandle.cpp.

References CProjectFolder::FindProjectItemById(), and SetData().

◆ GetAnnot()

const IGBProject::TAnnot & CGBProjectHandle::GetAnnot ( void ) const

Definition at line 756 of file GBProjectHandle.cpp.

References IGBProject::GetAnnot(), and GetProject().

◆ GetData()

const CProjectFolder & CGBProjectHandle::GetData ( void ) 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

Definition at line 737 of file GBProjectHandle.cpp.

References IGBProject::GetData(), and GetProject().

Referenced by Convert_Container_Object(), Convert_GBProject_Object(), IsProjectItemLabelUnique(), and MakeUniqueItemLabel().

◆ GetDataLoaders() [1/2]

CGBProjectHandle::TDataLoaders & CGBProjectHandle::GetDataLoaders ( )

Definition at line 648 of file GBProjectHandle.cpp.

References m_Project.

◆ GetDataLoaders() [2/2]

const CGBProjectHandle::TDataLoaders & CGBProjectHandle::GetDataLoaders ( ) const

Definition at line 642 of file GBProjectHandle.cpp.

References m_Project.

◆ GetDataModified()

bool CGBProjectHandle::GetDataModified ( ) const

Definition at line 409 of file GBProjectHandle.cpp.

References CAtomicCounter::Get(), m_DataModified, m_Loaded, and m_Project.

◆ GetDescr()

const CProjectDescr & CGBProjectHandle::GetDescr ( void ) const

retrieve our project's descriptor set

Definition at line 430 of file GBProjectHandle.cpp.

References IGBProject::GetDescr(), and GetProject().

Referenced by CGBDocumentLabelHandler::GetLabel().

◆ GetId()

CGBProjectHandle::TId CGBProjectHandle::GetId ( void ) const

Definition at line 360 of file GBProjectHandle.cpp.

References m_Id.

Referenced by CProjectService::GetObjProjects().

◆ GetNextId()

CGBProjectHandle::TId CGBProjectHandle::GetNextId ( )

static

Retrieve the unique ID for our project.

Definition at line 366 of file GBProjectHandle.cpp.

References CAtomicCounter::Add(), Info(), LOG_POST, and sm_Counter.

◆ GetProject()

const IGBProject & CGBProjectHandle::GetProject ( void ) const

Definition at line 330 of file GBProjectHandle.cpp.

References _ASSERT, CRef< C, Locker >::GetObject(), and m_Project.

Referenced by CPluginReply::DecomposeRaw(), GetAnnot(), GetData(), GetDescr(), CGBDocumentLabelHandler::GetLabel(), GetVersion(), IsSetAnnot(), and Save().

◆ GetScope()

CScope * CGBProjectHandle::GetScope ( void ) const

virtual

Definition at line 354 of file GBProjectHandle.cpp.

References CRef< C, Locker >::GetPointer(), and m_Scope.

Referenced by CSequenceEditingEventHandler::CreateSeqSubmit(), CPluginReply::DecomposeRaw(), GetShortTitle(), GetTitle(), CBlastSearchTask::Init_RetrieveRID(), CSequenceEditingEventHandler::PrepareSeqSubmit(), CPluginValue::Print(), and CSubmissionWizard::x_LoadProjectItemData().

◆ GetShortTitle()

const string & CGBProjectHandle::GetShortTitle ( void ) const

Definition at line 455 of file GBProjectHandle.cpp.

References CLabel::eDefault, CLabel::GetLabel(), CRef< C, Locker >::GetPointer(), GetScope(), m_Project, and m_ShortTitle.

◆ GetTitle()

const string & CGBProjectHandle::GetTitle ( void ) const

Get a description of our contents.

This is suitable for display in a GUI component such as a list view.

Definition at line 444 of file GBProjectHandle.cpp.

References CLabel::eDefault, CLabel::GetLabel(), CRef< C, Locker >::GetPointer(), GetScope(), m_Project, and m_Title.

◆ GetVersion()

IGBProject::EProjectVersion CGBProjectHandle::GetVersion ( void ) const

retrieve this project's version this is fixed per subclass

Definition at line 630 of file GBProjectHandle.cpp.

References GetProject(), and IGBProject::GetVersion().

◆ GetViewSettings()

string CGBProjectHandle::GetViewSettings	(	const string &	view_type,
		const string &	view_ins_id
	)		const

Definition at line 682 of file GBProjectHandle.cpp.

References CUser_field_Base::GetData(), CUser_field::GetFieldRef(), ITERATE, and m_Project.

◆ IsDirty()

bool CGBProjectHandle::IsDirty ( ) const

Definition at line 384 of file GBProjectHandle.cpp.

References CAtomicCounter::Get(), m_DataModified, m_Dirty, m_Loaded, and m_Project.

◆ IsLoaded()

bool CGBProjectHandle::IsLoaded ( ) const

check to see if our project is loaded

Definition at line 374 of file GBProjectHandle.cpp.

References CAtomicCounter::Get(), and m_Loaded.

Referenced by CGBDocumentLabelHandler::GetLabel().

◆ IsProjectItemLabelUnique()

bool CGBProjectHandle::IsProjectItemLabelUnique ( const string & label ) const

Definition at line 572 of file GBProjectHandle.cpp.

References data, GetData(), and label.

◆ IsSetAnnot()

bool CGBProjectHandle::IsSetAnnot ( void ) const

retrieve a set of annotations for this project

Definition at line 750 of file GBProjectHandle.cpp.

References GetProject(), and IGBProject::IsSetAnnot().

◆ Load()

bool CGBProjectHandle::Load	(	CNcbiIstream &	istr,
		ICanceled *	canceledCallback
	)

force a project to be loaded from an external stream

Definition at line 464 of file GBProjectHandle.cpp.

References CRef< C, Locker >::GetPointer(), m_Project, NON_CONST_ITERATE, CRef< C, Locker >::Reset(), SetData(), SetDirty(), x_FixIdGenerator(), and x_LinkChildFolders().

Referenced by CGBDocument::LoadFile().

◆ MakeUniqueDataLoaderLabel()

string CGBProjectHandle::MakeUniqueDataLoaderLabel ( const string & label ) const

Create a unique label for a data loader.

Definition at line 614 of file GBProjectHandle.cpp.

References CUniqueLabelGenerator::AddExistingLabel(), ITERATE, label, m_Project, and CUniqueLabelGenerator::MakeUniqueLabel().

◆ MakeUniqueFolderLabel()

string CGBProjectHandle::MakeUniqueFolderLabel	(	const string &	label,
		objects::CProjectFolder &	parent_folder
	)		const

Create a label for a folder that will be unique in the scope of the parent folder.

Definition at line 600 of file GBProjectHandle.cpp.

References CUniqueLabelGenerator::AddExistingLabel(), CProjectFolder_Base::CanGetFolders(), CProjectFolder_Base::GetFolders(), ITERATE, label, and CUniqueLabelGenerator::MakeUniqueLabel().

◆ MakeUniqueItemLabel()

string CGBProjectHandle::MakeUniqueItemLabel ( const string & label ) const

Create a unique label for a project item.

Definition at line 585 of file GBProjectHandle.cpp.

References CUniqueLabelGenerator::AddExistingLabel(), data, GetData(), label, and CUniqueLabelGenerator::MakeUniqueLabel().

◆ operator=()

CGBProjectHandle& CGBProjectHandle::operator= ( const CGBProjectHandle & value )

private

◆ Save()

void CGBProjectHandle::Save	(	CNcbiOstream &	ostr,
		ESerialDataFormat	fmt
	)		const

Serialize to a stream in a given format.

Definition at line 531 of file GBProjectHandle.cpp.

References _ASSERT, eUnknown, IGBProject::eVersion1, IGBProject::eVersion2, GetProject(), IGBProject::GetVersion(), NCBI_THROW, CObjectOStream::Open(), and SetDirty().

Referenced by CGBDocument::x_SaveFile().

◆ SaveViewSettings()

void CGBProjectHandle::SaveViewSettings	(	const string &	view_type,
		const string &	view_ins_id,
		const string &	settings
	)

Definition at line 702 of file GBProjectHandle.cpp.

References m_Project, NON_CONST_ITERATE, CRef< C, Locker >::Reset(), CUser_field_Base::SetData(), CUser_object::SetField(), and CUser_object_Base::SetType().

◆ SetAnnot()

IGBProject::TAnnot & CGBProjectHandle::SetAnnot ( void )

Definition at line 762 of file GBProjectHandle.cpp.

References IGBProject::SetAnnot(), and SetProject().

◆ SetCreateDate()

void CGBProjectHandle::SetCreateDate ( const CDate & date )

SetCreateDate() will add a descriptor for creation date.

Definition at line 768 of file GBProjectHandle.cpp.

References IGBProject::SetCreateDate(), and SetProject().

◆ SetData()

CProjectFolder & CGBProjectHandle::SetData ( void )

Definition at line 743 of file GBProjectHandle.cpp.

References IGBProject::SetData(), and SetProject().

Referenced by CGBProjectHandle(), FindProjectFolderById(), FindProjectItemById(), and Load().

◆ SetDataModified()

void CGBProjectHandle::SetDataModified ( bool modified = true )

Definition at line 418 of file GBProjectHandle.cpp.

References CTime::eCurrent, m_DataModified, and m_Project.

◆ SetDescr()

CProjectDescr & CGBProjectHandle::SetDescr ( void )

Definition at line 436 of file GBProjectHandle.cpp.

References IGBProject::SetDescr(), and SetProject().

◆ SetDirty()

void CGBProjectHandle::SetDirty ( bool dirty = true )

Definition at line 393 of file GBProjectHandle.cpp.

References CTime::eCurrent, m_DataModified, m_Dirty, and m_Project.

Referenced by Load(), and Save().

◆ SetLoaded()

void CGBProjectHandle::SetLoaded ( bool loaded = true )

Definition at line 379 of file GBProjectHandle.cpp.

References m_Loaded, and CAtomicCounter::Set().

◆ SetModifiedDate()

void CGBProjectHandle::SetModifiedDate ( const CDate & date )

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

Definition at line 774 of file GBProjectHandle.cpp.

References IGBProject::SetModifiedDate(), and SetProject().

◆ SetProject()

IGBProject & CGBProjectHandle::SetProject ( void )

Definition at line 337 of file GBProjectHandle.cpp.

References _ASSERT, CRef< C, Locker >::GetObject(), and m_Project.

Referenced by SetAnnot(), SetCreateDate(), SetData(), SetDescr(), and SetModifiedDate().

◆ SetScope()

void CGBProjectHandle::SetScope ( CScope * scope )

virtual

establish a tie to the object manager via a scope

Definition at line 346 of file GBProjectHandle.cpp.

References _ASSERT, CRef< C, Locker >::GetPointer(), m_Project, m_Scope, NULL, and CRef< C, Locker >::Reset().

◆ x_FixIdGenerator()

void CGBProjectHandle::x_FixIdGenerator ( CGBProject_ver2 & project )

protected

Definition at line 801 of file GBProjectHandle.cpp.

References CGBProject_ver2_Base::GetCounter(), CGBProject_ver2::GetData(), CProjectItem_Base::GetId(), CGBProject_ver2_Base::IsSetCounter(), max(), and CGBProject_ver2_Base::SetCounter().

Referenced by Load().

◆ x_LinkChildFolders()

void CGBProjectHandle::x_LinkChildFolders ( CProjectFolder & folder )

protected

Definition at line 781 of file GBProjectHandle.cpp.

References CProjectFolder_Base::CanGetFolders(), CProjectFolder_Base::CanGetItems(), CProjectItem_Base::CanGetLabel(), NON_CONST_ITERATE, CProjectFolder_Base::SetFolders(), CProjectFolder_Base::SetItems(), and CLabel::SetLabelByData().

Referenced by CGBProjectHandle(), and Load().

Member Data Documentation

◆ m_DataModified

bool CGBProjectHandle::m_DataModified = false

protected

Definition at line 208 of file GBProjectHandle.hpp.

Referenced by GetDataModified(), IsDirty(), SetDataModified(), and SetDirty().

◆ m_Dirty

bool CGBProjectHandle::m_Dirty

protected

Dirty flag indicates whether the project has unsaved changes.

Definition at line 207 of file GBProjectHandle.hpp.

Referenced by IsDirty(), and SetDirty().

◆ m_Id

TId CGBProjectHandle::m_Id

protected

unique runtime identifier for this project

Definition at line 204 of file GBProjectHandle.hpp.

Referenced by GetId().

◆ m_Loaded

CAtomicCounter_WithAutoInit CGBProjectHandle::m_Loaded

protected

Definition at line 209 of file GBProjectHandle.hpp.

Referenced by Clear(), GetDataModified(), IsDirty(), IsLoaded(), and SetLoaded().

◆ m_Project

CIRef<IGBProject> CGBProjectHandle::m_Project

protected

the pointer to the actual project

Definition at line 201 of file GBProjectHandle.hpp.

Referenced by AddDataLoader(), AddItem(), CGBProjectHandle(), Clear(), FindDataLoaderByLabel(), GetDataLoaders(), GetDataModified(), GetProject(), GetShortTitle(), GetTitle(), GetViewSettings(), IsDirty(), Load(), MakeUniqueDataLoaderLabel(), SaveViewSettings(), SetDataModified(), SetDirty(), SetProject(), and SetScope().

◆ m_Scope

CRef<CScope> CGBProjectHandle::m_Scope

protected

Definition at line 211 of file GBProjectHandle.hpp.

Referenced by Clear(), GetScope(), and SetScope().

◆ m_ShortTitle

string CGBProjectHandle::m_ShortTitle

mutableprotected

Definition at line 215 of file GBProjectHandle.hpp.

Referenced by GetShortTitle().

◆ m_Title

string CGBProjectHandle::m_Title

mutableprotected

the Scope associated with the Project

titles for this project, one brief the other longer

Definition at line 214 of file GBProjectHandle.hpp.

Referenced by GetTitle().

◆ sm_Counter

CAtomicCounter CGBProjectHandle::sm_Counter

staticprotected

auto incremented ID counter

CGBProjectHandle.

Definition at line 198 of file GBProjectHandle.hpp.

Referenced by GetNextId().

◆ sm_NullId

CGBProjectHandle::TId CGBProjectHandle::sm_NullId = 0

static

Definition at line 78 of file GBProjectHandle.hpp.

Referenced by CProjectViewBase::x_DetachFromProject(), and CProjectViewBase::x_HasProject().

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

include/gui/objects/GBProjectHandle.hpp
src/gui/objects/GBProjectHandle.cpp

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

State Management and Inspection

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TAnnot

◆ TData

◆ TDataLoaders

◆ TId

◆ Tparent

Constructor & Destructor Documentation

◆ CGBProjectHandle() [1/3]

◆ CGBProjectHandle() [2/3]

◆ ~CGBProjectHandle()

◆ CGBProjectHandle() [3/3]

Member Function Documentation

◆ AddDataLoader()

◆ AddItem()

◆ Clear()

◆ FindDataLoaderByLabel()

◆ FindProjectFolderById()

◆ FindProjectItemById()

◆ GetAnnot()

◆ GetData()

◆ GetDataLoaders() [1/2]

◆ GetDataLoaders() [2/2]

◆ GetDataModified()

◆ GetDescr()

◆ GetId()

◆ GetNextId()

◆ GetProject()

◆ GetScope()

◆ GetShortTitle()

◆ GetTitle()

◆ GetVersion()

◆ GetViewSettings()

◆ IsDirty()

◆ IsLoaded()

◆ IsProjectItemLabelUnique()

◆ IsSetAnnot()

◆ Load()

◆ MakeUniqueDataLoaderLabel()

◆ MakeUniqueFolderLabel()

◆ MakeUniqueItemLabel()

◆ operator=()

◆ Save()

◆ SaveViewSettings()

◆ SetAnnot()

◆ SetCreateDate()

◆ SetData()

◆ SetDataModified()

◆ SetDescr()

◆ SetDirty()

◆ SetLoaded()

◆ SetModifiedDate()

◆ SetProject()

◆ SetScope()

◆ x_FixIdGenerator()

◆ x_LinkChildFolders()

Member Data Documentation

◆ m_DataModified

◆ m_Dirty

◆ m_Id

◆ m_Loaded

◆ m_Project

◆ m_Scope

◆ m_ShortTitle

◆ m_Title

◆ sm_Counter

◆ sm_NullId