NCBI C++ ToolKit
Public Member Functions | Private Types | Private Member Functions | List of all members
CPluginReplyAction Class Reference

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

Search Toolkit Book for CPluginReplyAction

#include <gui/objects/PluginReplyAction.hpp>

+ Inheritance diagram for CPluginReplyAction:
+ Collaboration diagram for CPluginReplyAction:

Public Member Functions

 CPluginReplyAction (void)
 
 ~CPluginReplyAction (void)
 
- Public Member Functions inherited from CPluginReplyAction_Base
 CPluginReplyAction_Base (void)
 
virtual ~CPluginReplyAction_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
virtual void Reset (void)
 Reset the whole object. More...
 
virtual void ResetSelection (void)
 Reset the selection (set it to e_not_set). More...
 
E_Choice Which (void) const
 Which variant is currently selected. More...
 
void CheckSelected (E_Choice index) const
 Verify selection, throw exception if it differs from the expected. More...
 
void ThrowInvalidSelection (E_Choice index) const
 Throw 'InvalidSelection' exception. More...
 
void Select (E_Choice index, EResetVariant reset=eDoResetVariant)
 Select the requested variant if needed. More...
 
void Select (E_Choice index, EResetVariant reset, CObjectMemoryPool *pool)
 Select the requested variant if needed, allocating CObject variants from memory pool. More...
 
bool IsAdd_to_project (void) const
 Check if variant Add_to_project is selected. More...
 
void SetAdd_to_project (void)
 Select the variant. More...
 
bool IsNew_view (void) const
 Check if variant New_view is selected. More...
 
const TNew_viewGetNew_view (void) const
 Get the variant data. More...
 
TNew_viewSetNew_view (void)
 Select the variant. More...
 
void SetNew_view (const TNew_view &value)
 Select the variant and set its data. More...
 
bool IsNew_composite_view (void) const
 Check if variant New_composite_view is selected. More...
 
const TNew_composite_viewGetNew_composite_view (void) const
 Get the variant data. More...
 
TNew_composite_viewSetNew_composite_view (void)
 Select the variant. More...
 
void SetNew_composite_view (const TNew_composite_view &value)
 Select the variant and set its data. More...
 
bool IsStore (void) const
 Check if variant Store is selected. More...
 
const TStoreGetStore (void) const
 Get the variant data. More...
 
TStoreSetStore (void)
 Select the variant. More...
 
void SetStore (const TStore &value)
 Select the variant and set its data. More...
 
bool IsCreate_project (void) const
 Check if variant Create_project is selected. More...
 
const TCreate_projectGetCreate_project (void) const
 Get the variant data. More...
 
TCreate_projectSetCreate_project (void)
 Select the variant. More...
 
void SetCreate_project (const TCreate_project &value)
 Select the variant and set its data. More...
 
bool IsCreate_single_project (void) const
 Check if variant Create_single_project is selected. More...
 
const TCreate_single_projectGetCreate_single_project (void) const
 Get the variant data. More...
 
TCreate_single_projectSetCreate_single_project (void)
 Select the variant. More...
 
void SetCreate_single_project (const TCreate_single_project &value)
 Select the variant and set its data. More...
 
bool IsAttach_project (void) const
 Check if variant Attach_project is selected. More...
 
const TAttach_projectGetAttach_project (void) const
 Get the variant data. More...
 
TAttach_projectSetAttach_project (void)
 Select the variant. More...
 
void SetAttach_project (TAttach_project &value)
 Select the variant and set its data. More...
 
bool IsRefresh_project (void) const
 Check if variant Refresh_project is selected. More...
 
const TRefresh_projectGetRefresh_project (void) const
 Get the variant data. More...
 
TRefresh_projectSetRefresh_project (void)
 Select the variant. More...
 
void SetRefresh_project (TRefresh_project &value)
 Select the variant and set its data. More...
 
bool IsAdd_to_MRU (void) const
 Check if variant Add_to_MRU is selected. More...
 
const TAdd_to_MRUGetAdd_to_MRU (void) const
 Get the variant data. More...
 
TAdd_to_MRUSetAdd_to_MRU (void)
 Select the variant. More...
 
