Search Toolkit Book for CTMgr_Request_Base

#include <objects/trackmgr/TMgr_Request_.hpp>

Inheritance diagram for CTMgr_Request_Base:

Collaboration diagram for CTMgr_Request_Base:

Public Types
enum	E_Choice { e_not_set = 0 , e_Display_tracks , e_Switch_display_tracks , e_Track_attr_values , e_Blast_tracks , e_Create_user_tracks , e_Create_remote_tracks , e_Resolve_track_items , e_Remove_user_tracks , e_Retrieve_tracksets , e_Create_trackset , e_Rename_trackset , e_Supported_assemblies }
	Choice variants. More...

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

typedef CTMgr_DisplayTrackRequest	TDisplay_tracks

typedef CTMgr_SwitchTrackContextRequest	TSwitch_display_tracks

typedef CTMgr_TrackAttrValueRequest	TTrack_attr_values

typedef CTMgr_BlastRIDRequest	TBlast_tracks

typedef CTMgr_CreateUserTrackRequest	TCreate_user_tracks

typedef CTMgr_CreateRemoteTrackRequest	TCreate_remote_tracks

typedef CTMgr_ItemResolverRequest	TResolve_track_items

typedef CTMgr_RemoveUserTrackRequest	TRemove_user_tracks

typedef CTMgr_RetrieveTracksetRequest	TRetrieve_tracksets

typedef CTMgr_CreateTracksetRequest	TCreate_trackset

typedef CTMgr_RenameMyNCBICollectionRequest	TRename_trackset

typedef CTMgr_SupportedAssembliesRequest	TSupported_assemblies

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

virtual	~CTMgr_Request_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	IsDisplay_tracks (void) const
	Check if variant Display_tracks is selected. More...

const TDisplay_tracks &	GetDisplay_tracks (void) const
	Get the variant data. More...

TDisplay_tracks &	SetDisplay_tracks (void)
	Select the variant. More...

void	SetDisplay_tracks (TDisplay_tracks &value)
	Select the variant and set its data. More...

bool	IsSwitch_display_tracks (void) const
	Check if variant Switch_display_tracks is selected. More...

const TSwitch_display_tracks &	GetSwitch_display_tracks (void) const
	Get the variant data. More...

TSwitch_display_tracks &	SetSwitch_display_tracks (void)
	Select the variant. More...

void	SetSwitch_display_tracks (TSwitch_display_tracks &value)
	Select the variant and set its data. More...

bool	IsTrack_attr_values (void) const
	Check if variant Track_attr_values is selected. More...

const TTrack_attr_values &	GetTrack_attr_values (void) const
	Get the variant data. More...

TTrack_attr_values &	SetTrack_attr_values (void)
	Select the variant. More...

void	SetTrack_attr_values (TTrack_attr_values &value)
	Select the variant and set its data. More...

bool	IsBlast_tracks (void) const
	Check if variant Blast_tracks is selected. More...

const TBlast_tracks &	GetBlast_tracks (void) const
	Get the variant data. More...

TBlast_tracks &	SetBlast_tracks (void)
	Select the variant. More...

void	SetBlast_tracks (TBlast_tracks &value)
	Select the variant and set its data. More...

bool	IsCreate_user_tracks (void) const
	Check if variant Create_user_tracks is selected. More...

const TCreate_user_tracks &	GetCreate_user_tracks (void) const
	Get the variant data. More...

TCreate_user_tracks &	SetCreate_user_tracks (void)
	Select the variant. More...

void	SetCreate_user_tracks (TCreate_user_tracks &value)
	Select the variant and set its data. More...

bool	IsCreate_remote_tracks (void) const
	Check if variant Create_remote_tracks is selected. More...

const TCreate_remote_tracks &	GetCreate_remote_tracks (void) const
	Get the variant data. More...

TCreate_remote_tracks &	SetCreate_remote_tracks (void)
	Select the variant. More...

void	SetCreate_remote_tracks (TCreate_remote_tracks &value)
	Select the variant and set its data. More...

bool	IsResolve_track_items (void) const
	Check if variant Resolve_track_items is selected. More...

const TResolve_track_items &	GetResolve_track_items (void) const
	Get the variant data. More...

TResolve_track_items &	SetResolve_track_items (void)
	Select the variant. More...

void	SetResolve_track_items (TResolve_track_items &value)
	Select the variant and set its data. More...

bool	IsRemove_user_tracks (void) const
	Check if variant Remove_user_tracks is selected. More...

const TRemove_user_tracks &	GetRemove_user_tracks (void) const
	Get the variant data. More...

TRemove_user_tracks &	SetRemove_user_tracks (void)
	Select the variant. More...

void	SetRemove_user_tracks (TRemove_user_tracks &value)
	Select the variant and set its data. More...

bool	IsRetrieve_tracksets (void) const
	Check if variant Retrieve_tracksets is selected. More...

const TRetrieve_tracksets &	GetRetrieve_tracksets (void) const
	Get the variant data. More...

TRetrieve_tracksets &	SetRetrieve_tracksets (void)
	Select the variant. More...

void	SetRetrieve_tracksets (TRetrieve_tracksets &value)
	Select the variant and set its data. More...

bool	IsCreate_trackset (void) const
	Check if variant Create_trackset is selected. More...

const TCreate_trackset &	GetCreate_trackset (void) const
	Get the variant data. More...

TCreate_trackset &	SetCreate_trackset (void)
	Select the variant. More...

void	SetCreate_trackset (TCreate_trackset &value)
	Select the variant and set its data. More...

bool	IsRename_trackset (void) const
	Check if variant Rename_trackset is selected. More...

const TRename_trackset &	GetRename_trackset (void) const
	Get the variant data. More...

TRename_trackset &	SetRename_trackset (void)
	Select the variant. More...

void	SetRename_trackset (TRename_trackset &value)
	Select the variant and set its data. More...

bool	IsSupported_assemblies (void) const
	Check if variant Supported_assemblies is selected. More...

const TSupported_assemblies &	GetSupported_assemblies (void) const
	Get the variant data. More...

TSupported_assemblies &	SetSupported_assemblies (void)
	Select the variant. More...

void	SetSupported_assemblies (TSupported_assemblies &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
	CTMgr_Request_Base (const CTMgr_Request_Base &)

CTMgr_Request_Base &	operator= (const CTMgr_Request_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...

Detailed Description

Top-level request/reply
CTMgr_Request_Base –

Definition at line 89 of file TMgr_Request_.hpp.

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

include/objects/trackmgr/TMgr_Request_.hpp
src/objects/trackmgr/TMgr_Request_.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