Search Toolkit Book for CPluginMessage

#include <gui/objects/PluginMessage.hpp>

Inheritance diagram for CPluginMessage:

Collaboration diagram for CPluginMessage:

Public Types
enum	ELabelType { eType , eContent , eBoth , eDefault = eBoth }
	generate a usable label for this message More...

enum	EClearType { fClear_Request = 0x01 , fClear_Reply = 0x02 , fClear_Both = fClear_Request \| fClear_Reply , fClear_Default = fClear_Both }
	clear all objects from the message More...

typedef unsigned long	TId
	access a globally unique ID for this message More...

typedef int	TFlags

typedef int	TClearType

Public Types inherited from CPluginMessage_Base
enum class	E_memberIndex { e__allMandatory = 0 , e_source , e_destination , e_context , e_in_reply_to , e_request , e_reply }

typedef string	TSource

typedef string	TDestination

typedef string	TContext

typedef CPluginMessage	TIn_reply_to

typedef CPluginRequest	TRequest

typedef CPluginReply	TReply

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

	~CPluginMessage (void)

TId	GetId (void) const

void	GetLabel (string *str, ELabelType type=eDefault, TFlags flags=0) const

void	SetReporter (IReporter *reporter)

IReporter *	SetReporter ()

const IReporter *	GetReporter () const

void	ClearObjects (TClearType type=fClear_Default)

Public Member Functions inherited from CPluginMessage_Base
	CPluginMessage_Base (void)

virtual	~CPluginMessage_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

bool	IsSetSource (void) const
	routing information source plugin Check if a value has been assigned to Source data member. More...

bool	CanGetSource (void) const
	Check if it is safe to call GetSource method. More...

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

const TSource &	GetSource (void) const
	Get the Source member data. More...

void	SetSource (const TSource &value)
	Assign a value to Source data member. More...

void	SetSource (TSource &&value)

TSource &	SetSource (void)
	Assign a value to Source data member. More...

bool	IsSetDestination (void) const
	destination plugin Check if a value has been assigned to Destination data member. More...

bool	CanGetDestination (void) const
	Check if it is safe to call GetDestination method. More...

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

const TDestination &	GetDestination (void) const
	Get the Destination member data. More...

void	SetDestination (const TDestination &value)
	Assign a value to Destination data member. More...

void	SetDestination (TDestination &&value)

TDestination &	SetDestination (void)
	Assign a value to Destination data member. More...

bool	IsSetContext (void) const

bool	CanGetContext (void) const
	Check if it is safe to call GetContext method. More...

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

const TContext &	GetContext (void) const
	Get the Context member data. More...

void	SetContext (const TContext &value)
	Assign a value to Context data member. More...

void	SetContext (TContext &&value)

TContext &	SetContext (void)
	Assign a value to Context data member. More...

bool	IsSetIn_reply_to (void) const

bool	CanGetIn_reply_to (void) const
	Check if it is safe to call GetIn_reply_to method. More...

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

const TIn_reply_to &	GetIn_reply_to (void) const
	Get the In_reply_to member data. More...

void	SetIn_reply_to (TIn_reply_to &value)
	Assign a value to In_reply_to data member. More...

TIn_reply_to &	SetIn_reply_to (void)
	Assign a value to In_reply_to data member. More...

bool	IsSetRequest (void) const
	command to be passed to the plugin Check if a value has been assigned to Request data member. More...

bool	CanGetRequest (void) const
	Check if it is safe to call GetRequest method. More...

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

const TRequest &	GetRequest (void) const
	Get the Request member data. More...

void	SetRequest (TRequest &value)
	Assign a value to Request data member. More...

TRequest &	SetRequest (void)
	Assign a value to Request data member. More...

bool	IsSetReply (void) const
	reply received from a plugin Check if a value has been assigned to Reply data member. More...

bool	CanGetReply (void) const
	Check if it is safe to call GetReply method. More...

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

const TReply &	GetReply (void) const
	Get the Reply member data. More...

void	SetReply (TReply &value)
	Assign a value to Reply data member. More...

TReply &	SetReply (void)
	Assign a value to Reply 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 CPluginMessage_Base	Tparent

