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

#include <gui/objects/GBWorkspace.hpp>

Inheritance diagram for CGBWorkspace:

Collaboration diagram for CGBWorkspace:

Public Types
typedef CAtomicCounter::TValue	TId

typedef vector< CRef< CGBProjectHandle > >	TProjectVector

Public Types inherited from CGBWorkspace_Base
enum class	E_memberIndex { e__allMandatory = 0 , e_descr , e_workspace , e_layout , e_annot }

typedef CProjectDescr	TDescr

typedef CWorkspaceFolder	TWorkspace

typedef list< CRef< CViewDesc > >	TLayout

typedef list< CRef< CProjectAnnot > >	TAnnot

typedef Tparent::CMemberIndex< E_memberIndex, 5 >	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
	CGBWorkspace (void)

	~CGBWorkspace (void)

TId	GetId ()

CGBProjectHandle *	GetProjectFromScope (const CScope &scope)

CGBProjectHandle *	GetProjectFromId (CGBProjectHandle::TId id)

bool	RemoveProject (CGBProjectHandle::TId id)

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

vector< CGBProjectHandle::TId >	GetUnloadedProjects () const

vector< CGBProjectHandle::TId >	GetLoadedProjects () const

void	SetFilename (const string &filename)
	sets new filename for the Workspace updates path to projects so that they will be correct relative paths More...

string	GetFilename () const

Public Member Functions inherited from CGBWorkspace_Base
	CGBWorkspace_Base (void)

virtual	~CGBWorkspace_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

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	IsSetWorkspace (void) const
	projects in this workspace Check if a value has been assigned to Workspace data member. More...

bool	CanGetWorkspace (void) const
	Check if it is safe to call GetWorkspace method. More...

void	ResetWorkspace (void)
	Reset Workspace data member. More...

const TWorkspace &	GetWorkspace (void) const
	Get the Workspace member data. More...

void	SetWorkspace (TWorkspace &value)
	Assign a value to Workspace data member. More...

TWorkspace &	SetWorkspace (void)
	Assign a value to Workspace data member. More...

bool	IsSetLayout (void) const
	GUI layout items Check if a value has been assigned to Layout data member. More...

bool	CanGetLayout (void) const
	Check if it is safe to call GetLayout method. More...

void	ResetLayout (void)
	Reset Layout data member. More...

const TLayout &	GetLayout (void) const
	Get the Layout member data. More...

TLayout &	SetLayout (void)
	Assign a value to Layout 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...

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
TId	m_Id
	instance run-time Id, unique within an application session More...

string	m_Filename
	filename assigned to the workspace More...

Static Protected Attributes
static CAtomicCounter	m_IdCounter
	CGBWorkspace. More...

Private Types
typedef CGBWorkspace_Base	Tparent

Private Member Functions
	CGBWorkspace (const CGBWorkspace &value)

CGBWorkspace &	operator= (const CGBWorkspace &value)

Friends
class	ncbi::CProjectService

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

CGBWorkspace.

Definition at line 62 of file GBWorkspace.hpp.

Member Typedef Documentation

◆ TId

typedef CAtomicCounter::TValue CGBWorkspace::TId

Definition at line 67 of file GBWorkspace.hpp.

◆ Tparent

typedef CGBWorkspace_Base CGBWorkspace::Tparent

private

Definition at line 64 of file GBWorkspace.hpp.

◆ TProjectVector

typedef vector< CRef<CGBProjectHandle> > CGBWorkspace::TProjectVector

Definition at line 68 of file GBWorkspace.hpp.

Constructor & Destructor Documentation

◆ CGBWorkspace() [1/2]

CGBWorkspace::CGBWorkspace ( void )

Definition at line 85 of file GBWorkspace.cpp.

References CAtomicCounter::Add(), CLabel::HasHandler(), m_Id, m_IdCounter, and CLabel::RegisterLabelHandler().

◆ ~CGBWorkspace()

CGBWorkspace::~CGBWorkspace ( void )

Definition at line 97 of file GBWorkspace.cpp.

◆ CGBWorkspace() [2/2]

CGBWorkspace::CGBWorkspace ( const CGBWorkspace & value )

