NCBI C++ ToolKit
|
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... | |
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 | |
}; | |
typedef CGBL_Data CGBL_Reply_Base::TData |
Definition at line 148 of file GBL_Reply_.hpp.
typedef string CGBL_Reply_Base::TError |
Definition at line 149 of file GBL_Reply_.hpp.
typedef int CGBL_Gene_Base::TGeneid |
Definition at line 86 of file GBL_Gene_.hpp.
typedef list< CRef< CGBL_Gene > > CGBL_Data_Base::TGenes |
Definition at line 91 of file GBL_Data_.hpp.
Definition at line 100 of file GBL_Data_.hpp.
Definition at line 95 of file GBL_Gene_.hpp.
|
private |
Definition at line 67 of file GBL_Data.hpp.
|
private |
Definition at line 78 of file GBL_Data_.hpp.
|
private |
Definition at line 67 of file GBL_Gene.hpp.
|
private |
Definition at line 75 of file GBL_Gene_.hpp.
|
private |
Definition at line 67 of file GBL_Reply.hpp.
|
private |
Definition at line 78 of file GBL_Reply_.hpp.
typedef int CGBL_Data_Base::TReturned |
Definition at line 90 of file GBL_Data_.hpp.
typedef string CGBL_Gene_Base::TSymbol |
Definition at line 87 of file GBL_Gene_.hpp.
typedef int CGBL_Data_Base::TTotal |
Definition at line 89 of file GBL_Data_.hpp.
Choice variants.
Enumerator | |
---|---|
e_not_set | No variant selected. |
e_Data | |
e_Error |
Definition at line 90 of file GBL_Reply_.hpp.
Maximum+1 value of the choice variant enumerator.
Enumerator | |
---|---|
e_MaxChoice | == e_Error+1 |
Definition at line 96 of file GBL_Reply_.hpp.
|
strong |
Enumerator | |
---|---|
e__allMandatory | |
e_total | |
e_returned | |
e_genes |
Definition at line 94 of file GBL_Data_.hpp.
|
strong |
Enumerator | |
---|---|
e__allMandatory | |
e_geneid | |
e_symbol |
Definition at line 90 of file GBL_Gene_.hpp.
|
inline |
Check if it is safe to call GetGeneid method.
Definition at line 208 of file GBL_Gene_.hpp.
References CGBL_Gene_Base::IsSetGeneid().
Referenced by CGBL_Gene_Base::GetGeneid().
|
inline |
Check if it is safe to call GetGenes method.
Definition at line 338 of file GBL_Data_.hpp.
Referenced by s_GetGeneWeight().
|
inline |
Check if it is safe to call GetReturned method.
Definition at line 291 of file GBL_Data_.hpp.
References CGBL_Data_Base::IsSetReturned().
Referenced by CGBL_Data_Base::GetReturned().
|
inline |
Check if it is safe to call GetSymbol method.
Definition at line 255 of file GBL_Gene_.hpp.
References CGBL_Gene_Base::IsSetSymbol().
Referenced by CGBL_Gene_Base::GetSymbol().
|
inline |
Check if it is safe to call GetTotal method.
Definition at line 244 of file GBL_Data_.hpp.
References CGBL_Data_Base::IsSetTotal().
Referenced by CGBL_Data_Base::GetTotal().
|
inline |
Definition at line 86 of file GBL_Data.hpp.
|
private |
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.
|
inline |
Definition at line 86 of file GBL_Gene.hpp.
|
private |
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.
|
private |
|
inline |
Definition at line 86 of file GBL_Reply.hpp.
|
private |
END_CHOICE_INFO CGBL_Reply_Base::CGBL_Reply_Base | ( | void | ) |
Definition at line 145 of file GBL_Reply_.cpp.
|
inline |
Verify selection, throw exception if it differs from the expected.
index | Expected 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().
CGBL_Data_Base::DECLARE_INTERNAL_TYPE_INFO | ( | ) |
CGBL_Gene_Base::DECLARE_INTERNAL_TYPE_INFO | ( | ) |
CGBL_Reply_Base::DECLARE_INTERNAL_TYPE_INFO | ( | ) |
|
private |
Definition at line 72 of file GBL_Reply_.cpp.
References CObject::AddReference(), CGBL_Reply_Base::e_Data, CGBL_Reply_Base::e_Error, CGBL_Reply_Base::m_choice, CGBL_Reply_Base::m_object, and CGBL_Reply_Base::m_string.
const CGBL_Reply_Base::TData & CGBL_Reply_Base::GetData | ( | void | ) | const |
Get the variant 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().
|
inline |
Get the variant 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().
|
inline |
Get the Geneid member data.
Definition at line 221 of file GBL_Gene_.hpp.
References CGBL_Gene_Base::CanGetGeneid(), CGBL_Gene_Base::m_Geneid, and CSerialObject::ThrowUnassigned().
|
inline |
Get the Genes member data.
Definition at line 344 of file GBL_Data_.hpp.
References CGBL_Data_Base::m_Genes.
Referenced by s_GetGeneWeight().
|
inline |
Get the Returned member data.
Definition at line 304 of file GBL_Data_.hpp.
References CGBL_Data_Base::CanGetReturned(), CGBL_Data_Base::m_Returned, and CSerialObject::ThrowUnassigned().
Referenced by s_GetGeneWeight().
|
inline |
Get the Symbol member data.
Definition at line 261 of file GBL_Gene_.hpp.
References CGBL_Gene_Base::CanGetSymbol(), CGBL_Gene_Base::m_Symbol, and CSerialObject::ThrowUnassigned().
|
inline |
Get the Total member data.
Definition at line 257 of file GBL_Data_.hpp.
References CGBL_Data_Base::CanGetTotal(), CGBL_Data_Base::m_Total, and CSerialObject::ThrowUnassigned().
|
inline |
Check if variant Data is selected.
Data type is defined as 'typedef CGBL_Data TData'.
Definition at line 264 of file GBL_Reply_.hpp.
References CGBL_Reply_Base::e_Data, and CGBL_Reply_Base::m_choice.
|
inline |
Check if variant Error is selected.
Error type is defined as 'typedef string TError'.
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().
|
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'
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().
|
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'
Definition at line 332 of file GBL_Data_.hpp.
References CGBL_Data_Base::m_set_State.
|
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'
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().
|
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'
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().
|
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'
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().
|
private |
|
private |
|
private |
|
private |
|
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().
|
virtual |
Reset the whole object.
Definition at line 56 of file GBL_Gene_.cpp.
References CGBL_Gene_Base::ResetGeneid(), and CGBL_Gene_Base::ResetSymbol().
|
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().
|
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().
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().
|
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().
|
virtual |
Reset the selection (set it to e_not_set).
Definition at line 57 of file GBL_Reply_.cpp.
References CGBL_Reply_Base::e_Data, CGBL_Reply_Base::e_Error, CGBL_Reply_Base::e_not_set, CGBL_Reply_Base::m_choice, CGBL_Reply_Base::m_object, and CGBL_Reply_Base::m_string.
Referenced by CGBL_Reply_Base::Reset(), and CGBL_Reply_Base::SetData().
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().
|
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().
void CGBL_Reply_Base::Select | ( | E_Choice | index, |
EResetVariant | reset, | ||
CObjectMemoryPool * | pool | ||
) |
Select the requested variant if needed, allocating CObject variants from memory pool.
void CGBL_Reply_Base::Select | ( | E_Choice | index, |
EResetVariant | reset = eDoResetVariant |
||
) |
Select the requested variant if needed.
index | New selection state. |
reset | Flag 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().
|
static |
Retrieve selection name (for diagnostic purposes).
index | One of possible selection states. |
Definition at line 93 of file GBL_Reply_.cpp.
References CGBL_Reply_Base::sm_SelectionNames.
void CGBL_Reply_Base::SetData | ( | CGBL_Reply_Base::TData & | value | ) |
Select the variant and set its data.
value | Reference 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 value.
CGBL_Reply_Base::TData & CGBL_Reply_Base::SetData | ( | void | ) |
Select the variant.
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().
Select the variant and set its data.
value | Variant 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 value.
|
inline |
Select the variant.
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().
|
inline |
Assign a value to Geneid data member.
value | Value to assign |
Definition at line 230 of file GBL_Gene_.hpp.
References CGBL_Gene_Base::m_Geneid, CGBL_Gene_Base::m_set_State, and value.
|
inline |
Assign a value to Geneid data member.
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().
|
inline |
Assign a value to Genes data member.
Definition at line 350 of file GBL_Data_.hpp.
References CGBL_Data_Base::m_Genes, and CGBL_Data_Base::m_set_State.
|
inline |
Assign a value to Returned data member.
value | Value to assign |
Definition at line 313 of file GBL_Data_.hpp.
References CGBL_Data_Base::m_Returned, CGBL_Data_Base::m_set_State, and value.
|
inline |
Assign a value to Returned data member.
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().
Assign a value to Symbol data member.
value | Value to assign |
Definition at line 270 of file GBL_Gene_.hpp.
References CGBL_Gene_Base::m_set_State, CGBL_Gene_Base::m_Symbol, and value.
|
inline |
Definition at line 277 of file GBL_Gene_.hpp.
References CGBL_Gene_Base::m_set_State, CGBL_Gene_Base::m_Symbol, and value.
|
inline |
Assign a value to Symbol data member.
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().
|
inline |
Assign a value to Total data member.
value | Value to assign |
Definition at line 266 of file GBL_Data_.hpp.
References CGBL_Data_Base::m_set_State, CGBL_Data_Base::m_Total, and value.
|
inline |
Assign a value to Total data member.
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().
void CGBL_Reply_Base::ThrowInvalidSelection | ( | E_Choice | index | ) | const |
Throw 'InvalidSelection' exception.
index | Expected 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().
|
inline |
Which variant is currently selected.
Definition at line 235 of file GBL_Reply_.hpp.
References CGBL_Reply_Base::m_choice.
CGBL_Data::~CGBL_Data | ( | void | ) |
Definition at line 50 of file GBL_Data.cpp.
|
virtual |
Definition at line 84 of file GBL_Data_.cpp.
CGBL_Gene::~CGBL_Gene | ( | void | ) |
Definition at line 50 of file GBL_Gene.cpp.
|
virtual |
Definition at line 81 of file GBL_Gene_.cpp.
CGBL_Reply::~CGBL_Reply | ( | void | ) |
Definition at line 50 of file GBL_Reply.cpp.
|
virtual |
Definition at line 151 of file GBL_Reply_.cpp.
References CGBL_Reply_Base::Reset().
union { ... } |
|
private |
Definition at line 213 of file GBL_Reply_.hpp.
Referenced by CGBL_Reply_Base::CheckSelected(), CGBL_Reply_Base::DoSelect(), CGBL_Reply_Base::IsData(), CGBL_Reply_Base::IsError(), CGBL_Reply_Base::Reset(), CGBL_Reply_Base::ResetSelection(), CGBL_Reply_Base::SetData(), CGBL_Reply_Base::ThrowInvalidSelection(), and CGBL_Reply_Base::Which().
|
private |
Definition at line 188 of file GBL_Gene_.hpp.
Referenced by CGBL_Gene_Base::GetGeneid(), CGBL_Gene_Base::ResetGeneid(), and CGBL_Gene_Base::SetGeneid().
Definition at line 225 of file GBL_Data_.hpp.
Referenced by CGBL_Data_Base::GetGenes(), CGBL_Data_Base::ResetGenes(), and CGBL_Data_Base::SetGenes().
NCBI_NS_NCBI::CSerialObject* { ... } ::m_object |
Definition at line 221 of file GBL_Reply_.hpp.
NCBI_NS_NCBI::CSerialObject* CGBL_Reply_Base::m_object |
Definition at line 221 of file GBL_Reply_.hpp.
Referenced by CGBL_Reply_Base::DoSelect(), CGBL_Reply_Base::GetData(), CGBL_Reply_Base::ResetSelection(), and CGBL_Reply_Base::SetData().
|
private |
Definition at line 224 of file GBL_Data_.hpp.
Referenced by CGBL_Data_Base::GetReturned(), CGBL_Data_Base::ResetReturned(), and CGBL_Data_Base::SetReturned().
|
private |
Definition at line 222 of file GBL_Data_.hpp.
Referenced by CGBL_Data_Base::CGBL_Data_Base(), CGBL_Data_Base::IsSetGenes(), CGBL_Data_Base::IsSetReturned(), CGBL_Data_Base::IsSetTotal(), CGBL_Data_Base::ResetGenes(), CGBL_Data_Base::ResetReturned(), CGBL_Data_Base::ResetTotal(), CGBL_Data_Base::SetGenes(), CGBL_Data_Base::SetReturned(), and CGBL_Data_Base::SetTotal().
|
private |
Definition at line 187 of file GBL_Gene_.hpp.
Referenced by CGBL_Gene_Base::CGBL_Gene_Base(), CGBL_Gene_Base::IsSetGeneid(), CGBL_Gene_Base::IsSetSymbol(), CGBL_Gene_Base::ResetGeneid(), CGBL_Gene_Base::ResetSymbol(), CGBL_Gene_Base::SetGeneid(), and CGBL_Gene_Base::SetSymbol().
NCBI_NS_NCBI::CUnionBuffer<NCBI_NS_STD::string> { ... } ::m_string |
Definition at line 220 of file GBL_Reply_.hpp.
NCBI_NS_NCBI::CUnionBuffer<NCBI_NS_STD::string> CGBL_Reply_Base::m_string |
Definition at line 220 of file GBL_Reply_.hpp.
Referenced by CGBL_Reply_Base::DoSelect(), CGBL_Reply_Base::GetError(), CGBL_Reply_Base::ResetSelection(), and CGBL_Reply_Base::SetError().
|
private |
Definition at line 189 of file GBL_Gene_.hpp.
Referenced by CGBL_Gene_Base::GetSymbol(), CGBL_Gene_Base::ResetSymbol(), and CGBL_Gene_Base::SetSymbol().
|
private |
Definition at line 223 of file GBL_Data_.hpp.
Referenced by CGBL_Data_Base::GetTotal(), CGBL_Data_Base::ResetTotal(), and CGBL_Data_Base::SetTotal().
Definition at line 217 of file GBL_Reply_.hpp.
Referenced by CGBL_Reply_Base::SelectionName(), and CGBL_Reply_Base::ThrowInvalidSelection().