NCBI C++ ToolKit
|
Classes | |
class | CDocSum_Base |
CDocSum_Base –. More... | |
class | CESummaryResult |
CESummaryResult –. More... | |
class | CESummaryResult_Base |
CESummaryResult_Base –. More... | |
class | CESummaryResult_Base::C_Data |
C_Data –. More... | |
class | CItem_Base |
======================================================================================= More... | |
class | CItem_Base::C_Attlist |
C_Attlist –. More... | |
class | CItem_Base::C_E_Item |
typedef C_E_Item CItem_Base::C_E |
typedef C_Attlist CItem_Base::TAttlist |
typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< C_Data > > CESummaryResult_Base::Tdata |
Definition at line 241 of file ESummaryResult_.hpp.
Definition at line 164 of file ESummaryResult_.hpp.
Definition at line 165 of file ESummaryResult_.hpp.
typedef NCBI_NS_STD::string CDocSum_Base::TId |
Definition at line 88 of file DocSum_.hpp.
typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CItem > > CDocSum_Base::TItem |
Definition at line 89 of file DocSum_.hpp.
typedef CItem CItem_Base::C_E_Item::TItem |
typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< C_E_Item > > CItem_Base::TItem |
typedef Tparent::CMemberIndex<E_memberIndex, 3> CDocSum_Base::TmemberIndex |
Definition at line 97 of file DocSum_.hpp.
typedef Tparent::CMemberIndex<E_memberIndex, 3> CItem_Base::C_Attlist::TmemberIndex |
typedef Tparent::CMemberIndex<E_memberIndex, 3> CItem_Base::TmemberIndex |
|
private |
Definition at line 77 of file DocSum_.hpp.
|
private |
Definition at line 65 of file ESummaryResult.hpp.
|
private |
Definition at line 77 of file ESummaryResult_.hpp.
|
private |
Definition at line 94 of file ESummaryResult_.hpp.
|
private |
|
private |
|
private |
Choice variants.
Enumerator | |
---|---|
e_not_set | No variant selected. |
e_DocSum | |
e_ERROR | .+ |
Definition at line 106 of file ESummaryResult_.hpp.
Maximum+1 value of the choice variant enumerator.
Enumerator | |
---|---|
e_MaxChoice | == e_ERROR+1 |
Definition at line 112 of file ESummaryResult_.hpp.
|
strong |
Enumerator | |
---|---|
e__allMandatory | |
e_Id | |
e_Item |
Definition at line 92 of file DocSum_.hpp.
|
strong |
|
strong |
END_CLASS_INFO CItem_Base::C_Attlist::C_Attlist | ( | void | ) |
Definition at line 89 of file Item_.cpp.
References CItem_Base::C_Attlist::m_set_State.
END_CHOICE_INFO CESummaryResult_Base::C_Data::C_Data | ( | void | ) |
Definition at line 144 of file ESummaryResult_.cpp.
END_CHOICE_INFO CItem_Base::C_E_Item::C_E_Item | ( | void | ) |
|
inline |
Check if it is safe to call Get method.
Definition at line 365 of file ESummaryResult_.hpp.
|
inline |
|
inline |
Check if it is safe to call GetId method.
Definition at line 204 of file DocSum_.hpp.
References CDocSum_Base::IsSetId().
Referenced by CDocSum_Base::GetId().
|
inline |
Check if it is safe to call GetItem method.
Definition at line 251 of file DocSum_.hpp.
bool CItem_Base::CanGetItem | ( | void | ) | const |
Check if it is safe to call GetItem method.
|
inline |
|
inline |
|
private |
END_CLASS_INFO CDocSum_Base::CDocSum_Base | ( | void | ) |
Definition at line 79 of file DocSum_.cpp.
References CDocSum_Base::m_set_State.
|
private |
|
inline |
Definition at line 84 of file ESummaryResult.hpp.
|
private |
END_CLASS_INFO CESummaryResult_Base::CESummaryResult_Base | ( | void | ) |
Definition at line 173 of file ESummaryResult_.cpp.
References CESummaryResult_Base::m_set_State.
|
inline |
Verify selection, throw exception if it differs from the expected.
index | Expected selection. |
Definition at line 310 of file ESummaryResult_.hpp.
|
inline |
|
private |
CItem_Base::CItem_Base | ( | void | ) |
CDocSum_Base::DECLARE_INTERNAL_TYPE_INFO | ( | ) |
CESummaryResult_Base::DECLARE_INTERNAL_TYPE_INFO | ( | ) |
CESummaryResult_Base::C_Data::DECLARE_INTERNAL_TYPE_INFO | ( | ) |
CItem_Base::DECLARE_INTERNAL_TYPE_INFO | ( | ) |
CItem_Base::C_Attlist::DECLARE_INTERNAL_TYPE_INFO | ( | ) |
CItem_Base::C_E_Item::DECLARE_INTERNAL_TYPE_INFO | ( | ) |
|
private |
Definition at line 70 of file ESummaryResult_.cpp.
|
private |
|
static |
Access to EAttlist_Type's attributes (values, names) as defined in spec.
|
inline |
Get the member data.
Definition at line 371 of file ESummaryResult_.hpp.
References CESummaryResult_Base::m_data.
|
inline |
Get the variant data.
Definition at line 616 of file Item_.hpp.
Referenced by CItem::GetValue().
|
inline |
Get the Attlist member data.
Definition at line 648 of file Item_.hpp.
References CItem_Base::m_Attlist, and CItem_Base::ResetAttlist().
Referenced by CItem::GetName().
const CESummaryResult_Base::C_Data::TDocSum & CESummaryResult_Base::C_Data::GetDocSum | ( | void | ) | const |
Get the variant data.
Definition at line 101 of file ESummaryResult_.cpp.
|
inline |
Get the variant data.
Definition at line 345 of file ESummaryResult_.hpp.
|
inline |
Get the Id member data.
Definition at line 210 of file DocSum_.hpp.
References CDocSum_Base::CanGetId(), and CDocSum_Base::m_Id.
|
inline |
Get the Item member data.
Definition at line 257 of file DocSum_.hpp.
References CDocSum_Base::m_Item.
Referenced by CDocSum::FindItem(), and CDocSum::FindValue().
const CItem_Base::C_E_Item::TItem & CItem_Base::C_E_Item::GetItem | ( | void | ) | const |
Get the variant data.
Definition at line 159 of file Item_.cpp.
Referenced by CItem::FindItem(), and CItem::FindValue().
|
inline |
Get the Item member data.
Definition at line 678 of file Item_.hpp.
References CItem_Base::m_Item.
Referenced by CItem::FindItem(), CItem::FindValue(), and CItem::GetValue().
|
inline |
|
inline |
|
inline |
Check if variant _CharData is selected.
_CharData type is defined as 'typedef NCBI_NS_STD::string T_CharData'.
Definition at line 610 of file Item_.hpp.
Referenced by CItem::GetValue().
|
inline |
Check if variant DocSum is selected.
DocSum type is defined as 'typedef CDocSum TDocSum'.
Definition at line 333 of file ESummaryResult_.hpp.
|
inline |
Check if variant ERROR is selected.
ERROR type is defined as 'typedef NCBI_NS_STD::string TERROR'.
Definition at line 339 of file ESummaryResult_.hpp.
|
inline |
Check if variant Item is selected.
Item type is defined as 'typedef CItem TItem'.
Definition at line 630 of file Item_.hpp.
Referenced by CItem::FindItem(), and CItem::FindValue().
|
inline |
Check if a value has been assigned to data member.
Data member is mandatory; its type is defined as 'typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< C_Data > > Tdata'
Definition at line 359 of file ESummaryResult_.hpp.
References CESummaryResult_Base::m_set_State.
|
inline |
Check if a value has been assigned to Attlist data member.
Data member Attlist is mandatory; its type is defined as 'typedef C_Attlist TAttlist'
Definition at line 636 of file Item_.hpp.
References CItem_Base::m_Attlist.
|
inline |
\d+ Check if a value has been assigned to Id data member.
Data member Id is mandatory; its type is defined as 'typedef NCBI_NS_STD::string TId'
Definition at line 198 of file DocSum_.hpp.
References CDocSum_Base::m_set_State.
Referenced by CDocSum_Base::CanGetId(), and CDocSum_Base::SetId().
|
inline |
+ Check if a value has been assigned to Item data member.
Data member Item is mandatory; its type is defined as 'typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CItem > > TItem'
Definition at line 245 of file DocSum_.hpp.
References CDocSum_Base::m_set_State.
bool CItem_Base::IsSetItem | ( | void | ) | const |
Check if a value has been assigned to Item data member.
Data member Item is optional; its type is defined as 'typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< C_E_Item > > TItem'
|
inline |
Check if a value has been assigned to Name data member.
Data member Name is mandatory; its type is defined as 'typedef NCBI_NS_STD::string TName'
Definition at line 487 of file Item_.hpp.
References CItem_Base::C_Attlist::m_set_State.
|
inline |
Check if a value has been assigned to Type data member.
Data member Type is mandatory; its type is defined as 'typedef EAttlist_Type TType'
Definition at line 534 of file Item_.hpp.
References CItem_Base::m_set_State.
|
inline |
Conversion operator to 'const Tdata' type.
Definition at line 384 of file ESummaryResult_.hpp.
References CESummaryResult_Base::m_data.
|
inline |
Conversion operator to 'Tdata' type.
Definition at line 390 of file ESummaryResult_.hpp.
References CESummaryResult_Base::m_data, and CESummaryResult_Base::m_set_State.
|
private |
|
private |
|
private |
|
private |
|
virtual |
Reset the whole object.
Definition at line 61 of file DocSum_.cpp.
References CDocSum_Base::ResetId(), and CDocSum_Base::ResetItem().
BEGIN_esummary_SCOPE void CESummaryResult_Base::C_Data::Reset | ( | void | ) |
Reset the whole object.
Definition at line 49 of file ESummaryResult_.cpp.
References CESummaryResult_Base::C_Data::e_not_set, CESummaryResult_Base::C_Data::m_choice, and CESummaryResult_Base::C_Data::ResetSelection().
void CESummaryResult_Base::Reset | ( | void | ) |
Reset data member.
Definition at line 156 of file ESummaryResult_.cpp.
References CESummaryResult_Base::m_data, and CESummaryResult_Base::m_set_State.
Referenced by CESummaryResult_Base::C_Data::~C_Data().
void CItem_Base::C_Attlist::Reset | ( | void | ) |
void CItem_Base::C_E_Item::Reset | ( | void | ) |
|
virtual |
Reset the whole object.
Reimplemented from CSimpleItemType_Base.
void CItem_Base::ResetAttlist | ( | void | ) |
Reset Attlist data member.
Definition at line 208 of file Item_.cpp.
References CItem_Base::m_Attlist.
Referenced by CItem_Base::GetAttlist(), and CItem_Base::SetAttlist().
BEGIN_esummary_SCOPE void CDocSum_Base::ResetId | ( | void | ) |
Reset Id data member.
Definition at line 49 of file DocSum_.cpp.
References CDocSum_Base::m_Id, and CDocSum_Base::m_set_State.
Referenced by CDocSum_Base::Reset().
void CDocSum_Base::ResetItem | ( | void | ) |
Reset Item data member.
Definition at line 55 of file DocSum_.cpp.
References CDocSum_Base::m_Item, and CDocSum_Base::m_set_State.
Referenced by CDocSum_Base::Reset().
void CItem_Base::ResetItem | ( | void | ) |
Reset Item data member.
END_ENUM_INFO void CItem_Base::C_Attlist::ResetName | ( | void | ) |
Reset Name data member.
Definition at line 64 of file Item_.cpp.
References CItem_Base::C_Attlist::m_Name, and CItem_Base::C_Attlist::m_set_State.
void CESummaryResult_Base::C_Data::ResetSelection | ( | void | ) |
Reset the selection (set it to e_not_set).
Definition at line 55 of file ESummaryResult_.cpp.
References e_not_set.
Referenced by CESummaryResult_Base::C_Data::Reset().
void CItem_Base::C_E_Item::ResetSelection | ( | void | ) |
|
inline |
Reset Type data member.
Definition at line 546 of file Item_.hpp.
References CItem_Base::m_set_State.
|
inline |
Select the requested variant if needed, allocating CObject variants from memory pool.
Definition at line 317 of file ESummaryResult_.hpp.
References e_not_set, and eDoResetVariant.
|
inline |
Select the requested variant if needed, allocating CObject variants from memory pool.
Definition at line 594 of file Item_.hpp.
References e_not_set, and eDoResetVariant.
|
inline |
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. |
Definition at line 327 of file ESummaryResult_.hpp.
|
inline |
|
static |
Retrieve selection name (for diagnostic purposes).
index | One of possible selection states. |
Definition at line 91 of file ESummaryResult_.cpp.
|
static |
|
inline |
Assign a value to data member.
Definition at line 377 of file ESummaryResult_.hpp.
References CESummaryResult_Base::m_data, and CESummaryResult_Base::m_set_State.
void CItem_Base::C_E_Item::Set_CharData | ( | const T_CharData & | value | ) |
Select the variant and set its data.
value | Variant data. |
Definition at line 153 of file Item_.cpp.
References eDoNotResetVariant, and value.
|
inline |
Select the variant.
Definition at line 623 of file Item_.hpp.
References eDoNotResetVariant.
void CItem_Base::SetAttlist | ( | TAttlist & | value | ) |
Assign a value to Attlist data member.
value | Reference to value. |
|
inline |
Assign a value to Attlist data member.
Definition at line 657 of file Item_.hpp.
References CItem_Base::m_Attlist, and CItem_Base::ResetAttlist().
void CESummaryResult_Base::C_Data::SetDocSum | ( | TDocSum & | value | ) |
Select the variant and set its data.
value | Reference to the data. |
Definition at line 113 of file ESummaryResult_.cpp.
References value.
CESummaryResult_Base::C_Data::TDocSum & CESummaryResult_Base::C_Data::SetDocSum | ( | void | ) |
Select the variant.
Definition at line 107 of file ESummaryResult_.cpp.
References eDoNotResetVariant.
Select the variant and set its data.
value | Variant data. |
Definition at line 123 of file ESummaryResult_.cpp.
References eDoNotResetVariant, and value.
|
inline |
Select the variant.
Definition at line 352 of file ESummaryResult_.hpp.
References eDoNotResetVariant.
Assign a value to Id data member.
value | Value to assign |
Definition at line 219 of file DocSum_.hpp.
References CDocSum_Base::m_Id, CDocSum_Base::m_set_State, and value.
|
inline |
Definition at line 226 of file DocSum_.hpp.
References CDocSum_Base::m_Id, CDocSum_Base::m_set_State, and value.
|
inline |
Assign a value to Id data member.
Definition at line 233 of file DocSum_.hpp.
References CDocSum_Base::IsSetId(), CDocSum_Base::m_Id, and CDocSum_Base::m_set_State.
void CItem_Base::C_E_Item::SetItem | ( | TItem & | value | ) |
|
inline |
Assign a value to Item data member.
Definition at line 263 of file DocSum_.hpp.
References CDocSum_Base::m_Item, and CDocSum_Base::m_set_State.
CItem_Base::C_E_Item::TItem & CItem_Base::C_E_Item::SetItem | ( | void | ) |
Select the variant.
Definition at line 165 of file Item_.cpp.
References eDoNotResetVariant.
TItem& CItem_Base::SetItem | ( | void | ) |
Assign a value to Item data member.
Assign a value to Name data member.
value | Value to assign |
Definition at line 508 of file Item_.hpp.
References CItem_Base::m_set_State, and value.
|
inline |
Definition at line 515 of file Item_.hpp.
References CItem_Base::m_set_State, and value.
|
inline |
Assign a value to Name data member.
Definition at line 522 of file Item_.hpp.
References CItem_Base::m_set_State.
|
inline |
Assign a value to Type data member.
value | Value to assign |
Definition at line 562 of file Item_.hpp.
References CItem_Base::m_set_State, and value.
|
inline |
Assign a value to Type data member.
Definition at line 569 of file Item_.hpp.
References CItem_Base::m_set_State.
void CESummaryResult_Base::C_Data::ThrowInvalidSelection | ( | E_Choice | index | ) | const |
Throw 'InvalidSelection' exception.
index | Expected selection. |
Definition at line 96 of file ESummaryResult_.cpp.
References DIAG_COMPILE_INFO.
void CItem_Base::C_E_Item::ThrowInvalidSelection | ( | E_Choice | index | ) | const |
Throw 'InvalidSelection' exception.
index | Expected selection. |
Definition at line 148 of file Item_.cpp.
References DIAG_COMPILE_INFO.
|
inline |
Which variant is currently selected.
Definition at line 304 of file ESummaryResult_.hpp.
References CESummaryResult_Base::C_Data::m_choice.
|
inline |
CESummaryResult_Base::C_Data::~C_Data | ( | void | ) |
Definition at line 150 of file ESummaryResult_.cpp.
References CESummaryResult_Base::Reset().
CItem_Base::C_E_Item::~C_E_Item | ( | void | ) |
Definition at line 202 of file Item_.cpp.
References CItem_Base::Reset().
|
virtual |
Definition at line 85 of file DocSum_.cpp.
BEGIN_esummary_SCOPE CESummaryResult::~CESummaryResult | ( | void | ) |
Definition at line 48 of file ESummaryResult.cpp.
|
virtual |
Definition at line 179 of file ESummaryResult_.cpp.
|
virtual |
union { ... } |
union { ... } |
|
private |
Definition at line 473 of file Item_.hpp.
Referenced by BEGIN_NAMED_BASE_CLASS_INFO(), CItem_Base::GetAttlist(), CItem_Base::IsSetAttlist(), CItem_Base::ResetAttlist(), and CItem_Base::SetAttlist().
|
private |
Definition at line 229 of file ESummaryResult_.hpp.
Referenced by CESummaryResult_Base::C_Data::Reset(), and CESummaryResult_Base::C_Data::Which().
|
private |
Definition at line 291 of file ESummaryResult_.hpp.
Referenced by BEGIN_NAMED_BASE_IMPLICIT_CLASS_INFO(), CESummaryResult_Base::Get(), CESummaryResult_Base::operator const Tdata &(), CESummaryResult_Base::operator Tdata &(), CESummaryResult_Base::Reset(), and CESummaryResult_Base::Set().
|
private |
Definition at line 184 of file DocSum_.hpp.
Referenced by CDocSum_Base::GetId(), CDocSum_Base::ResetId(), and CDocSum_Base::SetId().
|
private |
Definition at line 185 of file DocSum_.hpp.
Referenced by CDocSum_Base::GetItem(), CDocSum_Base::ResetItem(), and CDocSum_Base::SetItem().
|
private |
Definition at line 474 of file Item_.hpp.
Referenced by BEGIN_NAMED_BASE_CLASS_INFO(), and CItem_Base::GetItem().
|
private |
Definition at line 221 of file Item_.hpp.
Referenced by CItem_Base::C_Attlist::ResetName().
NCBI_NS_NCBI::CSerialObject* CESummaryResult_Base::C_Data::m_object |
Definition at line 237 of file ESummaryResult_.hpp.
NCBI_NS_NCBI::CSerialObject* { ... } ::m_object |
Definition at line 237 of file ESummaryResult_.hpp.
NCBI_NS_NCBI::CSerialObject* CItem_Base::C_E_Item::m_object |
|
private |
Definition at line 183 of file DocSum_.hpp.
Referenced by CDocSum_Base::CDocSum_Base(), CDocSum_Base::IsSetId(), CDocSum_Base::IsSetItem(), CDocSum_Base::ResetId(), CDocSum_Base::ResetItem(), CDocSum_Base::SetId(), and CDocSum_Base::SetItem().
|
private |
Definition at line 290 of file ESummaryResult_.hpp.
Referenced by BEGIN_NAMED_BASE_IMPLICIT_CLASS_INFO(), CESummaryResult_Base::CESummaryResult_Base(), CESummaryResult_Base::IsSet(), CESummaryResult_Base::operator Tdata &(), CESummaryResult_Base::Reset(), and CESummaryResult_Base::Set().
|
private |
Definition at line 220 of file Item_.hpp.
Referenced by CItem_Base::C_Attlist::C_Attlist(), CItem_Base::C_Attlist::IsSetName(), and CItem_Base::C_Attlist::ResetName().
NCBI_NS_NCBI::CUnionBuffer<NCBI_NS_STD::string> CESummaryResult_Base::C_Data::m_string |
Definition at line 236 of file ESummaryResult_.hpp.
NCBI_NS_NCBI::CUnionBuffer<NCBI_NS_STD::string> { ... } ::m_string |
Definition at line 236 of file ESummaryResult_.hpp.
NCBI_NS_NCBI::CUnionBuffer<NCBI_NS_STD::string> { ... } ::m_string |
NCBI_NS_NCBI::CUnionBuffer<NCBI_NS_STD::string> CItem_Base::C_E_Item::m_string |
|
private |
Definition at line 233 of file ESummaryResult_.hpp.