Search Toolkit Book for SPSGS_RequestBase

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

Inheritance diagram for SPSGS_RequestBase:

Collaboration diagram for SPSGS_RequestBase:

Public Types
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_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 CPSGS_Request::EPSGS_Type	GetRequestType (void) const =0

virtual string	GetName (void) const =0

virtual CJsonNode	Serialize (void) const =0

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_RequestBase &	operator= (const SPSGS_RequestBase &)=default

SPSGS_RequestBase &	operator= (SPSGS_RequestBase &&)=default

Static Public Member Functions
static string	CacheAndDbUseToString (EPSGS_CacheAndDbUse option)

static string	AccSubstitutioOptionToString (EPSGS_AccSubstitutioOption option)

static string	TraceToString (EPSGS_Trace trace)

Public Attributes
EPSGS_Trace	m_Trace

bool	m_ProcessorEvents

psg_time_point_t	m_StartTimestamp

vector< string >	m_EnabledProcessors

vector< string >	m_DisabledProcessors

Detailed Description

Definition at line 264 of file psgs_request.hpp.

Member Enumeration Documentation

◆ EPSGS_AccSubstitutioOption

enum SPSGS_RequestBase::EPSGS_AccSubstitutioOption

Enumerator
ePSGS_DefaultAccSubstitution
ePSGS_LimitedAccSubstitution
ePSGS_NeverAccSubstitute
ePSGS_UnknownAccSubstitution

Definition at line 289 of file psgs_request.hpp.

◆ EPSGS_CacheAndDbUse

enum SPSGS_RequestBase::EPSGS_CacheAndDbUse

Enumerator
ePSGS_CacheOnly
ePSGS_DbOnly
ePSGS_CacheAndDb
ePSGS_UnknownUseCache

Definition at line 267 of file psgs_request.hpp.

◆ EPSGS_Trace

enum SPSGS_RequestBase::EPSGS_Trace

Enumerator
ePSGS_NoTracing
ePSGS_WithTracing

Definition at line 309 of file psgs_request.hpp.

Constructor & Destructor Documentation

◆ SPSGS_RequestBase() [1/4]

SPSGS_RequestBase::SPSGS_RequestBase ( )

inline

Definition at line 330 of file psgs_request.hpp.

◆ SPSGS_RequestBase() [2/4]

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
	)

inline

Definition at line 336 of file psgs_request.hpp.

◆ ~SPSGS_RequestBase()

virtual SPSGS_RequestBase::~SPSGS_RequestBase ( )

inlinevirtual

Definition at line 347 of file psgs_request.hpp.

◆ SPSGS_RequestBase() [3/4]

SPSGS_RequestBase::SPSGS_RequestBase ( const SPSGS_RequestBase & )

default

◆ SPSGS_RequestBase() [4/4]

SPSGS_RequestBase::SPSGS_RequestBase ( SPSGS_RequestBase && )

default

Member Function Documentation

◆ AccSubstitutioOptionToString()

static string SPSGS_RequestBase::AccSubstitutioOptionToString ( EPSGS_AccSubstitutioOption option )

inlinestatic

Definition at line 297 of file psgs_request.hpp.

References ePSGS_DefaultAccSubstitution, ePSGS_LimitedAccSubstitution, ePSGS_NeverAccSubstitute, ePSGS_UnknownAccSubstitution, and option.

Referenced by SPSGS_ResolveRequest::Serialize(), and SPSGS_BlobBySeqIdRequest::Serialize().

◆ AppendCommonParameters()

void SPSGS_RequestBase::AppendCommonParameters ( CJsonNode & json ) const

◆ CacheAndDbUseToString()

static string SPSGS_RequestBase::CacheAndDbUseToString ( EPSGS_CacheAndDbUse option )

inlinestatic

Definition at line 275 of file psgs_request.hpp.

References ePSGS_CacheAndDb, ePSGS_CacheOnly, ePSGS_DbOnly, ePSGS_UnknownUseCache, and option.

Referenced by SPSGS_BlobRequestBase::AppendCommonParameters(), SPSGS_ResolveRequest::Serialize(), SPSGS_TSEChunkRequest::Serialize(), SPSGS_AccessionVersionHistoryRequest::Serialize(), and SPSGS_IPGResolveRequest::Serialize().

◆ GetName()

virtual string SPSGS_RequestBase::GetName ( void ) const

pure virtual

Implemented in SPSGS_IPGResolveRequest, SPSGS_AccessionVersionHistoryRequest, SPSGS_TSEChunkRequest, SPSGS_AnnotRequest, SPSGS_BlobBySatSatKeyRequest, SPSGS_BlobBySeqIdRequest, and SPSGS_ResolveRequest.

◆ GetProcessorEvents()

virtual bool SPSGS_RequestBase::GetProcessorEvents ( void ) const

