CConstraint_choice Class Reference

Search Toolkit Book for CConstraint_choice

#include <objects/macro/Constraint_choice.hpp>

Inheritance diagram for CConstraint_choice:

Collaboration diagram for CConstraint_choice:

Public Member Functions
	CConstraint_choice (void)
	~CConstraint_choice (void)
Public Member Functions inherited from CConstraint_choice_Base
	CConstraint_choice_Base (void)
virtual	~CConstraint_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	IsString (void) const
	Check if variant String is selected. More...
const TString &	GetString (void) const
	Get the variant data. More...
TString &	SetString (void)
	Select the variant. More...
void	SetString (TString &value)
	Select the variant and set its data. More...
bool	IsLocation (void) const
	Check if variant Location is selected. More...
const TLocation &	GetLocation (void) const
	Get the variant data. More...
TLocation &	SetLocation (void)
	Select the variant. More...
void	SetLocation (TLocation &value)
	Select the variant and set its data. More...
bool	IsField (void) const
	Check if variant Field is selected. More...
const TField &	GetField (void) const
	Get the variant data. More...
TField &	SetField (void)
	Select the variant. More...
void	SetField (TField &value)
	Select the variant and set its data. More...
bool	IsSource (void) const
	Check if variant Source is selected. More...
const TSource &	GetSource (void) const
	Get the variant data. More...
TSource &	SetSource (void)
	Select the variant. More...
void	SetSource (TSource &value)
	Select the variant and set its data. More...
bool	IsCdsgeneprot_qual (void) const
	Check if variant Cdsgeneprot_qual is selected. More...
const TCdsgeneprot_qual &	GetCdsgeneprot_qual (void) const
	Get the variant data. More...
TCdsgeneprot_qual &	SetCdsgeneprot_qual (void)
	Select the variant. More...
void	SetCdsgeneprot_qual (TCdsgeneprot_qual &value)
	Select the variant and set its data. More...
bool	IsCdsgeneprot_pseudo (void) const
	Check if variant Cdsgeneprot_pseudo is selected. More...
const TCdsgeneprot_pseudo &	GetCdsgeneprot_pseudo (void) const
	Get the variant data. More...
TCdsgeneprot_pseudo &	SetCdsgeneprot_pseudo (void)
	Select the variant. More...
void	SetCdsgeneprot_pseudo (TCdsgeneprot_pseudo &value)
	Select the variant and set its data. More...
bool	IsSequence (void) const
	Check if variant Sequence is selected. More...
const TSequence &	GetSequence (void) const
	Get the variant data. More...
TSequence &	SetSequence (void)
	Select the variant. More...
void	SetSequence (TSequence &value)
	Select the variant and set its data. More...
bool	IsPub (void) const
	Check if variant Pub is selected. More...
const TPub &	GetPub (void) const
	Get the variant data. More...
TPub &	SetPub (void)
	Select the variant. More...
void	SetPub (TPub &value)
	Select the variant and set its data. More...
bool	IsMolinfo (void) const
	Check if variant Molinfo is selected. More...
const TMolinfo &	GetMolinfo (void) const
	Get the variant data. More...
TMolinfo &	SetMolinfo (void)
	Select the variant. More...
void	SetMolinfo (TMolinfo &value)
	Select the variant and set its data. More...
bool	IsField_missing (void) const
	Check if variant Field_missing is selected. More...
const TField_missing &	GetField_missing (void) const
	Get the variant data. More...
TField_missing &	SetField_missing (void)
	Select the variant. More...
void	SetField_missing (TField_missing &value)
	Select the variant and set its data. More...
bool	IsTranslation (void) const
	Check if variant Translation is selected. More...
const TTranslation &	GetTranslation (void) const
	Get the variant data. More...
TTranslation &	SetTranslation (void)
	Select the variant. More...
void	SetTranslation (TTranslation &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

Private Types
typedef CConstraint_choice_Base	Tparent

Private Member Functions
	CConstraint_choice (const CConstraint_choice &value)
CConstraint_choice &	operator= (const CConstraint_choice &value)

Additional Inherited Members
Public Types inherited from CConstraint_choice_Base
enum	E_Choice {   e_not_set = 0 , e_String , e_Location , e_Field ,   e_Source , e_Cdsgeneprot_qual , e_Cdsgeneprot_pseudo , e_Sequence ,   e_Pub , e_Molinfo , e_Field_missing , e_Translation }
	Choice variants. More...
enum	E_ChoiceStopper { e_MaxChoice = 12 }
	Maximum+1 value of the choice variant enumerator. More...
typedef CString_constraint	TString
typedef CLocation_constraint	TLocation
typedef CField_constraint	TField
typedef CSource_constraint	TSource
typedef CCDSGeneProt_qual_constraint	TCdsgeneprot_qual
typedef CCDSGeneProt_pseudo_constraint	TCdsgeneprot_pseudo
typedef CSequence_constraint	TSequence
typedef CPublication_constraint	TPub
typedef CMolinfo_field_constraint	TMolinfo
typedef CField_type	TField_missing
typedef CTranslation_constraint	TTranslation
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 CConstraint_choice_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 Constraint_choice.hpp.

Member Typedef Documentation

Tparent

typedef CConstraint_choice_Base CConstraint_choice::Tparent

private

Definition at line 55 of file Constraint_choice.hpp.

Constructor & Destructor Documentation

CConstraint_choice() [1/2]

CConstraint_choice::CConstraint_choice ( void  )

inline

Definition at line 72 of file Constraint_choice.hpp.

~CConstraint_choice()

CConstraint_choice::~CConstraint_choice

(

void

)

Definition at line 50 of file Constraint_choice.cpp.

CConstraint_choice() [2/2]

CConstraint_choice::CConstraint_choice ( const CConstraint_choice &  value )

private

Member Function Documentation

operator=()

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

private

---

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

• include/objects/macro/Constraint_choice.hpp
• src/objects/macro/Constraint_choice.cpp