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

Represents ASN.1 type Suspect-rule defined in file macro.asn

Search Toolkit Book for CSuspect_rule

#include <objects/macro/Suspect_rule.hpp>

+ Inheritance diagram for CSuspect_rule:
+ Collaboration diagram for CSuspect_rule:

Public Member Functions

 CSuspect_rule ()
 
 ~CSuspect_rule ()
 
bool StringMatchesSuspectProductRule (const CMatchString &str) const
 
bool ApplyToString (string &result, const CMatchString &str) const
 
bool ApplyToString (string &val) const
 
string GetRuleTypeName (void) const
 
string SummarizeRule (void) const
 
bool IsFatal (void) const
 
- Public Member Functions inherited from CSuspect_rule_Base
 CSuspect_rule_Base (void)
 
virtual ~CSuspect_rule_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetFind (void) const
 Check if a value has been assigned to Find data member. More...
 
bool CanGetFind (void) const
 Check if it is safe to call GetFind method. More...
 
void ResetFind (void)
 Reset Find data member. More...
 
const TFindGetFind (void) const
 Get the Find member data. More...
 
void SetFind (TFind &value)
 Assign a value to Find data member. More...
 
TFindSetFind (void)
 Assign a value to Find data member. More...
 
bool IsSetExcept (void) const
 Check if a value has been assigned to Except data member. More...
 
bool CanGetExcept (void) const
 Check if it is safe to call GetExcept method. More...
 
void ResetExcept (void)
 Reset Except data member. More...
 
const TExceptGetExcept (void) const
 Get the Except member data. More...
 
void SetExcept (TExcept &value)
 Assign a value to Except data member. More...
 
TExceptSetExcept (void)
 Assign a value to Except data member. More...
 
bool IsSetFeat_constraint (void) const
 Check if a value has been assigned to Feat_constraint data member. More...
 
bool CanGetFeat_constraint (void) const
 Check if it is safe to call GetFeat_constraint method. More...
 
void ResetFeat_constraint (void)
 Reset Feat_constraint data member. More...
 
const TFeat_constraintGetFeat_constraint (void) const
 Get the Feat_constraint member data. More...
 
void SetFeat_constraint (TFeat_constraint &value)
 Assign a value to Feat_constraint data member. More...
 
TFeat_constraintSetFeat_constraint (void)
 Assign a value to Feat_constraint data member. More...
 
bool IsSetRule_type (void) const
 Check if a value has been assigned to Rule_type data member. More...
 
bool CanGetRule_type (void) const
 Check if it is safe to call GetRule_type method. More...
 
void ResetRule_type (void)
 Reset Rule_type data member. More...
 
void SetDefaultRule_type (void)
 Assign default value to Rule_type data member. More...
 
TRule_type GetRule_type (void) const
 Get the Rule_type member data. More...
 
void SetRule_type (TRule_type value)
 Assign a value to Rule_type data member. More...
 
TRule_typeSetRule_type (void)
 Assign a value to Rule_type data member. More...
 
bool IsSetReplace (void) const
 Check if a value has been assigned to Replace data member. More...
 
bool CanGetReplace (void) const
 Check if it is safe to call GetReplace method. More...
 
void ResetReplace (void)
 Reset Replace data member. More...
 
const TReplaceGetReplace (void) const
 Get the Replace member data. More...
 
void SetReplace (TReplace &value)
 Assign a value to Replace data member. More...
 
TReplaceSetReplace (void)
 Assign a value to Replace data member. More...
 
bool IsSetDescription (void) const
 Check if a value has been assigned to Description data member. More...
 
bool CanGetDescription (void) const
 Check if it is safe to call GetDescription method. More...
 
void ResetDescription (void)
 Reset Description data member. More...
 
const TDescriptionGetDescription (void) const
 Get the Description member data. More...
 
void SetDescription (const TDescription &value)
 Assign a value to Description data member. More...
 
void SetDescription (TDescription &&value)
 
TDescriptionSetDescription (void)
 Assign a value to Description data member. More...
 
bool IsSetFatal (void) const
 Check if a value has been assigned to Fatal data member. More...
 
bool CanGetFatal (void) const
 Check if it is safe to call GetFatal method. More...
 
void ResetFatal (void)
 Reset Fatal data member. More...
 
void SetDefaultFatal (void)
 Assign default value to Fatal data member. More...
 
TFatal GetFatal (void) const
 Get the Fatal member data. More...
 
void SetFatal (TFatal value)
 Assign a value to Fatal data member. More...
 
TFatalSetFatal (void)
 Assign a value to Fatal 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 CSuspect_rule_Base Tparent
 

