NCBI C++ ToolKit
Classes | Typedefs | Enumerations | Enumerator | Functions | Variables
Code generated by DATATOOL from 'genesbyloc.asn' (module 'NCBI-GenesByLoc')
+ Collaboration diagram for Code generated by DATATOOL from 'genesbyloc.asn' (module 'NCBI-GenesByLoc'):

Classes

class  CGBL_Data
 CGBL_Data –. More...
 
class  CGBL_Data_Base
 CGBL_Data_Base –. More...
 
class  CGBL_Gene
 CGBL_Gene –. More...
 
class  CGBL_Gene_Base
 a single gene record More...
 
class  CGBL_Reply
 CGBL_Reply –. More...
 
class  CGBL_Reply_Base
 CGBL_Reply_Base –. More...
 

Typedefs

typedef CGBL_Data_Base CGBL_Data::Tparent
 
typedef CSerialObject CGBL_Data_Base::Tparent
 
typedef int CGBL_Data_Base::TTotal
 
typedef int CGBL_Data_Base::TReturned
 
typedef list< CRef< CGBL_Gene > > CGBL_Data_Base::TGenes
 
typedef Tparent::CMemberIndex< E_memberIndex, 4 > CGBL_Data_Base::TmemberIndex
 
typedef CGBL_Gene_Base CGBL_Gene::Tparent
 
typedef CSerialObject CGBL_Gene_Base::Tparent
 
typedef int CGBL_Gene_Base::TGeneid
 
typedef string CGBL_Gene_Base::TSymbol
 
typedef Tparent::CMemberIndex< E_memberIndex, 3 > CGBL_Gene_Base::TmemberIndex
 
typedef CGBL_Reply_Base CGBL_Reply::Tparent
 
typedef CSerialObject CGBL_Reply_Base::Tparent
 
typedef CGBL_Data CGBL_Reply_Base::TData
 
typedef string CGBL_Reply_Base::TError
 

Enumerations

enum class  CGBL_Data_Base::E_memberIndex { CGBL_Data_Base::e__allMandatory = 0 , CGBL_Data_Base::e_total , CGBL_Data_Base::e_returned , CGBL_Data_Base::e_genes }
 
enum class  CGBL_Gene_Base::E_memberIndex { CGBL_Gene_Base::e__allMandatory = 0 , CGBL_Gene_Base::e_geneid , CGBL_Gene_Base::e_symbol }
 
enum  CGBL_Reply_Base::E_Choice { CGBL_Reply_Base::e_not_set = 0 , CGBL_Reply_Base::e_Data , CGBL_Reply_Base::e_Error }
 Choice variants. More...
 
enum  CGBL_Reply_Base::E_ChoiceStopper { CGBL_Reply_Base::e_MaxChoice = 3 }
 Maximum+1 value of the choice variant enumerator. More...
 

Functions

 CGBL_Data::CGBL_Data (void)
 
 CGBL_Data::~CGBL_Data (void)
 
 CGBL_Data::CGBL_Data (const CGBL_Data &value)
 
CGBL_DataCGBL_Data::operator= (const CGBL_Data &value)
 
 CGBL_Data_Base::CGBL_Data_Base (void)
 
virtual CGBL_Data_Base::~CGBL_Data_Base (void)
 
 CGBL_Data_Base::DECLARE_INTERNAL_TYPE_INFO ()
 
bool CGBL_Data_Base::IsSetTotal (void) const
 total number of genes found Check if a value has been assigned to Total data member. More...
 
bool CGBL_Data_Base::CanGetTotal (void) const
 Check if it is safe to call GetTotal method. More...
 
void CGBL_Data_Base::ResetTotal (void)
 Reset Total data member. More...
 
TTotal CGBL_Data_Base::GetTotal (void) const
 Get the Total member data. More...
 
void CGBL_Data_Base::SetTotal (TTotal value)
 Assign a value to Total data member. More...
 
TTotalCGBL_Data_Base::SetTotal (void)
 Assign a value to Total data member. More...
 
bool CGBL_Data_Base::IsSetReturned (void) const
 number of gene records returned in the reply data, may be less than the total gene count Check if a value has been assigned to Returned data member. More...
 
bool CGBL_Data_Base::CanGetReturned (void) const
 Check if it is safe to call GetReturned method. More...
 
void CGBL_Data_Base::ResetReturned (void)
 Reset Returned data member. More...
 
TReturned CGBL_Data_Base::GetReturned (void) const
 Get the Returned member data. More...
 
void CGBL_Data_Base::SetReturned (TReturned value)
 Assign a value to Returned data member. More...
 
TReturnedCGBL_Data_Base::SetReturned (void)
 Assign a value to Returned data member. More...
 
