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

Search Toolkit Book for CPSG_Request_NamedAnnotInfo

Request meta-information for the named annotations which are defined on the bioseq. More...

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

+ Inheritance diagram for CPSG_Request_NamedAnnotInfo:
+ Collaboration diagram for CPSG_Request_NamedAnnotInfo:

Public Types

using TAnnotNames = vector< string >
 Names of the named annotations. More...
 
using EIncludeData = CPSG_Request_Biodata::EIncludeData
 Specify which data is needed (info is always returned) More...
 
using ESNPScaleLimit = objects::CSeq_id::ESNPScaleLimit
 Scale-limit parameter for SNP annotations. 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_NamedAnnotInfo (CPSG_BioIds bio_ids, TAnnotNames annot_names, EPSG_BioIdResolution bio_id_resolution, shared_ptr< void > user_context={}, CRef< CRequestContext > request_context={})
 
 CPSG_Request_NamedAnnotInfo (CPSG_BioIds bio_ids, TAnnotNames annot_names, shared_ptr< void > user_context={}, CRef< CRequestContext > request_context={})
 
template<class... TArgs>
 CPSG_Request_NamedAnnotInfo (CPSG_BioId bio_id, TArgs &&... args)
 
const CPSG_BioIdGetBioId () const
 
const CPSG_BioIdsGetBioIds () const
 
const TAnnotNamesGetAnnotNames () const
 
EPSG_BioIdResolution GetBioIdResolution () const
 
void SetAccSubstitution (EPSG_AccSubstitution acc_substitution)
 Set substitution policy for version-less primary seq-ids. More...
 
void IncludeData (EIncludeData include)
 
EIncludeData GetIncludeData () const
 
void SetSNPScaleLimit (ESNPScaleLimit snp_scale_limit)
 
ESNPScaleLimit GetSNPScaleLimit () const
 
- 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_BioIds m_BioIds
 
TAnnotNames m_AnnotNames
 
EPSG_BioIdResolution m_BioIdResolution
 
EPSG_AccSubstitution m_AccSubstitution = EPSG_AccSubstitution::Default
 
EIncludeData m_IncludeData = EIncludeData::eDefault
 
ESNPScaleLimit m_SNPScaleLimit = ESNPScaleLimit::eSNPScaleLimit_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 meta-information for the named annotations which are defined on the bioseq.

Definition at line 494 of file psg_client.hpp.

Member Typedef Documentation

◆ EIncludeData

Specify which data is needed (info is always returned)

Definition at line 544 of file psg_client.hpp.

◆ ESNPScaleLimit

using CPSG_Request_NamedAnnotInfo::ESNPScaleLimit = objects::CSeq_id::ESNPScaleLimit

Scale-limit parameter for SNP annotations.

Definition at line 550 of file psg_client.hpp.

◆ TAnnotNames

Names of the named annotations.

Definition at line 498 of file psg_client.hpp.

Constructor & Destructor Documentation

◆ CPSG_Request_NamedAnnotInfo() [1/3]

CPSG_Request_NamedAnnotInfo::CPSG_Request_NamedAnnotInfo ( CPSG_BioIds  bio_ids,
TAnnotNames  annot_names,
EPSG_BioIdResolution  bio_id_resolution,
shared_ptr< void >  user_context = {},
CRef< CRequestContext request_context = {} 
)
inline
Parameters
bio_idsIDs (aliases) of the bioseq
annot_namesList of NAs for which to request the metainfo
bio_id_resolutionWhether to try to resolve using provided IDs (or use them as-is)

Definition at line 506 of file psg_client.hpp.

◆ CPSG_Request_NamedAnnotInfo() [2/3]

CPSG_Request_NamedAnnotInfo::CPSG_Request_NamedAnnotInfo ( CPSG_BioIds  bio_ids,
TAnnotNames  annot_names,
shared_ptr< void >  user_context = {},
CRef< CRequestContext request_context = {} 
)
inline

Definition at line 521 of file psg_client.hpp.

◆ CPSG_Request_NamedAnnotInfo() [3/3]

template<class... TArgs>
CPSG_Request_NamedAnnotInfo::CPSG_Request_NamedAnnotInfo ( CPSG_BioId  bio_id,
TArgs &&...  args 
)
inline
Parameters
bio_idID of the bioseq

Definition at line 531 of file psg_client.hpp.

Member Function Documentation

