NCBI C++ ToolKit
|
Search Toolkit Book for CAction_choice_Base
CAction_choice_Base –. More...
#include <objects/macro/Action_choice_.hpp>
Public Types | |
enum | E_Choice { e_not_set = 0 , e_Apply , e_Edit , e_Convert , e_Copy , e_Swap , e_Remove , e_Parse , e_Remove_outside } |
Choice variants. More... | |
enum | E_ChoiceStopper { e_MaxChoice = 9 } |
Maximum+1 value of the choice variant enumerator. More... | |
typedef CApply_action | TApply |
typedef CEdit_action | TEdit |
typedef CConvert_action | TConvert |
typedef CCopy_action | TCopy |
typedef CSwap_action | TSwap |
typedef CRemove_action | TRemove |
typedef CAECRParse_action | TParse |
typedef CRemove_outside_action | TRemove_outside |
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 | |
CAction_choice_Base (void) | |
virtual | ~CAction_choice_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 | IsApply (void) const |
Check if variant Apply is selected. More... | |
const TApply & | GetApply (void) const |
Get the variant data. More... | |
TApply & | SetApply (void) |
Select the variant. More... | |
void | SetApply (TApply &value) |
Select the variant and set its data. More... | |
bool | IsEdit (void) const |
Check if variant Edit is selected. More... | |
const TEdit & | GetEdit (void) const |
Get the variant data. More... | |
TEdit & | SetEdit (void) |
Select the variant. More... | |
void | SetEdit (TEdit &value) |
Select the variant and set its data. More... | |
bool | IsConvert (void) const |
Check if variant Convert is selected. More... | |
const TConvert & | GetConvert (void) const |
Get the variant data. More... | |
TConvert & | SetConvert (void) |
Select the variant. More... | |
void | SetConvert (TConvert &value) |
Select the variant and set its data. More... | |
bool | IsCopy (void) const |
Check if variant Copy is selected. More... | |
const TCopy & | GetCopy (void) const |
Get the variant data. More... | |
TCopy & | SetCopy (void) |
Select the variant. More... | |
void | SetCopy (TCopy &value) |
Select the variant and set its data. More... | |
bool | IsSwap (void) const |
Check if variant Swap is selected. More... | |
const TSwap & | GetSwap (void) const |
Get the variant data. More... | |
TSwap & | SetSwap (void) |
Select the variant. More... | |
void | SetSwap (TSwap &value) |
Select the variant and set its data. More... | |
bool | IsRemove (void) const |
Check if variant Remove is selected. More... | |
const TRemove & | GetRemove (void) const |
Get the variant data. More... | |
TRemove & | SetRemove (void) |
Select the variant. More... | |
void | SetRemove (TRemove &value) |
Select the variant and set its data. More... | |
bool | IsParse (void) const |
Check if variant Parse is selected. More... | |
const TParse & | GetParse (void) const |
Get the variant data. More... | |
TParse & | SetParse (void) |
Select the variant. More... | |
void | SetParse (TParse &value) |
Select the variant and set its data. More... | |
bool | IsRemove_outside (void) const |
Check if variant Remove_outside is selected. More... | |
const TRemove_outside & | GetRemove_outside (void) const |
Get the variant data. More... | |
TRemove_outside & | SetRemove_outside (void) |
Select the variant. More... | |
void | SetRemove_outside (TRemove_outside &value) |
Select the variant and set its data. 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 |
Static Public Member Functions | |
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) |
Private Types | |
typedef CSerialObject | Tparent |
Private Member Functions | |
CAction_choice_Base (const CAction_choice_Base &) | |
CAction_choice_Base & | operator= (const CAction_choice_Base &) |
void | DoSelect (E_Choice index, CObjectMemoryPool *pool=0) |
Private Attributes | |
E_Choice | m_choice |
NCBI_NS_NCBI::CSerialObject * | m_object |
Static Private Attributes | |
static const char *const | sm_SelectionNames [] |
Additional Inherited Members | |
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... | |
Definition at line 79 of file Action_choice_.hpp.