bool CGBL_Data_Base::IsSetGenes (void) const
 Check if a value has been assigned to Genes data member. More...
 
bool CGBL_Data_Base::CanGetGenes (void) const
 Check if it is safe to call GetGenes method. More...
 
void CGBL_Data_Base::ResetGenes (void)
 Reset Genes data member. More...
 
const TGenesCGBL_Data_Base::GetGenes (void) const
 Get the Genes member data. More...
 
TGenesCGBL_Data_Base::SetGenes (void)
 Assign a value to Genes data member. More...
 
virtual void CGBL_Data_Base::Reset (void)
 Reset the whole object. More...
 
 CGBL_Data_Base::CGBL_Data_Base (const CGBL_Data_Base &)
 
CGBL_Data_BaseCGBL_Data_Base::operator= (const CGBL_Data_Base &)
 
 CGBL_Gene::CGBL_Gene (void)
 
 CGBL_Gene::~CGBL_Gene (void)
 
 CGBL_Gene::CGBL_Gene (const CGBL_Gene &value)
 
CGBL_GeneCGBL_Gene::operator= (const CGBL_Gene &value)
 
 CGBL_Gene_Base::CGBL_Gene_Base (void)
 
virtual CGBL_Gene_Base::~CGBL_Gene_Base (void)
 
 CGBL_Gene_Base::DECLARE_INTERNAL_TYPE_INFO ()
 
bool CGBL_Gene_Base::IsSetGeneid (void) const
 NCBI GeneID Check if a value has been assigned to Geneid data member. More...
 
bool CGBL_Gene_Base::CanGetGeneid (void) const
 Check if it is safe to call GetGeneid method. More...
 
void CGBL_Gene_Base::ResetGeneid (void)
 Reset Geneid data member. More...
 
TGeneid CGBL_Gene_Base::GetGeneid (void) const
 Get the Geneid member data. More...
 
void CGBL_Gene_Base::SetGeneid (TGeneid value)
 Assign a value to Geneid data member. More...
 
TGeneidCGBL_Gene_Base::SetGeneid (void)
 Assign a value to Geneid data member. More...
 
bool CGBL_Gene_Base::IsSetSymbol (void) const
 official or interim symbol for the gene Check if a value has been assigned to Symbol data member. More...
 
bool CGBL_Gene_Base::CanGetSymbol (void) const
 Check if it is safe to call GetSymbol method. More...
 
void CGBL_Gene_Base::ResetSymbol (void)
 Reset Symbol data member. More...
 
const TSymbolCGBL_Gene_Base::GetSymbol (void) const
 Get the Symbol member data. More...
 
void CGBL_Gene_Base::SetSymbol (const TSymbol &value)
 Assign a value to Symbol data member. More...
 
void CGBL_Gene_Base::SetSymbol (TSymbol &&value)
 
TSymbolCGBL_Gene_Base::SetSymbol (void)
 Assign a value to Symbol data member. More...
 
virtual void CGBL_Gene_Base::Reset (void)
 Reset the whole object. More...
 
 CGBL_Gene_Base::CGBL_Gene_Base (const CGBL_Gene_Base &)
 
CGBL_Gene_BaseCGBL_Gene_Base::operator= (const CGBL_Gene_Base &)
 
 CGBL_Reply::CGBL_Reply (void)
 
 CGBL_Reply::~CGBL_Reply (void)
 
 CGBL_Reply::CGBL_Reply (const CGBL_Reply &value)
 
CGBL_ReplyCGBL_Reply::operator= (const CGBL_Reply &value)
 
 CGBL_Reply_Base::CGBL_Reply_Base (void)
 
virtual CGBL_Reply_Base::~CGBL_Reply_Base (void)
 
 CGBL_Reply_Base::DECLARE_INTERNAL_TYPE_INFO ()
 
virtual void CGBL_Reply_Base::Reset (void)
 Reset the whole object. More...
 
virtual void CGBL_Reply_Base::ResetSelection (void)
 Reset the selection (set it to e_not_set). More...
 
E_Choice CGBL_Reply_Base::Which (void) const
 Which variant is currently selected. More...
 
void CGBL_Reply_Base::CheckSelected (E_Choice index) const
 Verify selection, throw exception if it differs from the expected. More...
 
void CGBL_Reply_Base::ThrowInvalidSelection (E_Choice index) const
 Throw 'InvalidSelection' exception. More...
 
static string CGBL_Reply_Base::SelectionName (E_Choice index)
 Retrieve selection name (for diagnostic purposes). More...
 
void CGBL_Reply_Base::Select (E_Choice index, EResetVariant reset=eDoResetVariant)
 Select the requested variant if needed. More...
 
