Search Toolkit Book for CSimpleVariant_Base::C_Type

#include <objects/varrep/SimpleVariant_.hpp>

Inheritance diagram for CSimpleVariant_Base::C_Type:

Collaboration diagram for CSimpleVariant_Base::C_Type:

Public Types
enum	E_Choice { e_not_set = 0 , e_Na_identity , e_Na_sub , e_Prot_sub , e_Prot_silent , e_Del , e_Dup , e_Inv , e_Ins , e_Conv , e_Delins , e_Repeat , e_Prot_ext , e_Frameshift }
	Choice variants. More...

enum	E_ChoiceStopper { e_MaxChoice = 14 }
	Maximum+1 value of the choice variant enumerator. More...

typedef CNaIdentity	TNa_identity

typedef CNaSub	TNa_sub

typedef CProteinSub	TProt_sub

typedef CAaLocation	TProt_silent

typedef CDeletion	TDel

typedef CDuplication	TDup

typedef CInversion	TInv

typedef CInsertion	TIns

typedef CConversion	TConv

typedef CDelins	TDelins

typedef CRepeat	TRepeat

typedef CProteinExtension	TProt_ext

typedef CFrameshift	TFrameshift

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
	C_Type (void)

	~C_Type (void)

	DECLARE_INTERNAL_TYPE_INFO ()

void	Reset (void)
	Reset the whole object. More...

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	IsNa_identity (void) const
	Check if variant Na_identity is selected. More...

const TNa_identity &	GetNa_identity (void) const
	Get the variant data. More...

TNa_identity &	SetNa_identity (void)
	Select the variant. More...

void	SetNa_identity (TNa_identity &value)
	Select the variant and set its data. More...

bool	IsNa_sub (void) const
	Check if variant Na_sub is selected. More...

const TNa_sub &	GetNa_sub (void) const
	Get the variant data. More...

TNa_sub &	SetNa_sub (void)
	Select the variant. More...

void	SetNa_sub (TNa_sub &value)
	Select the variant and set its data. More...

bool	IsProt_sub (void) const
	Check if variant Prot_sub is selected. More...

const TProt_sub &	GetProt_sub (void) const
	Get the variant data. More...

TProt_sub &	SetProt_sub (void)
	Select the variant. More...

void	SetProt_sub (TProt_sub &value)
	Select the variant and set its data. More...

bool	IsProt_silent (void) const
	Check if variant Prot_silent is selected. More...

const TProt_silent &	GetProt_silent (void) const
	Get the variant data. More...

TProt_silent &	SetProt_silent (void)
	Select the variant. More...

void	SetProt_silent (TProt_silent &value)
	Select the variant and set its data. More...

bool	IsDel (void) const
	Check if variant Del is selected. More...

const TDel &	GetDel (void) const
	Get the variant data. More...

TDel &	SetDel (void)
	Select the variant. More...

void	SetDel (TDel &value)
	Select the variant and set its data. More...

bool	IsDup (void) const
	Check if variant Dup is selected. More...

const TDup &	GetDup (void) const
	Get the variant data. More...

TDup &	SetDup (void)
	Select the variant. More...

void	SetDup (TDup &value)
	Select the variant and set its data. More...

bool	IsInv (void) const
	Check if variant Inv is selected. More...

const TInv &	GetInv (void) const
	Get the variant data. More...

TInv &	SetInv (void)
	Select the variant. More...

void	SetInv (TInv &value)
	Select the variant and set its data. More...

bool	IsIns (void) const
	Check if variant Ins is selected. More...

const TIns &	GetIns (void) const
	Get the variant data. More...

TIns &	SetIns (void)
	Select the variant. More...

void	SetIns (TIns &value)
	Select the variant and set its data. More...

bool	IsConv (void) const
	Check if variant Conv is selected. More...

const TConv &	GetConv (void) const
	Get the variant data. More...

TConv &	SetConv (void)
	Select the variant. More...

void	SetConv (TConv &value)
	Select the variant and set its data. More...

bool	IsDelins (void) const
	Check if variant Delins is selected. More...

const TDelins &	GetDelins (void) const
	Get the variant data. More...

TDelins &	SetDelins (void)
	Select the variant. More...

void	SetDelins (TDelins &value)
	Select the variant and set its data. More...

bool	IsRepeat (void) const
	Check if variant Repeat is selected. More...

const TRepeat &	GetRepeat (void) const
	Get the variant data. More...

TRepeat &	SetRepeat (void)
	Select the variant. More...

void	SetRepeat (TRepeat &value)
	Select the variant and set its data. More...

bool	IsProt_ext (void) const
	Check if variant Prot_ext is selected. More...

const TProt_ext &	GetProt_ext (void) const
	Get the variant data. More...

TProt_ext &	SetProt_ext (void)
	Select the variant. More...

void	SetProt_ext (TProt_ext &value)
	Select the variant and set its data. More...

bool	IsFrameshift (void) const
	Check if variant Frameshift is selected. More...

const TFrameshift &	GetFrameshift (void) const
	Get the variant data. More...

TFrameshift &	SetFrameshift (void)
	Select the variant. More...

void	SetFrameshift (TFrameshift &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
	C_Type (const C_Type &)

C_Type &	operator= (const C_Type &)

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...

Detailed Description

C_Type –.

Definition at line 101 of file SimpleVariant_.hpp.

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

include/objects/varrep/SimpleVariant_.hpp
src/objects/varrep/SimpleVariant_.cpp

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description