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

Search Toolkit Book for CPSG_Request_Resolve

Request to the PSG server (by bio-id, for a biodata specific info and data) More...

#include <objtools/pubseq_gateway/client/psg_client.hpp>

+ Inheritance diagram for CPSG_Request_Resolve:
+ Collaboration diagram for CPSG_Request_Resolve:

Public Types

enum  EIncludeInfo : unsigned {
  fCanonicalId = (1 << 1) , fName = (1 << 2) , fOtherIds = (1 << 3) , fMoleculeType = (1 << 4) ,
  fLength = (1 << 5) , fChainState = (1 << 6) , fState = (1 << 7) , fBlobId = (1 << 8) ,
  fTaxId = (1 << 9) , fHash = (1 << 10) , fDateChanged = (1 << 11) , fGi = (1 << 12) ,
  fAllInfo = numeric_limits<unsigned>::max()
}
 Specify which info and data is needed Some processors may provide more than the flags prescribe Always check if corresponding data is actually available using CPSG_BioseqInfo::IncludedInfo() More...
 
- Public Types inherited from CPSG_Request
enum  EType {
  eBiodata , eResolve , eBlob , eNamedAnnotInfo ,
  eChunk , eIpgResolve
}
 
enum  EFlags { fExcludeHUP = (0 << 0) , fIncludeHUP = (1 << 0) , eDefaultFlags = fExcludeHUP }
 
using TOptionalFlags = CNullable< TFlags >
 

Public Member Functions

 CPSG_Request_Resolve (CPSG_BioId bio_id, EPSG_BioIdResolution bio_id_resolution, shared_ptr< void > user_context={}, CRef< CRequestContext > request_context={})
 
 CPSG_Request_Resolve (CPSG_BioId bio_id, shared_ptr< void > user_context={}, CRef< CRequestContext > request_context={})
 
const CPSG_BioIdGetBioId () const
 
EPSG_BioIdResolution GetBioIdResolution () const
 
 DECLARE_SAFE_FLAGS_TYPE (EIncludeInfo, TIncludeInfo)
 
void IncludeInfo (TIncludeInfo include)
 
TIncludeInfo GetIncludeInfo () const
 
void SetAccSubstitution (EPSG_AccSubstitution acc_substitution)
 Set substitution policy for version-less primary seq-ids. More...
 
- Public Member Functions inherited from CPSG_Request
 DECLARE_SAFE_FLAGS_TYPE (EFlags, TFlags)
 
template<typename TUserContext >
shared_ptr< TUserContext > GetUserContext () const
 Get the user-provided context. More...
 
CRef< CRequestContextGetRequestContext () const
 Get request context. More...
 
void SetRequestContext (CRef< CRequestContext > request_context)
 Set request context. More...
 
EType GetType () const
 Get request type. More...
 
string GetId () const
 
void SetFlags (TOptionalFlags flags)
 Set flags. More...
 
void SetUserArgs (SPSG_UserArgs user_args)
 Set arbitrary URL arguments to add to this request. More...
 

Private Member Functions

EType x_GetType () const override
 
string x_GetId () const override
 
void x_GetAbsPathRef (ostream &) const override
 

Private Attributes

CPSG_BioId m_BioId
 
EPSG_BioIdResolution m_BioIdResolution
 
TIncludeInfo m_IncludeInfo = TIncludeInfo(0)
 
EPSG_AccSubstitution m_AccSubstitution = EPSG_AccSubstitution::Default
 

Additional Inherited Members

- Protected Member Functions inherited from CPSG_Request
template<class T >
T GetCtx (T c)
 
 CPSG_Request (shared_ptr< void > user_context={}, CRef< CRequestContext > request_context={})
 
virtual ~CPSG_Request ()=default
 

Detailed Description

Request to the PSG server (by bio-id, for a biodata specific info and data)

Definition at line 391 of file psg_client.hpp.

Member Enumeration Documentation

◆ EIncludeInfo

Specify which info and data is needed Some processors may provide more than the flags prescribe Always check if corresponding data is actually available using CPSG_BioseqInfo::IncludedInfo()

See also
CPSG_BioseqInfo::IncludedInfo()
Enumerator
fCanonicalId 
fName 

Requests name to use for canonical bio-id.