void CGBL_Reply_Base::Select (E_Choice index, EResetVariant reset, CObjectMemoryPool *pool)
 Select the requested variant if needed, allocating CObject variants from memory pool. More...
 
bool CGBL_Reply_Base::IsData (void) const
 Check if variant Data is selected. More...
 
const TDataCGBL_Reply_Base::GetData (void) const
 Get the variant data. More...
 
TDataCGBL_Reply_Base::SetData (void)
 Select the variant. More...
 
void CGBL_Reply_Base::SetData (TData &value)
 Select the variant and set its data. More...
 
bool CGBL_Reply_Base::IsError (void) const
 Check if variant Error is selected. More...
 
const TErrorCGBL_Reply_Base::GetError (void) const
 Get the variant data. More...
 
TErrorCGBL_Reply_Base::SetError (void)
 Select the variant. More...
 
void CGBL_Reply_Base::SetError (const TError &value)
 Select the variant and set its data. More...
 
 CGBL_Reply_Base::CGBL_Reply_Base (const CGBL_Reply_Base &)
 
CGBL_Reply_BaseCGBL_Reply_Base::operator= (const CGBL_Reply_Base &)
 
void CGBL_Reply_Base::DoSelect (E_Choice index, CObjectMemoryPool *pool=0)
 

Variables

Uint4 CGBL_Data_Base::m_set_State [1]
 
int CGBL_Data_Base::m_Total
 
int CGBL_Data_Base::m_Returned
 
list< CRef< CGBL_Gene > > CGBL_Data_Base::m_Genes
 
Uint4 CGBL_Gene_Base::m_set_State [1]
 
int CGBL_Gene_Base::m_Geneid
 
string CGBL_Gene_Base::m_Symbol
 
E_Choice CGBL_Reply_Base::m_choice
 
static const char *const CGBL_Reply_Base::sm_SelectionNames []
 
NCBI_NS_NCBI::CUnionBuffer< NCBI_NS_STD::string >   CGBL_Reply_Base::m_string
 
NCBI_NS_NCBI::CSerialObject *   CGBL_Reply_Base::m_object
 
union {
   NCBI_NS_NCBI::CUnionBuffer< NCBI_NS_STD::string >   CGBL_Reply_Base::m_string
 
   NCBI_NS_NCBI::CSerialObject *   CGBL_Reply_Base::m_object
 
}; 
 

Detailed Description

Typedef Documentation

◆ TData

Definition at line 148 of file GBL_Reply_.hpp.

◆ TError

Definition at line 149 of file GBL_Reply_.hpp.

◆ TGeneid

Definition at line 86 of file GBL_Gene_.hpp.

◆ TGenes

Definition at line 91 of file GBL_Data_.hpp.

◆ TmemberIndex [1/2]

Definition at line 100 of file GBL_Data_.hpp.

◆ TmemberIndex [2/2]

Definition at line 95 of file GBL_Gene_.hpp.

◆ Tparent [1/6]

Definition at line 67 of file GBL_Data.hpp.

◆ Tparent [2/6]

Definition at line 78 of file GBL_Data_.hpp.

◆ Tparent [3/6]

Definition at line 67 of file GBL_Gene.hpp.

◆ Tparent [4/6]

Definition at line 75 of file GBL_Gene_.hpp.

◆ Tparent [5/6]

Definition at line 67 of file GBL_Reply.hpp.

◆ Tparent [6/6]

Definition at line 78 of file GBL_Reply_.hpp.

◆ TReturned

Definition at line 90 of file GBL_Data_.hpp.

◆ TSymbol

Definition at line 87 of file GBL_Gene_.hpp.

◆ TTotal

Definition at line 89 of file GBL_Data_.hpp.

Enumeration Type Documentation

◆ E_Choice

Choice variants.

Enumerator
e_not_set 

No variant selected.

e_Data 
e_Error 

Definition at line 90 of file GBL_Reply_.hpp.

◆ E_ChoiceStopper

Maximum+1 value of the choice variant enumerator.

Enumerator
e_MaxChoice 

== e_Error+1

Definition at line 96 of file GBL_Reply_.hpp.

◆ E_memberIndex [1/2]

Enumerator
e__allMandatory 
e_total 
e_returned 
e_genes 

Definition at line 94 of file GBL_Data_.hpp.

◆ E_memberIndex [2/2]

Enumerator
e__allMandatory 
e_geneid 
e_symbol 

Definition at line 90 of file GBL_Gene_.hpp.

Function Documentation

◆ CanGetGeneid()

bool CGBL_Gene_Base::CanGetGeneid ( void  ) const
inline

Check if it is safe to call GetGeneid method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 208 of file GBL_Gene_.hpp.

References CGBL_Gene_Base::IsSetGeneid().

Referenced by CGBL_Gene_Base::GetGeneid().

