NCBI C++ ToolKit
Public Member Functions | Private Types | Private Member Functions | List of all members

Search Toolkit Book for CPIR_block

CPIR_block –. More...

#include <objects/seqblock/PIR_block.hpp>

+ Inheritance diagram for CPIR_block:
+ Collaboration diagram for CPIR_block:

Public Member Functions

 CPIR_block (void)
 
 ~CPIR_block (void)
 
- Public Member Functions inherited from CPIR_block_Base
 CPIR_block_Base (void)
 
virtual ~CPIR_block_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetHad_punct (void) const
 had punctuation in sequence ? Check if a value has been assigned to Had_punct data member. More...
 
bool CanGetHad_punct (void) const
 Check if it is safe to call GetHad_punct method. More...
 
void ResetHad_punct (void)
 Reset Had_punct data member. More...
 
THad_punct GetHad_punct (void) const
 Get the Had_punct member data. More...
 
void SetHad_punct (THad_punct value)
 Assign a value to Had_punct data member. More...
 
THad_punctSetHad_punct (void)
 Assign a value to Had_punct data member. More...
 
bool IsSetHost (void) const
 Check if a value has been assigned to Host data member. More...
 
bool CanGetHost (void) const
 Check if it is safe to call GetHost method. More...
 
void ResetHost (void)
 Reset Host data member. More...
 
const THostGetHost (void) const
 Get the Host member data. More...
 
void SetHost (const THost &value)
 Assign a value to Host data member. More...
 
void SetHost (THost &&value)
 
THostSetHost (void)
 Assign a value to Host data member. More...
 
bool IsSetSource (void) const
 source line Check if a value has been assigned to Source data member. More...
 
bool CanGetSource (void) const
 Check if it is safe to call GetSource method. More...
 
void ResetSource (void)
 Reset Source data member. More...
 
const TSourceGetSource (void) const
 Get the Source member data. More...
 
void SetSource (const TSource &value)
 Assign a value to Source data member. More...
 
void SetSource (TSource &&value)
 
TSourceSetSource (void)
 Assign a value to Source data member. More...
 
bool IsSetSummary (void) const
 Check if a value has been assigned to Summary data member. More...
 
bool CanGetSummary (void) const
 Check if it is safe to call GetSummary method. More...
 
void ResetSummary (void)
 Reset Summary data member. More...
 
const TSummaryGetSummary (void) const
 Get the Summary member data. More...
 
void SetSummary (const TSummary &value)
 Assign a value to Summary data member. More...
 
void SetSummary (TSummary &&value)
 
TSummarySetSummary (void)
 Assign a value to Summary data member. More...
 
bool IsSetGenetic (void) const
 Check if a value has been assigned to Genetic data member. More...
 
bool CanGetGenetic (void) const
 Check if it is safe to call GetGenetic method. More...
 
void ResetGenetic (void)
 Reset Genetic data member. More...
 
const TGeneticGetGenetic (void) const
 Get the Genetic member data. More...
 
void SetGenetic (const TGenetic &value)
 Assign a value to Genetic data member. More...
 
void SetGenetic (TGenetic &&value)
 
TGeneticSetGenetic (void)
 Assign a value to Genetic data member. More...
 
bool IsSetIncludes (void) const
 Check if a value has been assigned to Includes data member. More...
 
bool CanGetIncludes (void) const
 Check if it is safe to call GetIncludes method. More...
 
void ResetIncludes (void)
 Reset Includes data member. More...
 
const TIncludesGetIncludes (void) const
 Get the Includes member data. More...
 
void SetIncludes (const TIncludes &value)
 Assign a value to Includes data member. More...
 
void SetIncludes (TIncludes &&value)
 
TIncludesSetIncludes (void)
 Assign a value to Includes data member. More...
 
bool IsSetPlacement (void) const
 Check if a value has been assigned to Placement data member. More...
 
bool CanGetPlacement (void) const
 Check if it is safe to call GetPlacement method. More...
 
void ResetPlacement (void)
 Reset Placement data member. More...
 
const TPlacementGetPlacement (void) const
 Get the Placement member data. More...
 
void SetPlacement (const TPlacement &value)
 Assign a value to Placement data member. More...
 
void SetPlacement (TPlacement &&value)
 
TPlacementSetPlacement (void)
 Assign a value to Placement data member. More...
 
bool IsSetSuperfamily (void) const
 Check if a value has been assigned to Superfamily data member. More...
 
