NCBI C++ ToolKit
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes

Represents ASN.1 type Entrez2-get-links defined in file entrez2.asn

Search Toolkit Book for CEntrez2_get_links_Base

request links of one type More...

#include <objects/entrez2/Entrez2_get_links_.hpp>

+ Inheritance diagram for CEntrez2_get_links_Base:
+ Collaboration diagram for CEntrez2_get_links_Base:

List of all members.

Public Types

typedef CEntrez2_id_list TUids
typedef CEntrez2_link_id TLinktype
typedef int TMax_UIDS
typedef bool TCount_only
typedef bool TParents_persist

Public Member Functions

 CEntrez2_get_links_Base (void)
virtual ~CEntrez2_get_links_Base (void)
 DECLARE_INTERNAL_TYPE_INFO ()
bool IsSetUids (void) const
 docs to link from Check if a value has been assigned to Uids data member.
bool CanGetUids (void) const
 Check if it is safe to call GetUids method.
void ResetUids (void)
 Reset Uids data member.
const TUidsGetUids (void) const
 Get the Uids member data.
void SetUids (TUids &value)
 Assign a value to Uids data member.
TUidsSetUids (void)
 Assign a value to Uids data member.
bool IsSetLinktype (void) const
 type of link Check if a value has been assigned to Linktype data member.
bool CanGetLinktype (void) const
 Check if it is safe to call GetLinktype method.
void ResetLinktype (void)
 Reset Linktype data member.
const TLinktypeGetLinktype (void) const
 Get the Linktype member data.
void SetLinktype (const TLinktype &value)
 Assign a value to Linktype data member.
TLinktypeSetLinktype (void)
 Assign a value to Linktype data member.
bool IsSetMax_UIDS (void) const
 maximum number of links to return Check if a value has been assigned to Max_UIDS data member.
bool CanGetMax_UIDS (void) const
 Check if it is safe to call GetMax_UIDS method.
void ResetMax_UIDS (void)
 Reset Max_UIDS data member.
TMax_UIDS GetMax_UIDS (void) const
 Get the Max_UIDS member data.
void SetMax_UIDS (TMax_UIDS value)
 Assign a value to Max_UIDS data member.
TMax_UIDSSetMax_UIDS (void)
 Assign a value to Max_UIDS data member.
bool IsSetCount_only (void) const
 return only the counts Check if a value has been assigned to Count_only data member.
bool CanGetCount_only (void) const
 Check if it is safe to call GetCount_only method.
void ResetCount_only (void)
 Reset Count_only data member.
TCount_only GetCount_only (void) const
 Get the Count_only member data.
void SetCount_only (TCount_only value)
 Assign a value to Count_only data member.
TCount_onlySetCount_only (void)
 Assign a value to Count_only data member.
bool IsSetParents_persist (void) const
 allow original uids in list Check if a value has been assigned to Parents_persist data member.
bool CanGetParents_persist (void) const
 Check if it is safe to call GetParents_persist method.
void ResetParents_persist (void)
 Reset Parents_persist data member.
TParents_persist GetParents_persist (void) const
 Get the Parents_persist member data.
void SetParents_persist (TParents_persist value)
 Assign a value to Parents_persist data member.
TParents_persistSetParents_persist (void)
 Assign a value to Parents_persist data member.
virtual void Reset (void)
 Reset the whole object.

Private Types

typedef CSerialObject Tparent

Private Member Functions

 CEntrez2_get_links_Base (const CEntrez2_get_links_Base &)
CEntrez2_get_links_Baseoperator= (const CEntrez2_get_links_Base &)

Private Attributes

Uint4 m_set_State [1]
CRef< TUidsm_Uids
CEntrez2_link_id m_Linktype
int m_Max_UIDS
bool m_Count_only
bool m_Parents_persist

Detailed Description

request links of one type

CEntrez2_get_links_Base --

Definition at line 77 of file Entrez2_get_links_.hpp.


Member Typedef Documentation

Definition at line 93 of file Entrez2_get_links_.hpp.

Definition at line 91 of file Entrez2_get_links_.hpp.

Definition at line 92 of file Entrez2_get_links_.hpp.

Reimplemented in CEntrez2_get_links.

Definition at line 79 of file Entrez2_get_links_.hpp.

Definition at line 94 of file Entrez2_get_links_.hpp.

Definition at line 90 of file Entrez2_get_links_.hpp.