◆ CanGetGenes()

bool CGBL_Data_Base::CanGetGenes ( void  ) const
inline

Check if it is safe to call GetGenes method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 338 of file GBL_Data_.hpp.

◆ CanGetReturned()

bool CGBL_Data_Base::CanGetReturned ( void  ) const
inline

Check if it is safe to call GetReturned method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 291 of file GBL_Data_.hpp.

References CGBL_Data_Base::IsSetReturned().

Referenced by CGBL_Data_Base::GetReturned().

◆ CanGetSymbol()

bool CGBL_Gene_Base::CanGetSymbol ( void  ) const
inline

Check if it is safe to call GetSymbol method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 255 of file GBL_Gene_.hpp.

References CGBL_Gene_Base::IsSetSymbol().

Referenced by CGBL_Gene_Base::GetSymbol().

◆ CanGetTotal()

bool CGBL_Data_Base::CanGetTotal ( void  ) const
inline

Check if it is safe to call GetTotal method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 244 of file GBL_Data_.hpp.

References CGBL_Data_Base::IsSetTotal().

Referenced by CGBL_Data_Base::GetTotal().

◆ CGBL_Data() [1/2]

CGBL_Data::CGBL_Data ( const CGBL_Data value)
private

◆ CGBL_Data() [2/2]

CGBL_Data::CGBL_Data ( void  )
inline

Definition at line 86 of file GBL_Data.hpp.

◆ CGBL_Data_Base() [1/2]

CGBL_Data_Base::CGBL_Data_Base ( const CGBL_Data_Base )
private

◆ CGBL_Data_Base() [2/2]

END_CLASS_INFO CGBL_Data_Base::CGBL_Data_Base ( void  )

Definition at line 77 of file GBL_Data_.cpp.

References CGBL_Data_Base::m_set_State.

◆ CGBL_Gene() [1/2]

CGBL_Gene::CGBL_Gene ( const CGBL_Gene value)
private

◆ CGBL_Gene() [2/2]

CGBL_Gene::CGBL_Gene ( void  )
inline

Definition at line 86 of file GBL_Gene.hpp.

◆ CGBL_Gene_Base() [1/2]

CGBL_Gene_Base::CGBL_Gene_Base ( const CGBL_Gene_Base )
private

◆ CGBL_Gene_Base() [2/2]

END_CLASS_INFO CGBL_Gene_Base::CGBL_Gene_Base ( void  )

Definition at line 74 of file GBL_Gene_.cpp.

References CGBL_Gene_Base::m_set_State.

◆ CGBL_Reply() [1/2]

CGBL_Reply::CGBL_Reply ( const CGBL_Reply value)
private

◆ CGBL_Reply() [2/2]

CGBL_Reply::CGBL_Reply ( void  )
inline

Definition at line 86 of file GBL_Reply.hpp.

◆ CGBL_Reply_Base() [1/2]

CGBL_Reply_Base::CGBL_Reply_Base ( const CGBL_Reply_Base )
private

◆ CGBL_Reply_Base() [2/2]

END_CHOICE_INFO CGBL_Reply_Base::CGBL_Reply_Base ( void  )

Definition at line 145 of file GBL_Reply_.cpp.

◆ CheckSelected()

void CGBL_Reply_Base::CheckSelected ( E_Choice  index) const
inline

Verify selection, throw exception if it differs from the expected.

Parameters
indexExpected selection.

Definition at line 241 of file GBL_Reply_.hpp.

References CGBL_Reply_Base::m_choice, and CGBL_Reply_Base::ThrowInvalidSelection().

Referenced by CGBL_Reply_Base::GetData(), and CGBL_Reply_Base::GetError().

◆ DECLARE_INTERNAL_TYPE_INFO() [1/3]

CGBL_Data_Base::DECLARE_INTERNAL_TYPE_INFO ( )

◆ DECLARE_INTERNAL_TYPE_INFO() [2/3]

CGBL_Gene_Base::DECLARE_INTERNAL_TYPE_INFO ( )

◆ DECLARE_INTERNAL_TYPE_INFO() [3/3]

CGBL_Reply_Base::DECLARE_INTERNAL_TYPE_INFO ( )

◆ DoSelect()

void CGBL_Reply_Base::DoSelect ( E_Choice  index,
CObjectMemoryPool pool = 0 
)
private

◆ GetData()

const CGBL_Reply_Base::TData & CGBL_Reply_Base::GetData ( void  ) const

Get the variant data.

Returns
Reference to the data.

Definition at line 103 of file GBL_Reply_.cpp.

References CGBL_Reply_Base::CheckSelected(), CGBL_Reply_Base::e_Data, and CGBL_Reply_Base::m_object.