fOtherIds 
fMoleculeType 
fLength 
fChainState 
fState 
fBlobId 
fTaxId 
fHash 
fDateChanged 
fGi 
fAllInfo 

Definition at line 420 of file psg_client.hpp.

Constructor & Destructor Documentation

◆ CPSG_Request_Resolve() [1/2]

CPSG_Request_Resolve::CPSG_Request_Resolve ( CPSG_BioId  bio_id,
EPSG_BioIdResolution  bio_id_resolution,
shared_ptr< void >  user_context = {},
CRef< CRequestContext request_context = {} 
)
inline
Parameters
bio_idID of the bioseq
bio_id_resolutionWhether to try to resolve using provided ID (or use it as-is)

Definition at line 398 of file psg_client.hpp.

◆ CPSG_Request_Resolve() [2/2]

CPSG_Request_Resolve::CPSG_Request_Resolve ( CPSG_BioId  bio_id,
shared_ptr< void >  user_context = {},
CRef< CRequestContext request_context = {} 
)
inline

Definition at line 407 of file psg_client.hpp.

Member Function Documentation

◆ DECLARE_SAFE_FLAGS_TYPE()

CPSG_Request_Resolve::DECLARE_SAFE_FLAGS_TYPE ( EIncludeInfo  ,
TIncludeInfo   
)

◆ GetBioId()

const CPSG_BioId& CPSG_Request_Resolve::GetBioId ( ) const
inline

Definition at line 413 of file psg_client.hpp.

References m_BioId.

Referenced by x_GetId().

◆ GetBioIdResolution()

EPSG_BioIdResolution CPSG_Request_Resolve::GetBioIdResolution ( ) const
inline

Definition at line 414 of file psg_client.hpp.

References m_BioIdResolution.

◆ GetIncludeInfo()

TIncludeInfo CPSG_Request_Resolve::GetIncludeInfo ( ) const
inline

Definition at line 439 of file psg_client.hpp.

References m_IncludeInfo.

◆ IncludeInfo()

void CPSG_Request_Resolve::IncludeInfo ( TIncludeInfo  include)
inline

Definition at line 437 of file psg_client.hpp.

References m_IncludeInfo.

◆ SetAccSubstitution()

void CPSG_Request_Resolve::SetAccSubstitution ( EPSG_AccSubstitution  acc_substitution)
inline

Set substitution policy for version-less primary seq-ids.

Definition at line 442 of file psg_client.hpp.

References m_AccSubstitution.

◆ x_GetAbsPathRef()

void CPSG_Request_Resolve::x_GetAbsPathRef ( ostream &  os) const
overrideprivatevirtual

◆ x_GetId()

string CPSG_Request_Resolve::x_GetId ( ) const
inlineoverrideprivatevirtual

Implements CPSG_Request.

Definition at line 446 of file psg_client.hpp.

References GetBioId(), and CPSG_BioId::Repr().

◆ x_GetType()

EType CPSG_Request_Resolve::x_GetType ( ) const
inlineoverrideprivatevirtual

Implements CPSG_Request.

Definition at line 445 of file psg_client.hpp.

References CPSG_Request::eResolve.

Member Data Documentation

◆ m_AccSubstitution

EPSG_AccSubstitution CPSG_Request_Resolve::m_AccSubstitution = EPSG_AccSubstitution::Default
private

Definition at line 452 of file psg_client.hpp.

Referenced by SetAccSubstitution().

◆ m_BioId

CPSG_BioId CPSG_Request_Resolve::m_BioId
private

Definition at line 449 of file psg_client.hpp.

Referenced by GetBioId().

◆ m_BioIdResolution

EPSG_BioIdResolution CPSG_Request_Resolve::m_BioIdResolution
private

Definition at line 450 of file psg_client.hpp.

Referenced by GetBioIdResolution().

◆ m_IncludeInfo

TIncludeInfo CPSG_Request_Resolve::m_IncludeInfo = TIncludeInfo(0)
private

Definition at line 451 of file psg_client.hpp.

Referenced by GetIncludeInfo(), and IncludeInfo().


The documentation for this class was generated from the following files:
Modified on Sat Apr 13 11:43:38 2024 by modify_doxy.py rev. 669887