Constructor & Destructor Documentation

Definition at line 93 of file Entrez2_get_links_.cpp.

References CObject::IsAllocatedInPool(), m_set_State, and ResetUids().

Definition at line 103 of file Entrez2_get_links_.cpp.


Member Function Documentation

Check if it is safe to call GetCount_only method.

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

Definition at line 435 of file Entrez2_get_links_.hpp.

References IsSetCount_only().

Referenced by GetCount_only().

bool CEntrez2_get_links_Base::CanGetLinktype ( void  ) const [inline]

Check if it is safe to call GetLinktype method.

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

Definition at line 353 of file Entrez2_get_links_.hpp.

References IsSetLinktype().

Referenced by GetLinktype().

bool CEntrez2_get_links_Base::CanGetMax_UIDS ( void  ) const [inline]

Check if it is safe to call GetMax_UIDS method.

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

Definition at line 388 of file Entrez2_get_links_.hpp.

References IsSetMax_UIDS().

Referenced by GetMax_UIDS().

Check if it is safe to call GetParents_persist method.

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

Definition at line 482 of file Entrez2_get_links_.hpp.

References IsSetParents_persist().

Referenced by GetParents_persist().

bool CEntrez2_get_links_Base::CanGetUids ( void  ) const [inline]

Check if it is safe to call GetUids method.

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

Definition at line 323 of file Entrez2_get_links_.hpp.

Get the Count_only member data.

Returns:
Copy of the member data.

Definition at line 448 of file Entrez2_get_links_.hpp.

References CanGetCount_only(), m_Count_only, and CSerialObject::ThrowUnassigned().

Get the Linktype member data.

Returns:
Reference to the member data.

Definition at line 359 of file Entrez2_get_links_.hpp.

References CanGetLinktype(), m_Linktype, and CSerialObject::ThrowUnassigned().

Get the Max_UIDS member data.

Returns:
Copy of the member data.

Definition at line 401 of file Entrez2_get_links_.hpp.

References CanGetMax_UIDS(), m_Max_UIDS, and CSerialObject::ThrowUnassigned().

Get the Parents_persist member data.

Returns:
Copy of the member data.

Definition at line 495 of file Entrez2_get_links_.hpp.

References CanGetParents_persist(), m_Parents_persist, and CSerialObject::ThrowUnassigned().

Get the Uids member data.

Returns:
Reference to the member data.

Definition at line 329 of file Entrez2_get_links_.hpp.

References m_Uids, and ResetUids().

Referenced by CEntrez2Client::GetAffinity().

return only the counts Check if a value has been assigned to Count_only data member.

Data member Count_only is optional; its type is defined as 'typedef bool TCount_only'

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

Definition at line 429 of file Entrez2_get_links_.hpp.

References m_set_State.

Referenced by CanGetCount_only(), and SetCount_only().

bool CEntrez2_get_links_Base::IsSetLinktype ( void  ) const [inline]

type of link Check if a value has been assigned to Linktype data member.

Data member Linktype is mandatory; its type is defined as 'typedef CEntrez2_link_id TLinktype'

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

Definition at line 347 of file Entrez2_get_links_.hpp.

References m_set_State.

Referenced by CanGetLinktype().

bool CEntrez2_get_links_Base::IsSetMax_UIDS ( void  ) const [inline]

maximum number of links to return Check if a value has been assigned to Max_UIDS data member.

Data member Max_UIDS is optional; its type is defined as 'typedef int TMax_UIDS'

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

Definition at line 382 of file Entrez2_get_links_.hpp.

References m_set_State.

Referenced by CanGetMax_UIDS(), and SetMax_UIDS().

allow original uids in list Check if a value has been assigned to Parents_persist data member.

Data member Parents_persist is optional; its type is defined as 'typedef bool TParents_persist'

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

Definition at line 476 of file Entrez2_get_links_.hpp.

References m_set_State.

Referenced by CanGetParents_persist(), and SetParents_persist().

bool CEntrez2_get_links_Base::IsSetUids ( void  ) const [inline]

docs to link from Check if a value has been assigned to Uids data member.

Data member Uids is mandatory; its type is defined as 'typedef CEntrez2_id_list TUids'

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

Definition at line 317 of file Entrez2_get_links_.hpp.

References m_Uids, and CRef< C, Locker >::NotEmpty().