inlinevirtual

Definition at line 358 of file psgs_request.hpp.

References m_ProcessorEvents.

◆ GetRequestType()

virtual CPSGS_Request::EPSGS_Type SPSGS_RequestBase::GetRequestType ( void ) const

pure virtual

Implemented in SPSGS_IPGResolveRequest, SPSGS_AccessionVersionHistoryRequest, SPSGS_TSEChunkRequest, SPSGS_AnnotRequest, SPSGS_BlobBySatSatKeyRequest, SPSGS_BlobBySeqIdRequest, and SPSGS_ResolveRequest.

◆ GetStartTimestamp()

virtual psg_time_point_t SPSGS_RequestBase::GetStartTimestamp ( void ) const

inlinevirtual

Definition at line 363 of file psgs_request.hpp.

References m_StartTimestamp.

◆ GetTrace()

virtual EPSGS_Trace SPSGS_RequestBase::GetTrace ( void ) const

inlinevirtual

Definition at line 353 of file psgs_request.hpp.

References m_Trace.

◆ operator=() [1/2]

SPSGS_RequestBase& SPSGS_RequestBase::operator= ( const SPSGS_RequestBase & )

default

◆ operator=() [2/2]

SPSGS_RequestBase& SPSGS_RequestBase::operator= ( SPSGS_RequestBase && )

default

◆ Serialize()

virtual CJsonNode SPSGS_RequestBase::Serialize ( void ) const

pure virtual

Implemented in SPSGS_IPGResolveRequest, SPSGS_AccessionVersionHistoryRequest, SPSGS_TSEChunkRequest, SPSGS_AnnotRequest, SPSGS_BlobBySatSatKeyRequest, SPSGS_BlobBySeqIdRequest, and SPSGS_ResolveRequest.

◆ TraceToString()

static string SPSGS_RequestBase::TraceToString ( EPSGS_Trace trace )

inlinestatic

Definition at line 314 of file psgs_request.hpp.

References ePSGS_NoTracing, ePSGS_WithTracing, and trace.

Referenced by AppendCommonParameters().

Member Data Documentation

◆ m_DisabledProcessors

vector<string> SPSGS_RequestBase::m_DisabledProcessors

Definition at line 328 of file psgs_request.hpp.

Referenced by AppendCommonParameters(), CPSGS_DummyProcessor::CanProcess(), CPSGS_CassProcessorBase::IsCassandraProcessorEnabled(), CPSGS_CDDProcessor::x_IsEnabled(), CPSGS_SNPProcessor::x_IsEnabled(), and CPSGS_WGSProcessor::x_IsEnabled().

◆ m_EnabledProcessors

vector<string> SPSGS_RequestBase::m_EnabledProcessors

Definition at line 327 of file psgs_request.hpp.

Referenced by AppendCommonParameters(), CPSGS_CassProcessorBase::IsCassandraProcessorEnabled(), CPSGS_CDDProcessor::x_IsEnabled(), CPSGS_SNPProcessor::x_IsEnabled(), and CPSGS_WGSProcessor::x_IsEnabled().

◆ m_ProcessorEvents

bool SPSGS_RequestBase::m_ProcessorEvents

Definition at line 325 of file psgs_request.hpp.

Referenced by AppendCommonParameters(), and GetProcessorEvents().

◆ m_StartTimestamp

psg_time_point_t SPSGS_RequestBase::m_StartTimestamp

Definition at line 326 of file psgs_request.hpp.

Referenced by AppendCommonParameters(), and GetStartTimestamp().

◆ m_Trace

EPSGS_Trace SPSGS_RequestBase::m_Trace

Definition at line 324 of file psgs_request.hpp.

Referenced by AppendCommonParameters(), and GetTrace().

The documentation for this struct was generated from the following files:

src/app/pubseq_gateway/server/psgs_request.hpp
src/app/pubseq_gateway/server/psgs_request.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ EPSGS_AccSubstitutioOption

◆ EPSGS_CacheAndDbUse

◆ EPSGS_Trace

Constructor & Destructor Documentation

◆ SPSGS_RequestBase() [1/4]

◆ SPSGS_RequestBase() [2/4]

◆ ~SPSGS_RequestBase()

◆ SPSGS_RequestBase() [3/4]

◆ SPSGS_RequestBase() [4/4]

Member Function Documentation

◆ AccSubstitutioOptionToString()

◆ AppendCommonParameters()

◆ CacheAndDbUseToString()

◆ GetName()

◆ GetProcessorEvents()

◆ GetRequestType()

◆ GetStartTimestamp()

◆ GetTrace()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Serialize()

◆ TraceToString()

Member Data Documentation

◆ m_DisabledProcessors

◆ m_EnabledProcessors

◆ m_ProcessorEvents

◆ m_StartTimestamp

◆ m_Trace