NCBI C++ ToolKit
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | List of all members
CGCClient_GetAssemblyBySequenceRequest Class Reference

Search Toolkit Book for CGCClient_GetAssemblyBySequenceRequest

#include <objects/genomecoll/GCClient_GetAssemblyBySequ.hpp>

+ Inheritance diagram for CGCClient_GetAssemblyBySequenceRequest:
+ Collaboration diagram for CGCClient_GetAssemblyBySequenceRequest:

Public Member Functions

 CGCClient_GetAssemblyBySequenceRequest (void)
 
 ~CGCClient_GetAssemblyBySequenceRequest (void)
 
- Public Member Functions inherited from CGCClient_GetAssemblyBySequenceRequest_Base
 CGCClient_GetAssemblyBySequenceRequest_Base (void)
 
virtual ~CGCClient_GetAssemblyBySequenceRequest_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetSequence_acc (void) const
 Check if a value has been assigned to Sequence_acc data member. More...
 
bool CanGetSequence_acc (void) const
 Check if it is safe to call GetSequence_acc method. More...
 
void ResetSequence_acc (void)
 Reset Sequence_acc data member. More...
 
const TSequence_accGetSequence_acc (void) const
 Get the Sequence_acc member data. More...
 
TSequence_accSetSequence_acc (void)
 Assign a value to Sequence_acc data member. More...
 
bool IsSetFilter (void) const
 Check if a value has been assigned to Filter data member. More...
 
bool CanGetFilter (void) const
 Check if it is safe to call GetFilter method. More...
 
void ResetFilter (void)
 Reset Filter data member. More...
 
void SetDefaultFilter (void)
 Assign default value to Filter data member. More...
 
TFilter GetFilter (void) const
 Get the Filter member data. More...
 
void SetFilter (TFilter value)
 Assign a value to Filter data member. More...
 
TFilterSetFilter (void)
 Assign a value to Filter data member. More...
 
bool IsSetSort (void) const
 Check if a value has been assigned to Sort data member. More...
 
bool CanGetSort (void) const
 Check if it is safe to call GetSort method. More...
 
void ResetSort (void)
 Reset Sort data member. More...
 
void SetDefaultSort (void)
 Assign default value to Sort data member. More...
 
TSort GetSort (void) const
 Get the Sort member data. More...
 
void SetSort (TSort value)
 Assign a value to Sort data member. More...
 
TSortSetSort (void)
 Assign a value to Sort data member. More...
 
bool IsSetTop_assembly_only (void) const
 Check if a value has been assigned to Top_assembly_only data member. More...
 
bool CanGetTop_assembly_only (void) const
 Check if it is safe to call GetTop_assembly_only method. More...
 
void ResetTop_assembly_only (void)
 Reset Top_assembly_only data member. More...
 
void SetDefaultTop_assembly_only (void)
 Assign default value to Top_assembly_only data member. More...
 
TTop_assembly_only GetTop_assembly_only (void) const
 Get the Top_assembly_only member data. More...
 
void SetTop_assembly_only (TTop_assembly_only value)
 Assign a value to Top_assembly_only data member. More...
 
TTop_assembly_onlySetTop_assembly_only (void)
 Assign a value to Top_assembly_only data member. More...
 
bool IsSetAdd_sequence_roles (void) const
 Check if a value has been assigned to Add_sequence_roles data member. More...
 
bool CanGetAdd_sequence_roles (void) const
 Check if it is safe to call GetAdd_sequence_roles method. More...
 
void ResetAdd_sequence_roles (void)
 Reset Add_sequence_roles data member. More...
 
TAdd_sequence_roles GetAdd_sequence_roles (void) const
 Get the Add_sequence_roles member data. More...
 
void SetAdd_sequence_roles (TAdd_sequence_roles value)
 Assign a value to Add_sequence_roles data member. More...
 
TAdd_sequence_rolesSetAdd_sequence_roles (void)
 Assign a value to Add_sequence_roles 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 CTypeInfoGetThisTypeInfo (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 stringGetNamespaceName (void) const
 Get namespace name. More...
 
bool HasNamespacePrefix (void) const
 Check if data type has namespace prefix. More...
 
const stringGetNamespacePrefix (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...
 
CObjectoperator= (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 GetFilterDisplayName (int filter)
 
- Static Public Member Functions inherited from CGCClient_GetAssemblyBySequenceRequest_Base
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() ESort (void)
 Access to ESort's attributes (values, names) as defined in spec. 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 CGCClient_GetAssemblyBySequenceRequest_Base Tparent
 

Private Member Functions

 CGCClient_GetAssemblyBySequenceRequest (const CGCClient_GetAssemblyBySequenceRequest &value)
 
CGCClient_GetAssemblyBySequenceRequestoperator= (const CGCClient_GetAssemblyBySequenceRequest &value)
 

Additional Inherited Members

- Public Types inherited from CGCClient_GetAssemblyBySequenceRequest_Base
enum  ESort { eSort_default = 0 , eSort_latest = 1 , eSort_major = 2 }
 
enum class  E_memberIndex {
  e__allMandatory = 0 , e_sequence_acc , e_filter , e_sort ,
  e_top_assembly_only , e_add_sequence_roles
}
 
typedef list< stringTSequence_acc
 
typedef int TFilter
 
typedef int TSort
 
typedef int TTop_assembly_only
 
typedef bool TAdd_sequence_roles
 
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< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 
- 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 GCClient_GetAssemblyBySequ.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 55 of file GCClient_GetAssemblyBySequ.hpp.

Constructor & Destructor Documentation

◆ CGCClient_GetAssemblyBySequenceRequest() [1/2]

CGCClient_GetAssemblyBySequenceRequest::CGCClient_GetAssemblyBySequenceRequest ( void  )
inline

Definition at line 75 of file GCClient_GetAssemblyBySequ.hpp.

◆ ~CGCClient_GetAssemblyBySequenceRequest()

CGCClient_GetAssemblyBySequenceRequest::~CGCClient_GetAssemblyBySequenceRequest ( void  )

Definition at line 52 of file GCClient_GetAssemblyBySequ.cpp.

◆ CGCClient_GetAssemblyBySequenceRequest() [2/2]

CGCClient_GetAssemblyBySequenceRequest::CGCClient_GetAssemblyBySequenceRequest ( const CGCClient_GetAssemblyBySequenceRequest value)
private

Member Function Documentation

◆ GetFilterDisplayName()

string CGCClient_GetAssemblyBySequenceRequest::GetFilterDisplayName ( int  filter)
static

◆ operator=()

CGCClient_GetAssemblyBySequenceRequest& CGCClient_GetAssemblyBySequenceRequest::operator= ( const CGCClient_GetAssemblyBySequenceRequest value)
private

The documentation for this class was generated from the following files:
Modified on Fri Sep 20 14:57:52 2024 by modify_doxy.py rev. 669887