void SetAdd_to_MRU (TAdd_to_MRU &value)
 Select the variant and set its data. More...
 
bool IsError (void) const
 Check if variant Error is selected. More...
 
const TErrorGetError (void) const
 Get the variant data. More...
 
TErrorSetError (void)
 Select the variant. More...
 
void SetError (const TError &value)
 Select the variant and set its data. More...
 
bool IsPlugin_cmd_run (void) const
 Check if variant Plugin_cmd_run is selected. More...
 
const TPlugin_cmd_runGetPlugin_cmd_run (void) const
 Get the variant data. More...
 
TPlugin_cmd_runSetPlugin_cmd_run (void)
 Select the variant. More...
 
void SetPlugin_cmd_run (const TPlugin_cmd_run &value)
 Select the variant and set its data. More...
 
bool IsRegister_interface (void) const
 Check if variant Register_interface is selected. More...
 
void SetRegister_interface (void)
 Select the variant. More...
 
bool IsWarning (void) const
 Check if variant Warning is selected. More...
 
const TWarningGetWarning (void) const
 Get the variant data. More...
 
TWarningSetWarning (void)
 Select the variant. More...
 
void SetWarning (const TWarning &value)
 Select the variant and set its data. More...
 
bool IsInfo (void) const
 Check if variant Info is selected. More...
 
const TInfoGetInfo (void) const
 Get the variant data. More...
 
TInfoSetInfo (void)
 Select the variant. More...
 
void SetInfo (const TInfo &value)
 Select the variant and set its data. More...
 
- Public Member Functions inherited from CSerialObject
 CSerialObject (void)
 
virtual ~CSerialObject (void)
 
virtual const CTypeInfoGetThisTypeInfo (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 stringGetNamespaceName (void) const
 Get namespace name. More...
 
bool HasNamespacePrefix (void) const
 Check if data type has namespace prefix. More...
 
const stringGetNamespacePrefix (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...
 
CObjectoperator= (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 CPluginReplyAction_Base Tparent
 

Private Member Functions

 CPluginReplyAction (const CPluginReplyAction &value)
 
CPluginReplyActionoperator= (const CPluginReplyAction &value)
 

Additional Inherited Members

- Public Types inherited from CPluginReplyAction_Base
enum  E_Choice {
  e_not_set = 0 , e_Add_to_project , e_New_view , e_New_composite_view ,
  e_Store , e_Create_project , e_Create_single_project , e_Attach_project ,
  e_Refresh_project , e_Add_to_MRU , e_Error , e_Plugin_cmd_run ,
  e_Register_interface , e_Warning , e_Info
}
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 15 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef string TNew_view
 
typedef string TNew_composite_view
 
typedef string TStore
 
typedef string TCreate_project
 
typedef string TCreate_single_project
 
typedef CGBProjectHandle TAttach_project
 
typedef CGBProjectHandle TRefresh_project
 
typedef CPluginMRUEntry TAdd_to_MRU
 
typedef string TError
 
typedef string TPlugin_cmd_run
 
typedef string TWarning
 
typedef string TInfo
 
- 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< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 
- Static Public Member Functions inherited from CPluginReplyAction_Base
static string SelectionName (E_Choice index)
 Retrieve selection name (for diagnostic purposes). 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 53 of file PluginReplyAction.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 55 of file PluginReplyAction.hpp.

Constructor & Destructor Documentation

◆ CPluginReplyAction() [1/2]

CPluginReplyAction::CPluginReplyAction ( void  )
inline

Definition at line 73 of file PluginReplyAction.hpp.

◆ ~CPluginReplyAction()

CPluginReplyAction::~CPluginReplyAction ( void  )

Definition at line 50 of file PluginReplyAction.cpp.

◆ CPluginReplyAction() [2/2]

CPluginReplyAction::CPluginReplyAction ( const CPluginReplyAction value)
private

Member Function Documentation

◆ operator=()

CPluginReplyAction& CPluginReplyAction::operator= ( const CPluginReplyAction value)
private

The documentation for this class was generated from the following files:
Modified on Wed Apr 17 13:09:58 2024 by modify_doxy.py rev. 669887