Search Toolkit Book for CPluginInfoSet

@PluginInfoSet.hpp User-defined methods of the data storage class. More...

#include <gui/objects/PluginInfoSet.hpp>

Inheritance diagram for CPluginInfoSet:

Collaboration diagram for CPluginInfoSet:

Public Member Functions
	CPluginInfoSet (void)

	~CPluginInfoSet (void)

CPluginInfo &	CreateInfo (int major, int minor, int rev, const string &build_date, const string &class_name, const string &menu_item, const string &tooltip, const string &help_file)

CPluginInfo &	CreateInfo (int major, int minor, int rev, const string &build_date, const string &class_name, const string &menu_item, const string &tooltip, const string &help_file, const string &icon_alias, const string &icon_local_path)
	for view plugins only More...

int	GetVer_major () const

int	GetVer_minor () const

int	GetVer_revision () const

string	GetVer_build_date () const

string	GetClass_name () const

Public Member Functions inherited from CPluginInfoSet_Base
	CPluginInfoSet_Base (void)

virtual	~CPluginInfoSet_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

bool	IsSet (void) const
	Check if a value has been assigned to data member. More...

bool	CanGet (void) const
	Check if it is safe to call Get method. More...

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

const Tdata &	Get (void) const
	Get the member data. More...

Tdata &	Set (void)
	Assign a value to data member. More...

	operator const Tdata & (void) const
	Conversion operator to 'const Tdata' type. More...

	operator Tdata & (void)
	Conversion operator to 'Tdata' type. 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 CPluginInfoSet_Base	Tparent

Private Member Functions
	CPluginInfoSet (const CPluginInfoSet &value)

CPluginInfoSet &	operator= (const CPluginInfoSet &value)

Additional Inherited Members
Public Types inherited from CPluginInfoSet_Base
typedef list< CRef< CPluginInfo > >	Tdata

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

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

@PluginInfoSet.hpp User-defined methods of the data storage class.

This file was originally generated by application DATATOOL using the following specifications: 'plugin.asn'.

New methods or data members can be added to it if needed. See also: PluginInfoSet_.hpp

Definition at line 54 of file PluginInfoSet.hpp.

Member Typedef Documentation

◆ Tparent

typedef CPluginInfoSet_Base CPluginInfoSet::Tparent

private

Definition at line 56 of file PluginInfoSet.hpp.

Constructor & Destructor Documentation

◆ CPluginInfoSet() [1/2]

CPluginInfoSet::CPluginInfoSet ( void )

inline

Definition at line 98 of file PluginInfoSet.hpp.

◆ ~CPluginInfoSet()

CPluginInfoSet::~CPluginInfoSet ( void )

Definition at line 51 of file PluginInfoSet.cpp.

◆ CPluginInfoSet() [2/2]

CPluginInfoSet::CPluginInfoSet ( const CPluginInfoSet & value )

private

Member Function Documentation

◆ CreateInfo() [1/2]

CPluginInfo & CPluginInfoSet::CreateInfo	(	int	major,
		int	minor,
		int	rev,
		const string &	build_date,
		const string &	class_name,
		const string &	menu_item,
		const string &	tooltip,
		const string &	help_file
	)

Definition at line 56 of file PluginInfoSet.cpp.

References info, and CPluginInfoSet_Base::Set().

◆ CreateInfo() [2/2]

CPluginInfo & CPluginInfoSet::CreateInfo	(	int	major,
		int	minor,
		int	rev,
		const string &	build_date,
		const string &	class_name,
		const string &	menu_item,
		const string &	tooltip,
		const string &	help_file,
		const string &	icon_alias,
		const string &	icon_local_path
	)

for view plugins only

Definition at line 72 of file PluginInfoSet.cpp.

References info, and CPluginInfoSet_Base::Set().

◆ GetClass_name()

string CPluginInfoSet::GetClass_name ( void ) const

Definition at line 160 of file PluginInfoSet.cpp.

References CPluginInfoSet_Base::Get(), CPluginInfoSet_Base::IsSet(), and kEmptyStr.

◆ GetVer_build_date()

string CPluginInfoSet::GetVer_build_date ( void ) const

Definition at line 143 of file PluginInfoSet.cpp.

References CPluginInfoSet_Base::Get(), CPluginInfoSet_Base::IsSet(), and kEmptyStr.

◆ GetVer_major()

int CPluginInfoSet::GetVer_major ( void ) const

Definition at line 90 of file PluginInfoSet.cpp.

References CPluginVersion::eVersion_undefined, CPluginInfoSet_Base::Get(), and CPluginInfoSet_Base::IsSet().

◆ GetVer_minor()

int CPluginInfoSet::GetVer_minor ( void ) const

Definition at line 108 of file PluginInfoSet.cpp.

References CPluginVersion::eVersion_undefined, CPluginInfoSet_Base::Get(), and CPluginInfoSet_Base::IsSet().

◆ GetVer_revision()

int CPluginInfoSet::GetVer_revision ( void ) const

Definition at line 125 of file PluginInfoSet.cpp.

References CPluginVersion::eVersion_undefined, CPluginInfoSet_Base::Get(), and CPluginInfoSet_Base::IsSet().

◆ operator=()

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

private

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

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

Public Member Functions

Private Types

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Tparent

Constructor & Destructor Documentation

◆ CPluginInfoSet() [1/2]

◆ ~CPluginInfoSet()

◆ CPluginInfoSet() [2/2]

Member Function Documentation

◆ CreateInfo() [1/2]

◆ CreateInfo() [2/2]

◆ GetClass_name()

◆ GetVer_build_date()

◆ GetVer_major()

◆ GetVer_minor()

◆ GetVer_revision()

◆ operator=()