NCBI C++ ToolKit
|
Search Toolkit Book for CChoice
#include <gui/objects/Choice.hpp>
Public Member Functions | |
CChoice (void) | |
~CChoice (void) | |
Public Member Functions inherited from CChoice_Base | |
CChoice_Base (void) | |
virtual | ~CChoice_Base (void) |
DECLARE_INTERNAL_TYPE_INFO () | |
bool | IsSetName (void) const |
Check if a value has been assigned to Name data member. More... | |
bool | CanGetName (void) const |
Check if it is safe to call GetName method. More... | |
void | ResetName (void) |
Reset Name data member. More... | |
const TName & | GetName (void) const |
Get the Name member data. More... | |
void | SetName (const TName &value) |
Assign a value to Name data member. More... | |
void | SetName (TName &&value) |
TName & | SetName (void) |
Assign a value to Name data member. More... | |
bool | IsSetCurr_value (void) const |
Check if a value has been assigned to Curr_value data member. More... | |
bool | CanGetCurr_value (void) const |
Check if it is safe to call GetCurr_value method. More... | |
void | ResetCurr_value (void) |
Reset Curr_value data member. More... | |
const TCurr_value & | GetCurr_value (void) const |
Get the Curr_value member data. More... | |
void | SetCurr_value (const TCurr_value &value) |
Assign a value to Curr_value data member. More... | |
void | SetCurr_value (TCurr_value &&value) |
TCurr_value & | SetCurr_value (void) |
Assign a value to Curr_value data member. More... | |
bool | IsSetValues (void) const |
Check if a value has been assigned to Values data member. More... | |
bool | CanGetValues (void) const |
Check if it is safe to call GetValues method. More... | |
void | ResetValues (void) |
Reset Values data member. More... | |
const TValues & | GetValues (void) const |
Get the Values member data. More... | |
TValues & | SetValues (void) |
Assign a value to Values data member. More... | |
bool | IsSetDisplay_name (void) const |
Check if a value has been assigned to Display_name data member. More... | |
bool | CanGetDisplay_name (void) const |
Check if it is safe to call GetDisplay_name method. More... | |
void | ResetDisplay_name (void) |
Reset Display_name data member. More... | |
const TDisplay_name & | GetDisplay_name (void) const |
Get the Display_name member data. More... | |
void | SetDisplay_name (const TDisplay_name &value) |
Assign a value to Display_name data member. More... | |
void | SetDisplay_name (TDisplay_name &&value) |
TDisplay_name & | SetDisplay_name (void) |
Assign a value to Display_name data member. More... | |
bool | IsSetHelp (void) const |
Check if a value has been assigned to Help data member. More... | |
bool | CanGetHelp (void) const |
Check if it is safe to call GetHelp method. More... | |
void | ResetHelp (void) |
Reset Help data member. More... | |
const THelp & | GetHelp (void) const |
Get the Help member data. More... | |
void | SetHelp (const THelp &value) |
Assign a value to Help data member. More... | |
void | SetHelp (THelp &&value) |
THelp & | SetHelp (void) |
Assign a value to Help data member. More... | |
bool | IsSetOptional (void) const |
Check if a value has been assigned to Optional data member. More... | |
bool | CanGetOptional (void) const |
Check if it is safe to call GetOptional method. More... | |
void | ResetOptional (void) |
Reset Optional data member. More... | |
TOptional | GetOptional (void) const |
Get the Optional member data. More... | |
void | SetOptional (TOptional value) |
Assign a value to Optional data member. More... | |
TOptional & | SetOptional (void) |
Assign a value to Optional data member. More... | |
bool | IsSetConditions (void) const |
Check if a value has been assigned to Conditions data member. More... | |
bool | CanGetConditions (void) const |
Check if it is safe to call GetConditions method. More... | |
void | ResetConditions (void) |
Reset Conditions data member. More... | |
const TConditions & | GetConditions (void) const |
Get the Conditions member data. More... | |
TConditions & | SetConditions (void) |
Assign a value to Conditions 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 CChoice_Base | Tparent |
Private Member Functions | |
CChoice (const CChoice &value) | |
CChoice & | operator= (const CChoice &value) |
Additional Inherited Members | |
Public Types inherited from CChoice_Base | |
enum class | E_memberIndex { e__allMandatory = 0 , e_name , e_curr_value , e_values , e_display_name , e_help , e_optional , e_conditions } |
typedef string | TName |
typedef string | TCurr_value |
typedef list< CRef< CChoiceItem > > | TValues |
typedef string | TDisplay_name |
typedef string | THelp |
typedef bool | TOptional |
typedef list< CRef< CConditional > > | TConditions |
typedef Tparent::CMemberIndex< E_memberIndex, 8 > | 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... | |
CChoice –.
Definition at line 65 of file Choice.hpp.