NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
SPSGS_ResolveRequest Struct Reference

Search Toolkit Book for SPSGS_ResolveRequest

#include "psgs_request.hpp"
(Private to src/app/pubseq_gateway/server.)

+ Inheritance diagram for SPSGS_ResolveRequest:
+ Collaboration diagram for SPSGS_ResolveRequest:

Public Types

enum  EPSGS_OutputFormat { ePSGS_ProtobufFormat , ePSGS_JsonFormat , ePSGS_NativeFormat , ePSGS_UnknownFormat }
 
enum  EPSGS_BioseqIncludeData {
  fPSGS_CanonicalId = (1 << 1) , fPSGS_SeqIds = (1 << 2) , fPSGS_MoleculeType = (1 << 3) , fPSGS_Length = (1 << 4) ,
  fPSGS_State = (1 << 5) , fPSGS_BlobId = (1 << 6) , fPSGS_TaxId = (1 << 7) , fPSGS_Hash = (1 << 8) ,
  fPSGS_DateChanged = (1 << 9) , fPSGS_Gi = (1 << 10) , fPSGS_Name = (1 << 11) , fPSGS_SeqState = (1 << 12) ,
  fPSGS_AllBioseqFields , fPSGS_BioseqKeyFields = fPSGS_CanonicalId | fPSGS_Gi
}
 
typedef int TPSGS_BioseqIncludeData
 
- Public Types inherited from SPSGS_RequestBase
enum  EPSGS_CacheAndDbUse { ePSGS_CacheOnly , ePSGS_DbOnly , ePSGS_CacheAndDb , ePSGS_UnknownUseCache }
 
enum  EPSGS_AccSubstitutioOption { ePSGS_DefaultAccSubstitution , ePSGS_LimitedAccSubstitution , ePSGS_NeverAccSubstitute , ePSGS_UnknownAccSubstitution }
 
enum  EPSGS_Trace { ePSGS_NoTracing , ePSGS_WithTracing }
 

Public Member Functions

 SPSGS_ResolveRequest (const string &seq_id, int seq_id_type, TPSGS_BioseqIncludeData include_data_flags, EPSGS_OutputFormat output_format, EPSGS_CacheAndDbUse use_cache, EPSGS_AccSubstitutioOption subst_option, bool seq_id_resolve, int hops, EPSGS_Trace trace, bool processor_events, const vector< string > &enabled_processors, const vector< string > &disabled_processors, const psg_time_point_t &start_timestamp)
 
 SPSGS_ResolveRequest ()
 
virtual CPSGS_Request::EPSGS_Type GetRequestType (void) const
 
virtual string GetName (void) const
 
virtual CJsonNode Serialize (void) const
 
 SPSGS_ResolveRequest (const SPSGS_ResolveRequest &)=default
 
 SPSGS_ResolveRequest (SPSGS_ResolveRequest &&)=default
 
SPSGS_ResolveRequestoperator= (const SPSGS_ResolveRequest &)=default
 
SPSGS_ResolveRequestoperator= (SPSGS_ResolveRequest &&)=default
 
- Public Member Functions inherited from SPSGS_RequestBase
 SPSGS_RequestBase ()
 
 SPSGS_RequestBase (EPSGS_Trace trace, bool processor_events, const vector< string > &enabled_processors, const vector< string > &disabled_processors, const psg_time_point_t &start)
 
virtual ~SPSGS_RequestBase ()
 
virtual EPSGS_Trace GetTrace (void) const
 
virtual bool GetProcessorEvents (void) const
 
virtual psg_time_point_t GetStartTimestamp (void) const
 
void AppendCommonParameters (CJsonNode &json) const
 
 SPSGS_RequestBase (const SPSGS_RequestBase &)=default
 
 SPSGS_RequestBase (SPSGS_RequestBase &&)=default
 
SPSGS_RequestBaseoperator= (const SPSGS_RequestBase &)=default
 
SPSGS_RequestBaseoperator= (SPSGS_RequestBase &&)=default
 

Static Public Member Functions

static string OutputFormatToString (EPSGS_OutputFormat format)
 
- Static Public Member Functions inherited from SPSGS_RequestBase
static string CacheAndDbUseToString (EPSGS_CacheAndDbUse option)
 
static string AccSubstitutioOptionToString (EPSGS_AccSubstitutioOption option)
 
static string TraceToString (EPSGS_Trace trace)
 

Public Attributes

string m_SeqId
 
int m_SeqIdType
 
TPSGS_BioseqIncludeData m_IncludeDataFlags
 
EPSGS_OutputFormat m_OutputFormat
 
EPSGS_CacheAndDbUse m_UseCache
 
EPSGS_AccSubstitutioOption m_AccSubstOption
 
bool m_SeqIdResolve
 
int m_Hops
 
- Public Attributes inherited from SPSGS_RequestBase
EPSGS_Trace m_Trace
 
bool m_ProcessorEvents
 
psg_time_point_t m_StartTimestamp
 
vector< stringm_EnabledProcessors
 
vector< stringm_DisabledProcessors
 

Detailed Description

