Search Toolkit Book for CT3Data
#include <objects/taxon3/T3Data.hpp>
Inheritance diagram for CT3Data:
Collaboration diagram for CT3Data:
Public Member Functions | |
| CT3Data (void) | |
| ~CT3Data (void) | |
| void | GetTaxFlags (bool &is_species_level, bool &force_consult, bool &has_nucleomorphs) const |
| bool | HasPlastids (void) const |
| void | FilterOutDataParts (ITaxon3::fT3reply_parts to_remain) |
| Public Member Functions inherited from CT3Data_Base | |
| CT3Data_Base (void) | |
| virtual | ~CT3Data_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSetOrg (void) const |
| Check if a value has been assigned to Org data member. More... | |
| bool | CanGetOrg (void) const |
| Check if it is safe to call GetOrg method. More... | |
| void | ResetOrg (void) |
| Reset Org data member. More... | |
| const TOrg & | GetOrg (void) const |
| Get the Org member data. More... | |
| void | SetOrg (TOrg &value) |
| Assign a value to Org data member. More... | |
| TOrg & | SetOrg (void) |
| Assign a value to Org data member. More... | |
| bool | IsSetBlast_name_lineage (void) const |
| Check if a value has been assigned to Blast_name_lineage data member. More... | |
| bool | CanGetBlast_name_lineage (void) const |
| Check if it is safe to call GetBlast_name_lineage method. More... | |
| void | ResetBlast_name_lineage (void) |
| Reset Blast_name_lineage data member. More... | |
| const TBlast_name_lineage & | GetBlast_name_lineage (void) const |
| Get the Blast_name_lineage member data. More... | |
| TBlast_name_lineage & | SetBlast_name_lineage (void) |
| Assign a value to Blast_name_lineage data member. More... | |
| bool | IsSetStatus (void) const |
| Check if a value has been assigned to Status data member. More... | |
| bool | CanGetStatus (void) const |
| Check if it is safe to call GetStatus method. More... | |
| void | ResetStatus (void) |
| Reset Status data member. More... | |
| const TStatus & | GetStatus (void) const |
| Get the Status member data. More... | |
| TStatus & | SetStatus (void) |
| Assign a value to Status data member. More... | |
| bool | IsSetRefresh (void) const |
| Check if a value has been assigned to Refresh data member. More... | |
| bool | CanGetRefresh (void) const |
| Check if it is safe to call GetRefresh method. More... | |
| void | ResetRefresh (void) |
| Reset Refresh data member. More... | |
| const TRefresh & | GetRefresh (void) const |
| Get the Refresh member data. More... | |
| void | SetRefresh (TRefresh &value) |
| Assign a value to Refresh data member. More... | |
| TRefresh & | SetRefresh (void) |
| Assign a value to Refresh 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 CT3Data_Base | Tparent |
Private Member Functions | |
| CT3Data (const CT3Data &value) | |
| CT3Data & | operator= (const CT3Data &value) |
Additional Inherited Members | |
| Public Types inherited from CT3Data_Base | |
| enum class | E_memberIndex { e__allMandatory = 0 , e_org , e_blast_name_lineage , e_status , e_refresh } |
| typedef COrg_ref | TOrg |
| typedef list< string > | TBlast_name_lineage |
| typedef list< CRef< CT3StatusFlags > > | TStatus |
| typedef CT3RefreshFlags | TRefresh |
| typedef Tparent::CMemberIndex< E_memberIndex, 5 > | 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 55 of file T3Data.hpp.
Member Typedef Documentation
◆ Tparent
|
private |
Definition at line 57 of file T3Data.hpp.
Constructor & Destructor Documentation
◆ CT3Data() [1/2]
|
inline |
Definition at line 79 of file T3Data.hpp.
◆ ~CT3Data()
| CT3Data::~CT3Data | ( | void | ) |
Definition at line 54 of file T3Data.cpp.
◆ CT3Data() [2/2]
Member Function Documentation
◆ FilterOutDataParts()
| void CT3Data::FilterOutDataParts | ( | ITaxon3::fT3reply_parts | to_remain | ) |
Definition at line 113 of file T3Data.cpp.
References ITaxon3::eT3reply_blast_lin, ITaxon3::eT3reply_org, ITaxon3::eT3reply_refresh, ITaxon3::eT3reply_status, NO_FLAG, CT3Data_Base::ResetBlast_name_lineage(), CT3Data_Base::ResetOrg(), CT3Data_Base::ResetRefresh(), CT3Data_Base::ResetStatus(), and CT3Data_Base::SetOrg().
◆ GetTaxFlags()
| void CT3Data::GetTaxFlags | ( | bool & | is_species_level, |
| bool & | force_consult, | ||
| bool & | has_nucleomorphs | ||
| ) | const |
Definition at line 58 of file T3Data.cpp.
References NStr::EqualNocase(), CT3Data_Base::GetStatus(), CT3Data_Base::IsSetStatus(), and ITERATE.
Referenced by CTaxValidationAndCleanup::ListTaxLookupErrors(), MakeCommonBioSource(), and CUnculturedTool::x_TryRankFix().
◆ HasPlastids()
| bool CT3Data::HasPlastids | ( | void | ) | const |
Definition at line 93 of file T3Data.cpp.
References NStr::EqualNocase(), CT3Data_Base::GetStatus(), CT3Data_Base::IsSetStatus(), and ITERATE.
Referenced by CTaxValidationAndCleanup::ListTaxLookupErrors().
◆ operator=()
The documentation for this class was generated from the following files:
- include/objects/taxon3/T3Data.hpp
- src/objects/taxon3/T3Data.cpp