◆ GetAnnotNames()

const TAnnotNames& CPSG_Request_NamedAnnotInfo::GetAnnotNames ( void  ) const
inline

Definition at line 537 of file psg_client.hpp.

References m_AnnotNames.

◆ GetBioId()

const CPSG_BioId& CPSG_Request_NamedAnnotInfo::GetBioId ( ) const
inline

Definition at line 535 of file psg_client.hpp.

References m_BioIds.

Referenced by x_GetId().

◆ GetBioIdResolution()

EPSG_BioIdResolution CPSG_Request_NamedAnnotInfo::GetBioIdResolution ( ) const
inline

Definition at line 538 of file psg_client.hpp.

References m_BioIdResolution.

◆ GetBioIds()

const CPSG_BioIds& CPSG_Request_NamedAnnotInfo::GetBioIds ( ) const
inline

Definition at line 536 of file psg_client.hpp.

References m_BioIds.

◆ GetIncludeData()

EIncludeData CPSG_Request_NamedAnnotInfo::GetIncludeData ( ) const
inline

Definition at line 547 of file psg_client.hpp.

References m_IncludeData.

◆ GetSNPScaleLimit()

ESNPScaleLimit CPSG_Request_NamedAnnotInfo::GetSNPScaleLimit ( ) const
inline

Definition at line 552 of file psg_client.hpp.

References m_SNPScaleLimit.

◆ IncludeData()

void CPSG_Request_NamedAnnotInfo::IncludeData ( EIncludeData  include)
inline

Definition at line 545 of file psg_client.hpp.

References m_IncludeData.

◆ SetAccSubstitution()

void CPSG_Request_NamedAnnotInfo::SetAccSubstitution ( EPSG_AccSubstitution  acc_substitution)
inline

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

Definition at line 541 of file psg_client.hpp.

References m_AccSubstitution.

◆ SetSNPScaleLimit()

void CPSG_Request_NamedAnnotInfo::SetSNPScaleLimit ( ESNPScaleLimit  snp_scale_limit)
inline

Definition at line 551 of file psg_client.hpp.

References m_SNPScaleLimit.

◆ x_GetAbsPathRef()

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

◆ x_GetId()

string CPSG_Request_NamedAnnotInfo::x_GetId ( ) const
inlineoverrideprivatevirtual

Implements CPSG_Request.

Definition at line 556 of file psg_client.hpp.

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

◆ x_GetType()

EType CPSG_Request_NamedAnnotInfo::x_GetType ( ) const
inlineoverrideprivatevirtual

Implements CPSG_Request.

Definition at line 555 of file psg_client.hpp.

References CPSG_Request::eNamedAnnotInfo.

Member Data Documentation

◆ m_AccSubstitution

EPSG_AccSubstitution CPSG_Request_NamedAnnotInfo::m_AccSubstitution = EPSG_AccSubstitution::Default
private

Definition at line 562 of file psg_client.hpp.

Referenced by SetAccSubstitution().

◆ m_AnnotNames

TAnnotNames CPSG_Request_NamedAnnotInfo::m_AnnotNames
private

Definition at line 560 of file psg_client.hpp.

Referenced by GetAnnotNames().

◆ m_BioIdResolution

EPSG_BioIdResolution CPSG_Request_NamedAnnotInfo::m_BioIdResolution
private

Definition at line 561 of file psg_client.hpp.

Referenced by GetBioIdResolution().

◆ m_BioIds

CPSG_BioIds CPSG_Request_NamedAnnotInfo::m_BioIds
private

Definition at line 559 of file psg_client.hpp.

Referenced by GetBioId(), and GetBioIds().

◆ m_IncludeData

EIncludeData CPSG_Request_NamedAnnotInfo::m_IncludeData = EIncludeData::eDefault
private

Definition at line 563 of file psg_client.hpp.

Referenced by GetIncludeData(), and IncludeData().

◆ m_SNPScaleLimit

ESNPScaleLimit CPSG_Request_NamedAnnotInfo::m_SNPScaleLimit = ESNPScaleLimit::eSNPScaleLimit_Default
private

Definition at line 564 of file psg_client.hpp.

Referenced by GetSNPScaleLimit(), and SetSNPScaleLimit().


The documentation for this class was generated from the following files:
Modified on Sun Apr 14 05:27:04 2024 by modify_doxy.py rev. 669887