CEntrez2_get_links_Base& CEntrez2_get_links_Base::operator= ( const CEntrez2_get_links_Base ) [private]
void CEntrez2_get_links_Base::Reset ( void  ) [virtual]

Reset the whole object.

Definition at line 71 of file Entrez2_get_links_.cpp.

References ResetCount_only(), ResetLinktype(), ResetMax_UIDS(), ResetParents_persist(), and ResetUids().

void CEntrez2_get_links_Base::ResetCount_only ( void  ) [inline]

Reset Count_only data member.

Definition at line 441 of file Entrez2_get_links_.hpp.

References m_Count_only, and m_set_State.

Referenced by Reset().

Reset Linktype data member.

Definition at line 65 of file Entrez2_get_links_.cpp.

References m_Linktype, m_set_State, and CAliasBase< TPrim >::Set().

Referenced by Reset().

void CEntrez2_get_links_Base::ResetMax_UIDS ( void  ) [inline]

Reset Max_UIDS data member.

Definition at line 394 of file Entrez2_get_links_.hpp.

References m_Max_UIDS, and m_set_State.

Referenced by Reset().

Reset Parents_persist data member.

Definition at line 488 of file Entrez2_get_links_.hpp.

References m_Parents_persist, and m_set_State.

Referenced by Reset().

Reset Uids data member.

Definition at line 51 of file Entrez2_get_links_.cpp.

References m_Uids, and CRef< C, Locker >::Reset().

Referenced by CEntrez2_get_links_Base(), GetUids(), Reset(), and SetUids().

Assign a value to Count_only data member.

Parameters:
valueValue to assign

Definition at line 457 of file Entrez2_get_links_.hpp.

References m_Count_only, and m_set_State.

Assign a value to Count_only data member.

Returns:
Reference to the data value.

Definition at line 464 of file Entrez2_get_links_.hpp.

References IsSetCount_only(), m_Count_only, m_set_State, and CSerialObject::UnassignedByte().

Assign a value to Linktype data member.

Parameters:
valueValue to assign

Definition at line 368 of file Entrez2_get_links_.hpp.

References m_Linktype, and m_set_State.

Referenced by CEntrez2Client::GetNeighbors().

Assign a value to Linktype data member.

Returns:
Reference to the data value.

Definition at line 375 of file Entrez2_get_links_.hpp.

References m_Linktype, and m_set_State.

Assign a value to Max_UIDS data member.

Parameters:
valueValue to assign

Definition at line 410 of file Entrez2_get_links_.hpp.

References m_Max_UIDS, and m_set_State.

Assign a value to Max_UIDS data member.

Returns:
Reference to the data value.

Definition at line 417 of file Entrez2_get_links_.hpp.

References IsSetMax_UIDS(), m_Max_UIDS, m_set_State, and CSerialObject::UnassignedByte().

Assign a value to Parents_persist data member.

Parameters:
valueValue to assign

Definition at line 504 of file Entrez2_get_links_.hpp.

References m_Parents_persist, and m_set_State.

Assign a value to Parents_persist data member.

Returns:
Reference to the data value.

Definition at line 511 of file Entrez2_get_links_.hpp.

References IsSetParents_persist(), m_Parents_persist, m_set_State, and CSerialObject::UnassignedByte().

Assign a value to Uids data member.

Parameters:
valueReference to value.

Definition at line 60 of file Entrez2_get_links_.cpp.

References m_Uids, and CRef< C, Locker >::Reset().

Referenced by CEntrez2Client::GetNeighbors().

Assign a value to Uids data member.

Returns:
Reference to the data value.

Definition at line 338 of file Entrez2_get_links_.hpp.

References m_Uids, and ResetUids().


Member Data Documentation

Definition at line 303 of file Entrez2_get_links_.hpp.

Referenced by GetCount_only(), ResetCount_only(), and SetCount_only().

Definition at line 301 of file Entrez2_get_links_.hpp.

Referenced by GetLinktype(), ResetLinktype(), and SetLinktype().

Definition at line 302 of file Entrez2_get_links_.hpp.

Referenced by GetMax_UIDS(), ResetMax_UIDS(), and SetMax_UIDS().

Definition at line 300 of file Entrez2_get_links_.hpp.

Referenced by GetUids(), IsSetUids(), ResetUids(), and SetUids().


The documentation for this class was generated from the following files:
Modified on Wed Aug 27 17:36:42 2014 by modify_doxy.py rev. 426318