Referenced by s_GetGeneWeight().

◆ GetError()

const CGBL_Reply_Base::TError & CGBL_Reply_Base::GetError ( void  ) const
inline

Get the variant data.

Returns
Reference to the data.

Definition at line 276 of file GBL_Reply_.hpp.

References CGBL_Reply_Base::CheckSelected(), CGBL_Reply_Base::e_Error, and CGBL_Reply_Base::m_string.

Referenced by s_GetGeneWeight().

◆ GetGeneid()

CGBL_Gene_Base::TGeneid CGBL_Gene_Base::GetGeneid ( void  ) const
inline

Get the Geneid member data.

Returns
Copy of the member data.

Definition at line 221 of file GBL_Gene_.hpp.

References CGBL_Gene_Base::CanGetGeneid(), CGBL_Gene_Base::m_Geneid, and CSerialObject::ThrowUnassigned().

◆ GetGenes()

const CGBL_Data_Base::TGenes & CGBL_Data_Base::GetGenes ( void  ) const
inline

Get the Genes member data.

Returns
Reference to the member data.

Definition at line 344 of file GBL_Data_.hpp.

References CGBL_Data_Base::m_Genes.

◆ GetReturned()

CGBL_Data_Base::TReturned CGBL_Data_Base::GetReturned ( void  ) const
inline

Get the Returned member data.

Returns
Copy of the member data.

Definition at line 304 of file GBL_Data_.hpp.

References CGBL_Data_Base::CanGetReturned(), CGBL_Data_Base::m_Returned, and CSerialObject::ThrowUnassigned().

◆ GetSymbol()

const CGBL_Gene_Base::TSymbol & CGBL_Gene_Base::GetSymbol ( void  ) const
inline

Get the Symbol member data.

Returns
Reference to the member data.

Definition at line 261 of file GBL_Gene_.hpp.

References CGBL_Gene_Base::CanGetSymbol(), CGBL_Gene_Base::m_Symbol, and CSerialObject::ThrowUnassigned().

◆ GetTotal()

CGBL_Data_Base::TTotal CGBL_Data_Base::GetTotal ( void  ) const
inline

Get the Total member data.

Returns
Copy of the member data.

Definition at line 257 of file GBL_Data_.hpp.

References CGBL_Data_Base::CanGetTotal(), CGBL_Data_Base::m_Total, and CSerialObject::ThrowUnassigned().

◆ IsData()

bool CGBL_Reply_Base::IsData ( void  ) const
inline

Check if variant Data is selected.

Data type is defined as 'typedef CGBL_Data TData'.

Returns
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 264 of file GBL_Reply_.hpp.

References CGBL_Reply_Base::e_Data, and CGBL_Reply_Base::m_choice.

◆ IsError()

bool CGBL_Reply_Base::IsError ( void  ) const
inline

Check if variant Error is selected.

Error type is defined as 'typedef string TError'.

Returns
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 270 of file GBL_Reply_.hpp.

References CGBL_Reply_Base::e_Error, and CGBL_Reply_Base::m_choice.

Referenced by s_GetGeneWeight().

◆ IsSetGeneid()

bool CGBL_Gene_Base::IsSetGeneid ( void  ) const
inline

NCBI GeneID Check if a value has been assigned to Geneid data member.

Data member Geneid is mandatory; its type is defined as 'typedef int TGeneid'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 202 of file GBL_Gene_.hpp.

References CGBL_Gene_Base::m_set_State.

Referenced by CGBL_Gene_Base::CanGetGeneid(), and CGBL_Gene_Base::SetGeneid().

◆ IsSetGenes()

bool CGBL_Data_Base::IsSetGenes ( void  ) const
inline

Check if a value has been assigned to Genes data member.

Data member Genes is optional; its type is defined as 'typedef list< CRef< CGBL_Gene > > TGenes'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 332 of file GBL_Data_.hpp.

References CGBL_Data_Base::m_set_State.

◆ IsSetReturned()

bool CGBL_Data_Base::IsSetReturned ( void  ) const
inline

number of gene records returned in the reply data, may be less than the total gene count Check if a value has been assigned to Returned data member.

Data member Returned is mandatory; its type is defined as 'typedef int TReturned'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 285 of file GBL_Data_.hpp.

References CGBL_Data_Base::m_set_State.

Referenced by CGBL_Data_Base::CanGetReturned(), and CGBL_Data_Base::SetReturned().

◆ IsSetSymbol()

bool CGBL_Gene_Base::IsSetSymbol ( void  ) const
inline

official or interim symbol for the gene Check if a value has been assigned to Symbol data member.

Data member Symbol is mandatory; its type is defined as 'typedef string TSymbol'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 249 of file GBL_Gene_.hpp.