Private Member Functions

 CSuspect_rule (const CSuspect_rule &value)
 
CSuspect_ruleoperator= (const CSuspect_rule &value)
 
string SummarizeSearchFunc (const CSearch_func &) const
 
string SummarizeReplaceRule (const CReplace_rule &) const
 
string SummarizeStringConstraint (const CString_constraint &) const
 
string SummarizeConstraintSet (const CConstraint_choice_set &) const
 
string SummarizeConstraint (const CConstraint_choice &) const
 
string SummarizeLocationConstraint (const CLocation_constraint &) const
 
string SummarizeEndDistance (const CLocation_pos_constraint &) const
 
string SummarizeSourceConstraint (const CSource_constraint &) const
 
string SummarizeFieldConstraint (const CField_constraint &) const
 
string SummarizeFieldType (const CField_type &) const
 

Additional Inherited Members

- Public Types inherited from CSuspect_rule_Base
enum class  E_memberIndex {
  e__allMandatory = 0 , e_find , e_except , e_feat_constraint ,
  e_rule_type , e_replace , e_description , e_fatal
}
 
typedef CSearch_func TFind
 
typedef CSearch_func TExcept
 
typedef CConstraint_choice_set TFeat_constraint
 
typedef EFix_type TRule_type
 
typedef CReplace_rule TReplace
 
typedef string TDescription
 
typedef bool TFatal
 
typedef Tparent::CMemberIndex< E_memberIndex, 8 > 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 67 of file Suspect_rule.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 69 of file Suspect_rule.hpp.

Constructor & Destructor Documentation

◆ CSuspect_rule() [1/2]

CSuspect_rule::CSuspect_rule ( )
inline

Definition at line 71 of file Suspect_rule.hpp.

◆ ~CSuspect_rule()

CSuspect_rule::~CSuspect_rule ( )
inline

Definition at line 72 of file Suspect_rule.hpp.

◆ CSuspect_rule() [2/2]

CSuspect_rule::CSuspect_rule ( const CSuspect_rule value)
private

Member Function Documentation

◆ ApplyToString() [1/2]

bool CSuspect_rule::ApplyToString ( string result,
const CMatchString str 
) const

◆ ApplyToString() [2/2]

bool CSuspect_rule::ApplyToString ( string val) const

Definition at line 727 of file Suspect_rule.cpp.

References ApplyToString(), and val.

◆ GetRuleTypeName()

string CSuspect_rule::GetRuleTypeName ( void  ) const

Definition at line 1072 of file Suspect_rule.cpp.

References CSuspect_rule_Base::GetRule_type().

Referenced by SummarizeRule().

◆ IsFatal()

bool CSuspect_rule::IsFatal ( void  ) const
inline

◆ operator=()

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

◆ StringMatchesSuspectProductRule()

bool CSuspect_rule::StringMatchesSuspectProductRule ( const CMatchString str) const

◆ SummarizeConstraint()

string CSuspect_rule::SummarizeConstraint ( const CConstraint_choice choice) const
private

◆ SummarizeConstraintSet()

string CSuspect_rule::SummarizeConstraintSet ( const CConstraint_choice_set cons) const
private

◆ SummarizeEndDistance()

string CSuspect_rule::SummarizeEndDistance ( const CLocation_pos_constraint pos) const
private

◆ SummarizeFieldConstraint()

string CSuspect_rule::SummarizeFieldConstraint ( const CField_constraint field) const
private

◆ SummarizeFieldType()

string CSuspect_rule::SummarizeFieldType ( const CField_type vnp) const
private

◆ SummarizeLocationConstraint()

string CSuspect_rule::SummarizeLocationConstraint ( const CLocation_constraint loc) const
private

◆ SummarizeReplaceRule()

string CSuspect_rule::SummarizeReplaceRule ( const CReplace_rule repl) const
private

◆ SummarizeRule()

string CSuspect_rule::SummarizeRule ( void  ) const

◆ SummarizeSearchFunc()

string CSuspect_rule::SummarizeSearchFunc ( const CSearch_func func) const
private

◆ SummarizeSourceConstraint()

string CSuspect_rule::SummarizeSourceConstraint ( const CSource_constraint ) const
private

Definition at line 1012 of file Suspect_rule.cpp.

References kEmptyStr.

Referenced by SummarizeConstraint().

◆ SummarizeStringConstraint()

string CSuspect_rule::SummarizeStringConstraint ( const CString_constraint cons) const
private

The documentation for this class was generated from the following files:
Modified on Thu Apr 11 15:06:12 2024 by modify_doxy.py rev. 669887