private

Member Function Documentation

◆ GetFilename()

string CGBWorkspace::GetFilename ( void ) const

inline

Definition at line 91 of file GBWorkspace.hpp.

References m_Filename.

◆ GetId()

TId CGBWorkspace::GetId ( void )

inline

Definition at line 74 of file GBWorkspace.hpp.

References m_Id.

Referenced by s_CreateNewProject().

◆ GetLoadedProjects()

vector< CGBProjectHandle::TId > CGBWorkspace::GetLoadedProjects ( ) const

Definition at line 158 of file GBWorkspace.cpp.

References CGBWorkspace_Base::GetWorkspace().

◆ GetProjectFromId()

CGBProjectHandle * CGBWorkspace::GetProjectFromId ( CGBProjectHandle::TId id )

Definition at line 113 of file GBWorkspace.cpp.

References CGBWorkspace_Base::SetWorkspace().

Referenced by s_GetUnsavedProjects(), and CProjectTask::x_DoSaveUserSelected().

◆ GetProjectFromScope()

CGBProjectHandle * CGBWorkspace::GetProjectFromScope ( const CScope & scope )

Definition at line 102 of file GBWorkspace.cpp.

References CGBWorkspace_Base::SetWorkspace().

◆ GetUnloadedProjects()

vector< CGBProjectHandle::TId > CGBWorkspace::GetUnloadedProjects ( ) const

Definition at line 147 of file GBWorkspace.cpp.

References CGBWorkspace_Base::GetWorkspace().

◆ MakeUniqueProjectTitle()

string CGBWorkspace::MakeUniqueProjectTitle ( const string & label ) const

Create a unique label for a project.

Definition at line 135 of file GBWorkspace.cpp.

References CUniqueLabelGenerator::AddExistingLabel(), CGBWorkspace_Base::GetWorkspace(), label, and CUniqueLabelGenerator::MakeUniqueLabel().

Referenced by s_CreateNewProject().

◆ operator=()

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

private

◆ RemoveProject()

bool CGBWorkspace::RemoveProject ( CGBProjectHandle::TId id )

Definition at line 124 of file GBWorkspace.cpp.

References CWorkspaceFolder::FindParentFolder(), CWorkspaceFolder::RemoveProject(), and CGBWorkspace_Base::SetWorkspace().

◆ SetFilename()

void CGBWorkspace::SetFilename ( const string & filename )

inline

sets new filename for the Workspace updates path to projects so that they will be correct relative paths

Definition at line 90 of file GBWorkspace.hpp.

References m_Filename.

Friends And Related Function Documentation

◆ ncbi::CProjectService

friend class ncbi::CProjectService

friend

Definition at line 65 of file GBWorkspace.hpp.

Member Data Documentation

◆ m_Filename

string CGBWorkspace::m_Filename

protected

filename assigned to the workspace

Definition at line 105 of file GBWorkspace.hpp.

Referenced by GetFilename(), and SetFilename().

◆ m_Id

TId CGBWorkspace::m_Id

protected

instance run-time Id, unique within an application session

Definition at line 102 of file GBWorkspace.hpp.

Referenced by CGBWorkspace(), and GetId().

◆ m_IdCounter

CAtomicCounter CGBWorkspace::m_IdCounter

staticprotected

CGBWorkspace.

Definition at line 99 of file GBWorkspace.hpp.

Referenced by CGBWorkspace().

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

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

Public Types

Public Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TId

◆ Tparent

◆ TProjectVector

Constructor & Destructor Documentation

◆ CGBWorkspace() [1/2]

◆ ~CGBWorkspace()

◆ CGBWorkspace() [2/2]

Member Function Documentation

◆ GetFilename()

◆ GetId()

◆ GetLoadedProjects()

◆ GetProjectFromId()

◆ GetProjectFromScope()

◆ GetUnloadedProjects()

◆ MakeUniqueProjectTitle()

◆ operator=()

◆ RemoveProject()

◆ SetFilename()

Friends And Related Function Documentation

◆ ncbi::CProjectService

Member Data Documentation

◆ m_Filename

◆ m_Id

◆ m_IdCounter