References CGBL_Gene_Base::m_set_State.

Referenced by CGBL_Gene_Base::CanGetSymbol(), and CGBL_Gene_Base::SetSymbol().

◆ IsSetTotal()

bool CGBL_Data_Base::IsSetTotal ( void  ) const
inline

total number of genes found Check if a value has been assigned to Total data member.

Data member Total is mandatory; its type is defined as 'typedef int TTotal'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 238 of file GBL_Data_.hpp.

References CGBL_Data_Base::m_set_State.

Referenced by CGBL_Data_Base::CanGetTotal(), and CGBL_Data_Base::SetTotal().

◆ operator=() [1/6]

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

◆ operator=() [2/6]

CGBL_Data_Base& CGBL_Data_Base::operator= ( const CGBL_Data_Base )
private

◆ operator=() [3/6]

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

◆ operator=() [4/6]

CGBL_Gene_Base& CGBL_Gene_Base::operator= ( const CGBL_Gene_Base )
private

◆ operator=() [5/6]

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

◆ operator=() [6/6]

CGBL_Reply_Base& CGBL_Reply_Base::operator= ( const CGBL_Reply_Base )
private

◆ Reset() [1/3]

void CGBL_Data_Base::Reset ( void  )
virtual

Reset the whole object.

Definition at line 57 of file GBL_Data_.cpp.

References CGBL_Data_Base::ResetGenes(), CGBL_Data_Base::ResetReturned(), and CGBL_Data_Base::ResetTotal().

◆ Reset() [2/3]

void CGBL_Gene_Base::Reset ( void  )
virtual

Reset the whole object.

Definition at line 56 of file GBL_Gene_.cpp.

References CGBL_Gene_Base::ResetGeneid(), and CGBL_Gene_Base::ResetSymbol().

◆ Reset() [3/3]

void CGBL_Reply_Base::Reset ( void  )
virtual

Reset the whole object.

Definition at line 51 of file GBL_Reply_.cpp.

References CGBL_Reply_Base::e_not_set, CGBL_Reply_Base::m_choice, and CGBL_Reply_Base::ResetSelection().

Referenced by CGBL_Reply_Base::~CGBL_Reply_Base().

◆ ResetGeneid()

void CGBL_Gene_Base::ResetGeneid ( void  )
inline

Reset Geneid data member.

Definition at line 214 of file GBL_Gene_.hpp.

References CGBL_Gene_Base::m_Geneid, and CGBL_Gene_Base::m_set_State.

Referenced by CGBL_Gene_Base::Reset().

◆ ResetGenes()

void CGBL_Data_Base::ResetGenes ( void  )

Reset Genes data member.

Definition at line 51 of file GBL_Data_.cpp.

References CGBL_Data_Base::m_Genes, and CGBL_Data_Base::m_set_State.

Referenced by CGBL_Data_Base::Reset().

◆ ResetReturned()

void CGBL_Data_Base::ResetReturned ( void  )
inline

Reset Returned data member.

Definition at line 297 of file GBL_Data_.hpp.

References CGBL_Data_Base::m_Returned, and CGBL_Data_Base::m_set_State.

Referenced by CGBL_Data_Base::Reset().

◆ ResetSelection()

void CGBL_Reply_Base::ResetSelection ( void  )
virtual

◆ ResetSymbol()

void CGBL_Gene_Base::ResetSymbol ( void  )

Reset Symbol data member.

Definition at line 50 of file GBL_Gene_.cpp.

References CGBL_Gene_Base::m_set_State, and CGBL_Gene_Base::m_Symbol.

Referenced by CGBL_Gene_Base::Reset().

◆ ResetTotal()

void CGBL_Data_Base::ResetTotal ( void  )
inline

Reset Total data member.

Definition at line 250 of file GBL_Data_.hpp.

References CGBL_Data_Base::m_set_State, and CGBL_Data_Base::m_Total.

Referenced by CGBL_Data_Base::Reset().

◆ Select() [1/2]

void CGBL_Reply_Base::Select ( E_Choice  index,
EResetVariant  reset,
CObjectMemoryPool pool 
)

Select the requested variant if needed, allocating CObject variants from memory pool.

◆ Select() [2/2]

void CGBL_Reply_Base::Select ( E_Choice  index,
EResetVariant  reset = eDoResetVariant 
)

Select the requested variant if needed.

Parameters
indexNew selection state.
resetFlag that defines the resetting of the variant data. The data will be reset if either the current selection differs from the new one, or the flag is set to eDoResetVariant.

Referenced by CGBL_Reply_Base::SetData(), and CGBL_Reply_Base::SetError().

◆ SelectionName()

NCBI_NS_STD::string CGBL_Reply_Base::SelectionName ( E_Choice  index)
static