bool CanGetSuperfamily (void) const
 Check if it is safe to call GetSuperfamily method. More...
 
void ResetSuperfamily (void)
 Reset Superfamily data member. More...
 
const TSuperfamilyGetSuperfamily (void) const
 Get the Superfamily member data. More...
 
void SetSuperfamily (const TSuperfamily &value)
 Assign a value to Superfamily data member. More...
 
void SetSuperfamily (TSuperfamily &&value)
 
TSuperfamilySetSuperfamily (void)
 Assign a value to Superfamily data member. More...
 
bool IsSetKeywords (void) const
 Check if a value has been assigned to Keywords data member. More...
 
bool CanGetKeywords (void) const
 Check if it is safe to call GetKeywords method. More...
 
void ResetKeywords (void)
 Reset Keywords data member. More...
 
const TKeywordsGetKeywords (void) const
 Get the Keywords member data. More...
 
TKeywordsSetKeywords (void)
 Assign a value to Keywords data member. More...
 
bool IsSetCross_reference (void) const
 Check if a value has been assigned to Cross_reference data member. More...
 
bool CanGetCross_reference (void) const
 Check if it is safe to call GetCross_reference method. More...
 
void ResetCross_reference (void)
 Reset Cross_reference data member. More...
 
const TCross_referenceGetCross_reference (void) const
 Get the Cross_reference member data. More...
 
void SetCross_reference (const TCross_reference &value)
 Assign a value to Cross_reference data member. More...
 
void SetCross_reference (TCross_reference &&value)
 
TCross_referenceSetCross_reference (void)
 Assign a value to Cross_reference data member. More...
 
bool IsSetDate (void) const
 Check if a value has been assigned to Date data member. More...
 
bool CanGetDate (void) const
 Check if it is safe to call GetDate method. More...
 
void ResetDate (void)
 Reset Date data member. More...
 
const TDateGetDate (void) const
 Get the Date member data. More...
 
void SetDate (const TDate &value)
 Assign a value to Date data member. More...
 
void SetDate (TDate &&value)
 
TDateSetDate (void)
 Assign a value to Date data member. More...
 
bool IsSetSeq_raw (void) const
 seq with punctuation Check if a value has been assigned to Seq_raw data member. More...
 
bool CanGetSeq_raw (void) const
 Check if it is safe to call GetSeq_raw method. More...
 
void ResetSeq_raw (void)
 Reset Seq_raw data member. More...
 
const TSeq_rawGetSeq_raw (void) const
 Get the Seq_raw member data. More...
 
void SetSeq_raw (const TSeq_raw &value)
 Assign a value to Seq_raw data member. More...
 
void SetSeq_raw (TSeq_raw &&value)
 
TSeq_rawSetSeq_raw (void)
 Assign a value to Seq_raw data member. More...
 
bool IsSetSeqref (void) const
 xref to other sequences Check if a value has been assigned to Seqref data member. More...
 
bool CanGetSeqref (void) const
 Check if it is safe to call GetSeqref method. More...
 
void ResetSeqref (void)
 Reset Seqref data member. More...
 
const TSeqrefGetSeqref (void) const
 Get the Seqref member data. More...
 
TSeqrefSetSeqref (void)
 Assign a value to Seqref 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
 

Private Types

typedef CPIR_block_Base Tparent
 

Private Member Functions

 CPIR_block (const CPIR_block &value)
 
CPIR_blockoperator= (const CPIR_block &value)
 

Additional Inherited Members

- Public Types inherited from CPIR_block_Base
enum class  E_memberIndex {
  e__allMandatory = 0 , e_had_punct , e_host , e_source ,
  e_summary , e_genetic , e_includes , e_placement ,
  e_superfamily , e_keywords , e_cross_reference , e_date ,
  e_seq_raw , e_seqref
}
 
typedef bool THad_punct
 
typedef string THost
 
typedef string TSource
 
typedef string TSummary
 
typedef string TGenetic
 
typedef string TIncludes
 
typedef string TPlacement
 
typedef string TSuperfamily
 
typedef list< stringTKeywords
 
typedef string TCross_reference
 
typedef string TDate
 
typedef string TSeq_raw
 
typedef list< CRef< CSeq_id > > TSeqref
 
typedef Tparent::CMemberIndex< E_memberIndex, 14 > 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 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

CPIR_block –.

Definition at line 65 of file PIR_block.hpp.


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