Private Member Functions
	CPluginMessage (const CPluginMessage &value)

CPluginMessage &	operator= (const CPluginMessage &value)

Private Attributes
TId	m_Id

IReporter *	m_Reporter

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

Definition at line 52 of file PluginMessage.hpp.

Member Typedef Documentation

◆ TClearType

typedef int CPluginMessage::TClearType

Definition at line 88 of file PluginMessage.hpp.

◆ TFlags

typedef int CPluginMessage::TFlags

Definition at line 73 of file PluginMessage.hpp.

◆ TId

typedef unsigned long CPluginMessage::TId

access a globally unique ID for this message

Definition at line 62 of file PluginMessage.hpp.

◆ Tparent

typedef CPluginMessage_Base CPluginMessage::Tparent

private

Definition at line 54 of file PluginMessage.hpp.

Member Enumeration Documentation

◆ EClearType

enum CPluginMessage::EClearType

clear all objects from the message

Enumerator
fClear_Request
fClear_Reply
fClear_Both
fClear_Default

Definition at line 81 of file PluginMessage.hpp.

◆ ELabelType

enum CPluginMessage::ELabelType

generate a usable label for this message

Enumerator
eType
eContent
eBoth
eDefault

Definition at line 66 of file PluginMessage.hpp.

Constructor & Destructor Documentation

◆ CPluginMessage() [1/2]

CPluginMessage::CPluginMessage ( void )

Definition at line 60 of file PluginMessage.cpp.

◆ ~CPluginMessage()

CPluginMessage::~CPluginMessage ( void )

Definition at line 68 of file PluginMessage.cpp.

◆ CPluginMessage() [2/2]

CPluginMessage::CPluginMessage ( const CPluginMessage & value )

private

Member Function Documentation

◆ ClearObjects()

void CPluginMessage::ClearObjects ( TClearType type = fClear_Default )

Definition at line 73 of file PluginMessage.cpp.

References CPluginCommand::ClearObjects(), fClear_Reply, fClear_Request, CPluginRequest::SetCommand(), CPluginReply_Base::SetFormatted(), CPluginReply_Base::SetRaw(), CPluginMessage_Base::SetReply(), and CPluginMessage_Base::SetRequest().

◆ GetId()

CPluginMessage::TId CPluginMessage::GetId ( void ) const

inline

Definition at line 107 of file PluginMessage.hpp.

References m_Id.

◆ GetLabel()

void CPluginMessage::GetLabel	(	string *	str,
		ELabelType	type = `eDefault`,
		TFlags	flags = `0`
	)		const

Definition at line 141 of file PluginMessage.cpp.

References eBoth, eContent, eType, s_GetContentString(), s_GetTypeString(), and str().

◆ GetReporter()

const IReporter * CPluginMessage::GetReporter ( void ) const

Definition at line 96 of file PluginMessage.cpp.

References m_Reporter.

◆ operator=()

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

private

◆ SetReporter() [1/2]

IReporter * CPluginMessage::SetReporter ( )

Definition at line 90 of file PluginMessage.cpp.

References m_Reporter.

◆ SetReporter() [2/2]

void CPluginMessage::SetReporter ( IReporter * reporter )

Definition at line 84 of file PluginMessage.cpp.

References m_Reporter.

Member Data Documentation

◆ m_Id

TId CPluginMessage::m_Id

private

Definition at line 98 of file PluginMessage.hpp.

Referenced by GetId().

◆ m_Reporter

IReporter* CPluginMessage::m_Reporter

private

Definition at line 100 of file PluginMessage.hpp.

Referenced by GetReporter(), and SetReporter().

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

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

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TClearType

◆ TFlags

◆ TId

◆ Tparent

Member Enumeration Documentation

◆ EClearType

◆ ELabelType

Constructor & Destructor Documentation

◆ CPluginMessage() [1/2]

◆ ~CPluginMessage()

◆ CPluginMessage() [2/2]

Member Function Documentation

◆ ClearObjects()

◆ GetId()

◆ GetLabel()

◆ GetReporter()

◆ operator=()

◆ SetReporter() [1/2]

◆ SetReporter() [2/2]

Member Data Documentation

◆ m_Id

◆ m_Reporter