Retrieve selection name (for diagnostic purposes).

Parameters
indexOne of possible selection states.
Returns
Name string.

Definition at line 93 of file GBL_Reply_.cpp.

References CGBL_Reply_Base::sm_SelectionNames.

◆ SetData() [1/2]

void CGBL_Reply_Base::SetData ( CGBL_Reply_Base::TData value)

Select the variant and set its data.

Parameters
valueReference to the data.

Definition at line 115 of file GBL_Reply_.cpp.

References CObject::AddReference(), CGBL_Reply_Base::e_Data, CGBL_Reply_Base::m_choice, CGBL_Reply_Base::m_object, CGBL_Reply_Base::ResetSelection(), and rapidjson::value.

◆ SetData() [2/2]

CGBL_Reply_Base::TData & CGBL_Reply_Base::SetData ( void  )

Select the variant.

Returns
Reference to the variant data.

Definition at line 109 of file GBL_Reply_.cpp.

References CGBL_Reply_Base::e_Data, eDoNotResetVariant, CGBL_Reply_Base::m_object, and CGBL_Reply_Base::Select().

◆ SetError() [1/2]

void CGBL_Reply_Base::SetError ( const TError value)

Select the variant and set its data.

Parameters
valueVariant data.

Definition at line 125 of file GBL_Reply_.cpp.

References CGBL_Reply_Base::e_Error, eDoNotResetVariant, CGBL_Reply_Base::m_string, CGBL_Reply_Base::Select(), and rapidjson::value.

◆ SetError() [2/2]

CGBL_Reply_Base::TError & CGBL_Reply_Base::SetError ( void  )
inline

Select the variant.

Returns
Reference to the variant data.

Definition at line 283 of file GBL_Reply_.hpp.

References CGBL_Reply_Base::e_Error, eDoNotResetVariant, CGBL_Reply_Base::m_string, and CGBL_Reply_Base::Select().

◆ SetGeneid() [1/2]

void CGBL_Gene_Base::SetGeneid ( CGBL_Gene_Base::TGeneid  value)
inline

Assign a value to Geneid data member.

Parameters
valueValue to assign

Definition at line 230 of file GBL_Gene_.hpp.

References CGBL_Gene_Base::m_Geneid, CGBL_Gene_Base::m_set_State, and rapidjson::value.

◆ SetGeneid() [2/2]

CGBL_Gene_Base::TGeneid & CGBL_Gene_Base::SetGeneid ( void  )
inline

Assign a value to Geneid data member.

Returns
Reference to the data value.

Definition at line 237 of file GBL_Gene_.hpp.

References CGBL_Gene_Base::IsSetGeneid(), CGBL_Gene_Base::m_Geneid, CGBL_Gene_Base::m_set_State, and CSerialObject::UnassignedByte().

◆ SetGenes()

CGBL_Data_Base::TGenes & CGBL_Data_Base::SetGenes ( void  )
inline

Assign a value to Genes data member.

Returns
Reference to the data value.

Definition at line 350 of file GBL_Data_.hpp.

References CGBL_Data_Base::m_Genes, and CGBL_Data_Base::m_set_State.

◆ SetReturned() [1/2]

void CGBL_Data_Base::SetReturned ( CGBL_Data_Base::TReturned  value)
inline

Assign a value to Returned data member.

Parameters
valueValue to assign

Definition at line 313 of file GBL_Data_.hpp.

References CGBL_Data_Base::m_Returned, CGBL_Data_Base::m_set_State, and rapidjson::value.

◆ SetReturned() [2/2]

CGBL_Data_Base::TReturned & CGBL_Data_Base::SetReturned ( void  )
inline

Assign a value to Returned data member.

Returns
Reference to the data value.

Definition at line 320 of file GBL_Data_.hpp.

References CGBL_Data_Base::IsSetReturned(), CGBL_Data_Base::m_Returned, CGBL_Data_Base::m_set_State, and CSerialObject::UnassignedByte().

◆ SetSymbol() [1/3]

void CGBL_Gene_Base::SetSymbol ( const TSymbol value)
inline

Assign a value to Symbol data member.

Parameters
valueValue to assign

Definition at line 270 of file GBL_Gene_.hpp.

References CGBL_Gene_Base::m_set_State, CGBL_Gene_Base::m_Symbol, and rapidjson::value.

◆ SetSymbol() [2/3]

void CGBL_Gene_Base::SetSymbol ( CGBL_Gene_Base::TSymbol &&  value)
inline

◆ SetSymbol() [3/3]

CGBL_Gene_Base::TSymbol & CGBL_Gene_Base::SetSymbol ( void  )
inline

Assign a value to Symbol data member.

Returns
Reference to the data value.

