#include <objects/omssa/MSRequest.hpp>

Inheritance diagram for CMSRequest:

Collaboration diagram for CMSRequest:

Public Member Functions
	CMSRequest (void)

	~CMSRequest (void)

CConstRef< TSettings >	GetSettingsById (const int Id) const
	return a settings by settingid More...

Public Member Functions inherited from CMSRequest_Base
	CMSRequest_Base (void)

virtual	~CMSRequest_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

bool	IsSetSpectra (void) const
	the set of spectra Check if a value has been assigned to Spectra data member. More...

bool	CanGetSpectra (void) const
	Check if it is safe to call GetSpectra method. More...

void	ResetSpectra (void)
	Reset Spectra data member. More...

const TSpectra &	GetSpectra (void) const
	Get the Spectra member data. More...

void	SetSpectra (TSpectra &value)
	Assign a value to Spectra data member. More...

TSpectra &	SetSpectra (void)
	Assign a value to Spectra data member. More...

bool	IsSetSettings (void) const
	the search settings Check if a value has been assigned to Settings data member. More...

bool	CanGetSettings (void) const
	Check if it is safe to call GetSettings method. More...

void	ResetSettings (void)
	Reset Settings data member. More...

const TSettings &	GetSettings (void) const
	Get the Settings member data. More...

void	SetSettings (TSettings &value)
	Assign a value to Settings data member. More...

TSettings &	SetSettings (void)
	Assign a value to Settings data member. More...

bool	IsSetRid (void) const
	request id Check if a value has been assigned to Rid data member. More...

bool	CanGetRid (void) const
	Check if it is safe to call GetRid method. More...

void	ResetRid (void)
	Reset Rid data member. More...

const TRid &	GetRid (void) const
	Get the Rid member data. More...

void	SetRid (const TRid &value)
	Assign a value to Rid data member. More...

void	SetRid (TRid &&value)

TRid &	SetRid (void)
	Assign a value to Rid data member. More...

bool	IsSetMoresettings (void) const
	additional search runs Check if a value has been assigned to Moresettings data member. More...

bool	CanGetMoresettings (void) const
	Check if it is safe to call GetMoresettings method. More...

void	ResetMoresettings (void)
	Reset Moresettings data member. More...

const TMoresettings &	GetMoresettings (void) const
	Get the Moresettings member data. More...

void	SetMoresettings (TMoresettings &value)
	Assign a value to Moresettings data member. More...

TMoresettings &	SetMoresettings (void)
	Assign a value to Moresettings data member. More...

bool	IsSetModset (void) const
	list of mods that can be used in search Check if a value has been assigned to Modset data member. More...

bool	CanGetModset (void) const
	Check if it is safe to call GetModset method. More...

void	ResetModset (void)
	Reset Modset data member. More...

const TModset &	GetModset (void) const
	Get the Modset member data. More...

void	SetModset (TModset &value)
	Assign a value to Modset data member. More...

TModset &	SetModset (void)
	Assign a value to Modset 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 CMSRequest_Base	Tparent

Private Member Functions
	CMSRequest (const CMSRequest &value)

CMSRequest &	operator= (const CMSRequest &value)

Additional Inherited Members
Public Types inherited from CMSRequest_Base
enum class	E_memberIndex { e__allMandatory = 0 , e_spectra , e_settings , e_rid , e_moresettings , e_modset }

typedef CMSSpectrumset	TSpectra

typedef CMSSearchSettings	TSettings

typedef string	TRid

typedef CMSSearchSettingsSet	TMoresettings

typedef CMSModSpecSet	TModset

typedef Tparent::CMemberIndex< E_memberIndex, 6 >	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...

Detailed Description

Definition at line 53 of file MSRequest.hpp.

Member Typedef Documentation

◆ Tparent

typedef CMSRequest_Base CMSRequest::Tparent

private

Definition at line 55 of file MSRequest.hpp.

Constructor & Destructor Documentation

◆ CMSRequest() [1/2]

CMSRequest::CMSRequest ( void )

inline

Definition at line 81 of file MSRequest.hpp.

◆ ~CMSRequest()

CMSRequest::~CMSRequest ( void )

Definition at line 52 of file MSRequest.cpp.

◆ CMSRequest() [2/2]

CMSRequest::CMSRequest ( const CMSRequest & value )

private

Member Function Documentation

◆ GetSettingsById()

CConstRef< CMSRequest::TSettings > CMSRequest::GetSettingsById ( const int Id ) const

return a settings by settingid

Parameters

Id	setting id

Returns: setting or null if no settings found

Definition at line 56 of file MSRequest.cpp.

References CMSRequest_Base::CanGetMoresettings(), CMSRequest_Base::CanGetSettings(), Get(), CMSRequest_Base::GetMoresettings(), CMSRequest_Base::GetSettings(), and ITERATE.

◆ operator=()

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

private

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

include/objects/omssa/MSRequest.hpp
src/objects/omssa/MSRequest.cpp

Public Member Functions

Private Types

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Tparent

Constructor & Destructor Documentation

◆ CMSRequest() [1/2]

◆ ~CMSRequest()

◆ CMSRequest() [2/2]

Member Function Documentation

◆ GetSettingsById()

◆ operator=()