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

Represents ASN.1 type FormatRpsDbParameters defined in file scoremat.asn

Search Toolkit Book for CFormatRpsDbParameters

#include <objects/scoremat/FormatRpsDbParameters.hpp>

+ Inheritance diagram for CFormatRpsDbParameters:
+ Collaboration diagram for CFormatRpsDbParameters:

Public Member Functions

 CFormatRpsDbParameters (void)
 
 ~CFormatRpsDbParameters (void)
 
bool operator== (const CFormatRpsDbParameters &rhs) const
 
bool operator!= (const CFormatRpsDbParameters &rhs) const
 
- Public Member Functions inherited from CFormatRpsDbParameters_Base
 CFormatRpsDbParameters_Base (void)
 
virtual ~CFormatRpsDbParameters_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetMatrixName (void) const
 name of the underlying score matrix whose frequency ratios were used in PSSM construction (e.g. More...
 
bool CanGetMatrixName (void) const
 Check if it is safe to call GetMatrixName method. More...
 
void ResetMatrixName (void)
 Reset MatrixName data member. More...
 
const TMatrixNameGetMatrixName (void) const
 Get the MatrixName member data. More...
 
void SetMatrixName (const TMatrixName &value)
 Assign a value to MatrixName data member. More...
 
void SetMatrixName (TMatrixName &&value)
 
TMatrixNameSetMatrixName (void)
 Assign a value to MatrixName data member. More...
 
bool IsSetGapOpen (void) const
 gap opening penalty corresponding to the matrix above Check if a value has been assigned to GapOpen data member. More...
 
bool CanGetGapOpen (void) const
 Check if it is safe to call GetGapOpen method. More...
 
void ResetGapOpen (void)
 Reset GapOpen data member. More...
 
TGapOpen GetGapOpen (void) const
 Get the GapOpen member data. More...
 
void SetGapOpen (TGapOpen value)
 Assign a value to GapOpen data member. More...
 
TGapOpenSetGapOpen (void)
 Assign a value to GapOpen data member. More...
 
bool IsSetGapExtend (void) const
 gap extension penalty corresponding to the matrix above Check if a value has been assigned to GapExtend data member. More...
 
bool CanGetGapExtend (void) const
 Check if it is safe to call GetGapExtend method. More...
 
void ResetGapExtend (void)
 Reset GapExtend data member. More...
 
TGapExtend GetGapExtend (void) const
 Get the GapExtend member data. More...
 
void SetGapExtend (TGapExtend value)
 Assign a value to GapExtend data member. More...
 
TGapExtendSetGapExtend (void)
 Assign a value to GapExtend data member. More...
 
virtual void Reset (void)
 Reset the whole object. More...
 
- Public Member Functions inherited from CSerialObject
 CSerialObject (void)
 
virtual ~CSerialObject (void)
 
virtual const CTypeInfoGetThisTypeInfo (void) const =0
 
virtual void Assign (const CSerialObject &source, ESerialRecursionMode how=eRecursive)
 Set object to copy of another one. More...
 
virtual bool Equals (const CSerialObject &object, ESerialRecursionMode how=eRecursive) const
 Check if both objects contain the same values. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
void ThrowUnassigned (TMemberIndex index) const
 
void ThrowUnassigned (TMemberIndex index, const char *file_name, int file_line) const
 
bool HasNamespaceName (void) const
 Check if object data type has namespace name. More...
 
const stringGetNamespaceName (void) const
 Get namespace name. More...
 
bool HasNamespacePrefix (void) const
 Check if data type has namespace prefix. More...
 
const stringGetNamespacePrefix (void) const
 Get namespace prefix. More...
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 

Private Types

typedef CFormatRpsDbParameters_Base Tparent
 

Private Member Functions

 CFormatRpsDbParameters (const CFormatRpsDbParameters &value)
 
CFormatRpsDbParametersoperator= (const CFormatRpsDbParameters &value)
 

Additional Inherited Members

- Public Types inherited from CFormatRpsDbParameters_Base
enum class  E_memberIndex { e__allMandatory = 0 , e_matrixName , e_gapOpen , e_gapExtend }
 
typedef string TMatrixName
 
typedef int TGapOpen
 
typedef int TGapExtend
 
typedef Tparent::CMemberIndex< E_memberIndex, 4 > TmemberIndex
 
- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 
- Static Public Member Functions inherited from CSerialObject
static void SetVerifyDataThread (ESerialVerifyData verify)
 
static void SetVerifyDataGlobal (ESerialVerifyData verify)
 
static string UnassignedString (void)
 
static CStringUTF8 UnassignedStringUTF8 (void)
 
static char UnassignedByte (void)
 
- Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 
- Static Public Attributes inherited from CSerialObject
static const char * ms_UnassignedStr = "<*unassigned*>"
 
static const char ms_UnassignedByte = char(0xcd)
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 53 of file FormatRpsDbParameters.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 55 of file FormatRpsDbParameters.hpp.

Constructor & Destructor Documentation

◆ CFormatRpsDbParameters() [1/2]

CFormatRpsDbParameters::CFormatRpsDbParameters ( void  )
inline

Definition at line 76 of file FormatRpsDbParameters.hpp.

◆ ~CFormatRpsDbParameters()

CFormatRpsDbParameters::~CFormatRpsDbParameters ( void  )

Definition at line 50 of file FormatRpsDbParameters.cpp.

◆ CFormatRpsDbParameters() [2/2]

CFormatRpsDbParameters::CFormatRpsDbParameters ( const CFormatRpsDbParameters value)
private

Member Function Documentation

◆ operator!=()

bool CFormatRpsDbParameters::operator!= ( const CFormatRpsDbParameters rhs) const

Definition at line 85 of file FormatRpsDbParameters.cpp.

◆ operator=()

CFormatRpsDbParameters& CFormatRpsDbParameters::operator= ( const CFormatRpsDbParameters value)
private

◆ operator==()

bool CFormatRpsDbParameters::operator== ( const CFormatRpsDbParameters rhs) const

The documentation for this class was generated from the following files:
Modified on Sat Mar 02 10:56:32 2024 by modify_doxy.py rev. 669887