Definition at line 284 of file GBL_Gene_.hpp.

References CGBL_Gene_Base::IsSetSymbol(), CGBL_Gene_Base::m_set_State, CGBL_Gene_Base::m_Symbol, and CSerialObject::UnassignedString().

◆ SetTotal() [1/2]

void CGBL_Data_Base::SetTotal ( CGBL_Data_Base::TTotal  value)
inline

Assign a value to Total data member.

Parameters
valueValue to assign

Definition at line 266 of file GBL_Data_.hpp.

References CGBL_Data_Base::m_set_State, CGBL_Data_Base::m_Total, and rapidjson::value.

◆ SetTotal() [2/2]

CGBL_Data_Base::TTotal & CGBL_Data_Base::SetTotal ( void  )
inline

Assign a value to Total data member.

Returns
Reference to the data value.

Definition at line 273 of file GBL_Data_.hpp.

References CGBL_Data_Base::IsSetTotal(), CGBL_Data_Base::m_set_State, CGBL_Data_Base::m_Total, and CSerialObject::UnassignedByte().

◆ ThrowInvalidSelection()

void CGBL_Reply_Base::ThrowInvalidSelection ( E_Choice  index) const

Throw 'InvalidSelection' exception.

Parameters
indexExpected selection.

Definition at line 98 of file GBL_Reply_.cpp.

References DIAG_COMPILE_INFO, CGBL_Reply_Base::m_choice, and CGBL_Reply_Base::sm_SelectionNames.

Referenced by CGBL_Reply_Base::CheckSelected().

◆ Which()

CGBL_Reply_Base::E_Choice CGBL_Reply_Base::Which ( void  ) const
inline

Which variant is currently selected.

Returns
Choice state enumerator.

Definition at line 235 of file GBL_Reply_.hpp.

References CGBL_Reply_Base::m_choice.

◆ ~CGBL_Data()

CGBL_Data::~CGBL_Data ( void  )

Definition at line 50 of file GBL_Data.cpp.

◆ ~CGBL_Data_Base()

CGBL_Data_Base::~CGBL_Data_Base ( void  )
virtual

Definition at line 84 of file GBL_Data_.cpp.

◆ ~CGBL_Gene()

CGBL_Gene::~CGBL_Gene ( void  )

Definition at line 50 of file GBL_Gene.cpp.

◆ ~CGBL_Gene_Base()

CGBL_Gene_Base::~CGBL_Gene_Base ( void  )
virtual

Definition at line 81 of file GBL_Gene_.cpp.

◆ ~CGBL_Reply()

CGBL_Reply::~CGBL_Reply ( void  )

Definition at line 50 of file GBL_Reply.cpp.

◆ ~CGBL_Reply_Base()

CGBL_Reply_Base::~CGBL_Reply_Base ( void  )
virtual

Definition at line 151 of file GBL_Reply_.cpp.

References CGBL_Reply_Base::Reset().

Variable Documentation

◆ 

union { ... }

◆ m_choice

E_Choice CGBL_Reply_Base::m_choice
private

◆ m_Geneid

int CGBL_Gene_Base::m_Geneid
private

◆ m_Genes

list< CRef< CGBL_Gene > > CGBL_Data_Base::m_Genes
private

◆  [1/2]

NCBI_NS_NCBI::CSerialObject* { ... } ::m_object

Definition at line 221 of file GBL_Reply_.hpp.

◆ m_object [2/2]

NCBI_NS_NCBI::CSerialObject* CGBL_Reply_Base::m_object

◆ m_Returned

int CGBL_Data_Base::m_Returned
private

◆ m_set_State [1/2]

Uint4 CGBL_Data_Base::m_set_State[1]
private

◆ m_set_State [2/2]

Uint4 CGBL_Gene_Base::m_set_State[1]
private

◆  [1/2]

NCBI_NS_NCBI::CUnionBuffer<NCBI_NS_STD::string> { ... } ::m_string

Definition at line 220 of file GBL_Reply_.hpp.

◆ m_string [2/2]

NCBI_NS_NCBI::CUnionBuffer<NCBI_NS_STD::string> CGBL_Reply_Base::m_string

◆ m_Symbol

string CGBL_Gene_Base::m_Symbol
private

◆ m_Total

int CGBL_Data_Base::m_Total
private

◆ sm_SelectionNames

const char *const CGBL_Reply_Base::sm_SelectionNames
staticprivate
Initial value:
= {
"not set",
"data",
"error"
}

Definition at line 217 of file GBL_Reply_.hpp.

Referenced by CGBL_Reply_Base::SelectionName(), and CGBL_Reply_Base::ThrowInvalidSelection().

Modified on Tue Apr 23 07:39:47 2024 by modify_doxy.py rev. 669887