Definition at line 378 of file psgs_request.hpp.

Member Typedef Documentation

◆ TPSGS_BioseqIncludeData

Definition at line 429 of file psgs_request.hpp.

Member Enumeration Documentation

◆ EPSGS_BioseqIncludeData

Enumerator
fPSGS_CanonicalId 
fPSGS_SeqIds 
fPSGS_MoleculeType 
fPSGS_Length 
fPSGS_State 
fPSGS_BlobId 
fPSGS_TaxId 
fPSGS_Hash 
fPSGS_DateChanged 
fPSGS_Gi 
fPSGS_Name 
fPSGS_SeqState 
fPSGS_AllBioseqFields 
fPSGS_BioseqKeyFields 

Definition at line 406 of file psgs_request.hpp.

◆ EPSGS_OutputFormat

Enumerator
ePSGS_ProtobufFormat 
ePSGS_JsonFormat 
ePSGS_NativeFormat 
ePSGS_UnknownFormat 

Definition at line 381 of file psgs_request.hpp.

Constructor & Destructor Documentation

◆ SPSGS_ResolveRequest() [1/4]

SPSGS_ResolveRequest::SPSGS_ResolveRequest ( const string seq_id,
int  seq_id_type,
TPSGS_BioseqIncludeData  include_data_flags,
EPSGS_OutputFormat  output_format,
EPSGS_CacheAndDbUse  use_cache,
EPSGS_AccSubstitutioOption  subst_option,
bool  seq_id_resolve,
int  hops,
EPSGS_Trace  trace,
bool  processor_events,
const vector< string > &  enabled_processors,
const vector< string > &  disabled_processors,
const psg_time_point_t start_timestamp 
)
inline

Definition at line 441 of file psgs_request.hpp.

◆ SPSGS_ResolveRequest() [2/4]

SPSGS_ResolveRequest::SPSGS_ResolveRequest ( )
inline

Definition at line 466 of file psgs_request.hpp.

◆ SPSGS_ResolveRequest() [3/4]

SPSGS_ResolveRequest::SPSGS_ResolveRequest ( const SPSGS_ResolveRequest )
default

◆ SPSGS_ResolveRequest() [4/4]

SPSGS_ResolveRequest::SPSGS_ResolveRequest ( SPSGS_ResolveRequest &&  )
default

Member Function Documentation

◆ GetName()

virtual string SPSGS_ResolveRequest::GetName ( void  ) const
inlinevirtual

Implements SPSGS_RequestBase.

Definition at line 481 of file psgs_request.hpp.

Referenced by Serialize().

◆ GetRequestType()

virtual CPSGS_Request::EPSGS_Type SPSGS_ResolveRequest::GetRequestType ( void  ) const
inlinevirtual

Implements SPSGS_RequestBase.

Definition at line 476 of file psgs_request.hpp.

References CPSGS_Request::ePSGS_ResolveRequest.

◆ operator=() [1/2]

SPSGS_ResolveRequest& SPSGS_ResolveRequest::operator= ( const SPSGS_ResolveRequest )
default

◆ operator=() [2/2]

SPSGS_ResolveRequest& SPSGS_ResolveRequest::operator= ( SPSGS_ResolveRequest &&  )
default

◆ OutputFormatToString()

static string SPSGS_ResolveRequest::OutputFormatToString ( EPSGS_OutputFormat  format)
inlinestatic

◆ Serialize()

CJsonNode SPSGS_ResolveRequest::Serialize ( void  ) const
virtual

Member Data Documentation

◆ m_AccSubstOption

EPSGS_AccSubstitutioOption SPSGS_ResolveRequest::m_AccSubstOption

Definition at line 437 of file psgs_request.hpp.

Referenced by Serialize().

◆ m_Hops

int SPSGS_ResolveRequest::m_Hops

Definition at line 439 of file psgs_request.hpp.

Referenced by Serialize().

◆ m_IncludeDataFlags

TPSGS_BioseqIncludeData SPSGS_ResolveRequest::m_IncludeDataFlags

Definition at line 434 of file psgs_request.hpp.

Referenced by Serialize(), and CPSGS_ResolveProcessor::x_SendBioseqInfo().

◆ m_OutputFormat

EPSGS_OutputFormat SPSGS_ResolveRequest::m_OutputFormat

◆ m_SeqId

string SPSGS_ResolveRequest::m_SeqId

◆ m_SeqIdResolve

bool SPSGS_ResolveRequest::m_SeqIdResolve

Definition at line 438 of file psgs_request.hpp.

◆ m_SeqIdType

int SPSGS_ResolveRequest::m_SeqIdType

Definition at line 433 of file psgs_request.hpp.

Referenced by Serialize(), and CPSGS_WGSProcessor::x_ProcessResolveRequest().

◆ m_UseCache

EPSGS_CacheAndDbUse SPSGS_ResolveRequest::m_UseCache

Definition at line 436 of file psgs_request.hpp.

Referenced by Serialize().


The documentation for this struct was generated from the following files:
Modified on Sun Jun 16 04:31:28 2024 by modify_doxy.py rev. 669887