NCBI C++ ToolKit
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | List of all members
CTaxon2_data Class Reference

Represents ASN.1 type Taxon2-data defined in file taxon1.asn

Search Toolkit Book for CTaxon2_data

#include <objects/taxon1/Taxon2_data.hpp>

+ Inheritance diagram for CTaxon2_data:
+ Collaboration diagram for CTaxon2_data:

Public Member Functions

 CTaxon2_data (void)
 
 ~CTaxon2_data (void)
 
void SetProperty (const string &name, const string &value)
 
void SetProperty (const string &name, int value)
 
void SetProperty (const string &name, bool value)
 
bool GetProperty (const string &name, string &value) const
 
bool GetProperty (const string &name, int &value) const
 
bool GetProperty (const string &name, bool &value) const
 
void ResetProperty (const string &name)
 
- Public Member Functions inherited from CTaxon2_data_Base
 CTaxon2_data_Base (void)
 
virtual ~CTaxon2_data_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetOrg (void) const
 Org-ref with Org-name and db filled in 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 TOrgGetOrg (void) const
 Get the Org member data. More...
 
void SetOrg (TOrg &value)
 Assign a value to Org data member. More...
 
TOrgSetOrg (void)
 Assign a value to Org data member. More...
 
bool IsSetBlast_name (void) const
 inherited blast name Check if a value has been assigned to Blast_name data member. More...
 
bool CanGetBlast_name (void) const
 Check if it is safe to call GetBlast_name method. More...
 
void ResetBlast_name (void)
 Reset Blast_name data member. More...
 
const TBlast_nameGetBlast_name (void) const
 Get the Blast_name member data. More...
 
TBlast_nameSetBlast_name (void)
 Assign a value to Blast_name data member. More...
 
bool IsSetIs_uncultured (void) const
 belongs to environmental bin Check if a value has been assigned to Is_uncultured data member. More...
 
bool CanGetIs_uncultured (void) const
 Check if it is safe to call GetIs_uncultured method. More...
 
void ResetIs_uncultured (void)
 Reset Is_uncultured data member. More...
 
TIs_uncultured GetIs_uncultured (void) const
 Get the Is_uncultured member data. More...
 
void SetIs_uncultured (TIs_uncultured value)
 Assign a value to Is_uncultured data member. More...
 
TIs_unculturedSetIs_uncultured (void)
 Assign a value to Is_uncultured data member. More...
 
bool IsSetIs_species_level (void) const
 species level or below Check if a value has been assigned to Is_species_level data member. More...
 
bool CanGetIs_species_level (void) const
 Check if it is safe to call GetIs_species_level method. More...
 
void ResetIs_species_level (void)
 Reset Is_species_level data member. More...
 
TIs_species_level GetIs_species_level (void) const
 Get the Is_species_level member data. More...
 
void SetIs_species_level (TIs_species_level value)
 Assign a value to Is_species_level data member. More...
 
TIs_species_levelSetIs_species_level (void)
 Assign a value to Is_species_level 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
 

Protected Types

typedef list< CRef< CDbtag > > TOrgProperties
 

Protected Member Functions

TOrgProperties::iterator x_FindProperty (const string &name)
 
TOrgProperties::const_iterator x_FindPropertyConst (const string &name) const
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Protected Attributes

TOrgProperties m_props
 

Private Types

typedef CTaxon2_data_Base Tparent
 

Private Member Functions

 CTaxon2_data (const CTaxon2_data &value)
 
CTaxon2_dataoperator= (const CTaxon2_data &value)
 

Additional Inherited Members

- Public Types inherited from CTaxon2_data_Base
enum class  E_memberIndex {
  e__allMandatory = 0 , e_org , e_blast_name , e_is_uncultured ,
  e_is_species_level
}
 
typedef COrg_ref TOrg
 
typedef list< stringTBlast_name
 
typedef bool TIs_uncultured
 
typedef bool TIs_species_level
 
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< 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...
 

Detailed Description

Definition at line 53 of file Taxon2_data.hpp.

Member Typedef Documentation

◆ TOrgProperties

typedef list< CRef< CDbtag > > CTaxon2_data::TOrgProperties
protected

Definition at line 78 of file Taxon2_data.hpp.

◆ Tparent

Definition at line 55 of file Taxon2_data.hpp.

Constructor & Destructor Documentation

◆ CTaxon2_data() [1/2]

CTaxon2_data::CTaxon2_data ( void  )
inline

Definition at line 88 of file Taxon2_data.hpp.

◆ ~CTaxon2_data()

CTaxon2_data::~CTaxon2_data ( void  )

Definition at line 50 of file Taxon2_data.cpp.

◆ CTaxon2_data() [2/2]

CTaxon2_data::CTaxon2_data ( const CTaxon2_data value)
private

Member Function Documentation

◆ GetProperty() [1/3]

bool CTaxon2_data::GetProperty ( const string name,
bool value 
) const

◆ GetProperty() [2/3]

bool CTaxon2_data::GetProperty ( const string name,
int value 
) const

◆ GetProperty() [3/3]

bool CTaxon2_data::GetProperty ( const string name,
string value 
) const

◆ operator=()

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

◆ ResetProperty()

void CTaxon2_data::ResetProperty ( const string name)

Definition at line 173 of file Taxon2_data.cpp.

References i, m_props, and x_FindProperty().

◆ SetProperty() [1/3]

void CTaxon2_data::SetProperty ( const string name,
bool  value 
)

◆ SetProperty() [2/3]

void CTaxon2_data::SetProperty ( const string name,
const string value 
)

◆ SetProperty() [3/3]

void CTaxon2_data::SetProperty ( const string name,
int  value 
)

◆ x_FindProperty()

CTaxon2_data::TOrgProperties::iterator CTaxon2_data::x_FindProperty ( const string name)
protected

Definition at line 55 of file Taxon2_data.cpp.

References NStr::Equal(), i, m_props, and NON_CONST_ITERATE.

Referenced by ResetProperty(), and SetProperty().

◆ x_FindPropertyConst()

CTaxon2_data::TOrgProperties::const_iterator CTaxon2_data::x_FindPropertyConst ( const string name) const
protected

Definition at line 66 of file Taxon2_data.cpp.

References NStr::Equal(), i, ITERATE, and m_props.

Referenced by GetProperty().

Member Data Documentation

◆ m_props

TOrgProperties CTaxon2_data::m_props
protected

The documentation for this class was generated from the following files:
Modified on Thu Apr 25 08:16:28 2024 by modify_doxy.py rev. 669887