Search Toolkit Book for CPluginReply
#include <gui/objects/PluginReply.hpp>
Inheritance diagram for CPluginReply:
Collaboration diagram for CPluginReply:
Public Member Functions | |
| CPluginReply (void) | |
| constructor More... | |
| ~CPluginReply (void) | |
| destructor More... | |
| void | AddAction (CPluginReplyAction::E_Choice choice, const string &opts="") |
| add an action to be undertaken when processing this reply More... | |
| void | AddObject (const CObject &object, const CGBProjectHandle *project=NULL) |
| add an object to this reply's raw object list More... | |
| void | AddObject (const CGBProjectHandle &project) |
| add a document to the reply's raw object list. More... | |
| TConstScopedObjects | DecomposeRaw () const |
| Create a set of object-scope pairs for the raw reply. More... | |
| Public Member Functions inherited from CPluginReply_Base | |
| CPluginReply_Base (void) | |
| virtual | ~CPluginReply_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSetStatus (void) const |
| Check if a value has been assigned to Status data member. More... | |
| bool | CanGetStatus (void) const |
| Check if it is safe to call GetStatus method. More... | |
| void | ResetStatus (void) |
| Reset Status data member. More... | |
| void | SetDefaultStatus (void) |
| Assign default value to Status data member. More... | |
| TStatus | GetStatus (void) const |
| Get the Status member data. More... | |
| void | SetStatus (TStatus value) |
| Assign a value to Status data member. More... | |
| TStatus & | SetStatus (void) |
| Assign a value to Status data member. More... | |
| bool | IsSetAction (void) const |
| Check if a value has been assigned to Action data member. More... | |
| bool | CanGetAction (void) const |
| Check if it is safe to call GetAction method. More... | |
| void | ResetAction (void) |
| Reset Action data member. More... | |
| const TAction & | GetAction (void) const |
| Get the Action member data. More... | |
| TAction & | SetAction (void) |
| Assign a value to Action data member. More... | |
| bool | IsSetRaw (void) const |
| things we've produced Check if a value has been assigned to Raw data member. More... | |
| bool | CanGetRaw (void) const |
| Check if it is safe to call GetRaw method. More... | |
| void | ResetRaw (void) |
| Reset Raw data member. More... | |
| const TRaw & | GetRaw (void) const |
| Get the Raw member data. More... | |
| TRaw & | SetRaw (void) |
| Assign a value to Raw data member. More... | |
| bool | IsSetFormatted (void) const |
| caller-defined args Check if a value has been assigned to Formatted data member. More... | |
| bool | CanGetFormatted (void) const |
| Check if it is safe to call GetFormatted method. More... | |
| void | ResetFormatted (void) |
| Reset Formatted data member. More... | |
| const TFormatted & | GetFormatted (void) const |
| Get the Formatted member data. More... | |
| void | SetFormatted (TFormatted &value) |
| Assign a value to Formatted data member. More... | |
| TFormatted & | SetFormatted (void) |
| Assign a value to Formatted 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 CPluginReply_Base | Tparent |
Private Member Functions | |
| CPluginReply (const CPluginReply &value) | |
| Prohibit copy constructor and assignment operator. More... | |
| CPluginReply & | operator= (const CPluginReply &value) |
Additional Inherited Members | |
| Public Types inherited from CPluginReply_Base | |
| enum class | E_memberIndex { e__allMandatory = 0 , e_status , e_action , e_raw , e_formatted } |
| typedef EMessageStatus | TStatus |
| typedef list< CRef< CPluginReplyAction > > | TAction |
| typedef list< CRef< CPluginValue > > | TRaw |
| typedef CPluginArgSet | TFormatted |
| 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... | |
| 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 55 of file PluginReply.hpp.
Member Typedef Documentation
◆ Tparent
|
private |
Definition at line 57 of file PluginReply.hpp.
Constructor & Destructor Documentation
◆ CPluginReply() [1/2]
|
inline |
constructor
Definition at line 90 of file PluginReply.hpp.
◆ ~CPluginReply()
| CPluginReply::~CPluginReply | ( | void | ) |
destructor
Definition at line 50 of file PluginReply.cpp.
◆ CPluginReply() [2/2]
|
private |
Prohibit copy constructor and assignment operator.
Member Function Documentation
◆ AddAction()
| void CPluginReply::AddAction | ( | CPluginReplyAction::E_Choice | choice, |
| const string & | opts = "" |
||
| ) |
add an action to be undertaken when processing this reply
Definition at line 71 of file PluginReply.cpp.
References _ASSERT, CPluginReplyAction_Base::e_Add_to_project, CPluginReplyAction_Base::e_Create_project, CPluginReplyAction_Base::e_Create_single_project, CPluginReplyAction_Base::e_Error, CPluginReplyAction_Base::e_Info, CPluginReplyAction_Base::e_New_view, CPluginReplyAction_Base::e_Plugin_cmd_run, CPluginReplyAction_Base::e_Refresh_project, CPluginReplyAction_Base::e_Store, CPluginReplyAction_Base::e_Warning, and CPluginReply_Base::SetAction().
◆ AddObject() [1/2]
| void CPluginReply::AddObject | ( | const CGBProjectHandle & | project | ) |
add a document to the reply's raw object list.
Definition at line 64 of file PluginReply.cpp.
References CPluginReply_Base::SetRaw(), and val.
◆ AddObject() [2/2]
| void CPluginReply::AddObject | ( | const CObject & | object, |
| const CGBProjectHandle * | project = NULL |
||
| ) |
add an object to this reply's raw object list
Definition at line 56 of file PluginReply.cpp.
References CPluginReply_Base::SetRaw(), and val.
◆ DecomposeRaw()
| TConstScopedObjects CPluginReply::DecomposeRaw | ( | ) | const |
Create a set of object-scope pairs for the raw reply.
Definition at line 135 of file PluginReply.cpp.
References CGBProjectHandle::GetProject(), CPluginReply_Base::GetRaw(), CGBProjectHandle::GetScope(), CPluginReply_Base::IsSetRaw(), ITERATE, SConstScopedObject::object, CRef< C, Locker >::Reset(), CConstRef< C, Locker >::Reset(), and SConstScopedObject::scope.
◆ operator=()
|
private |
The documentation for this class was generated from the following files:
- include/gui/objects/PluginReply.hpp
- src/gui/objects/PluginReply.cpp
