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 TFind & | GetFind (void) const |
| Get the Find member data. More... | |
| void | SetFind (TFind &value) |
| Assign a value to Find data member. More... | |
| TFind & | SetFind (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 TExcept & | GetExcept (void) const |
| Get the Except member data. More... | |
| void | SetExcept (TExcept &value) |
| Assign a value to Except data member. More... | |
| TExcept & | SetExcept (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_constraint & | GetFeat_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_constraint & | SetFeat_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_type & | SetRule_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 TReplace & | GetReplace (void) const |
| Get the Replace member data. More... | |
| void | SetReplace (TReplace &value) |
| Assign a value to Replace data member. More... | |
| TReplace & | SetReplace (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 TDescription & | GetDescription (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) |
| TDescription & | SetDescription (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... | |
| TFatal & | SetFatal (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 CTypeInfo * | GetThisTypeInfo (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 string & | GetNamespaceName (void) const |
| Get namespace name. More... | |
| bool | HasNamespacePrefix (void) const |
| Check if data type has namespace prefix. More... | |
| const string & | GetNamespacePrefix (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... | |
| CObject & | operator= (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 |
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< Uint8 > | TCounter |
| 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
|
private |
Definition at line 69 of file Suspect_rule.hpp.
Constructor & Destructor Documentation
◆ CSuspect_rule() [1/2]
|
inline |
Definition at line 71 of file Suspect_rule.hpp.
◆ ~CSuspect_rule()
|
inline |
Definition at line 72 of file Suspect_rule.hpp.
◆ CSuspect_rule() [2/2]
|
private |
Member Function Documentation
◆ ApplyToString() [1/2]
| bool CSuspect_rule::ApplyToString | ( | string & | result, |
| const CMatchString & | str | ||
| ) | const |
Definition at line 732 of file Suspect_rule.cpp.
References CReplace_rule::ApplyToString(), CSuspect_rule_Base::GetFind(), CSuspect_rule_Base::GetReplace(), CSuspect_rule_Base::IsSetFind(), CSuspect_rule_Base::IsSetReplace(), NULL, CConstRef< C, Locker >::Reset(), result, str(), and StringMatchesSuspectProductRule().
Referenced by ApplyToString(), and BOOST_AUTO_TEST_CASE().
◆ ApplyToString() [2/2]
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()
|
inline |
Definition at line 82 of file Suspect_rule.hpp.
References eFix_type_inappropriate_symbol, eFix_type_remove_organism_name, CSuspect_rule_Base::GetFatal(), and CSuspect_rule_Base::GetRule_type().
◆ operator=()
|
private |
◆ StringMatchesSuspectProductRule()
| bool CSuspect_rule::StringMatchesSuspectProductRule | ( | const CMatchString & | str | ) | const |
Definition at line 693 of file Suspect_rule.cpp.
References b, CSuspect_rule_Base::CanGetExcept(), CSuspect_rule_Base::CanGetFeat_constraint(), DoesSingleStringMatchConstraint(), CConstraint_choice_Base::e_String, CSearch_func::Empty(), CConstraint_choice_set_Base::Get(), CSuspect_rule_Base::GetExcept(), CSuspect_rule_Base::GetFeat_constraint(), CSuspect_rule_Base::GetFind(), CString_constraint_Base::GetNot_present(), CSearch_func::Match(), and str().
Referenced by ApplyToString(), and CDiscrepancyVisitorImpl< _Name >::Autofix().
◆ SummarizeConstraint()
|
private |
Definition at line 1018 of file Suspect_rule.cpp.
References CConstraint_choice_Base::e_Cdsgeneprot_pseudo, CConstraint_choice_Base::e_Cdsgeneprot_qual, CConstraint_choice_Base::e_Field, CConstraint_choice_Base::e_Field_missing, CConstraint_choice_Base::e_Location, CConstraint_choice_Base::e_Molinfo, CConstraint_choice_Base::e_Pub, CConstraint_choice_Base::e_Sequence, CConstraint_choice_Base::e_Source, CConstraint_choice_Base::e_String, CConstraint_choice_Base::e_Translation, CConstraint_choice_Base::GetField(), CConstraint_choice_Base::GetLocation(), CConstraint_choice_Base::GetSource(), CConstraint_choice_Base::GetString(), kEmptyStr, SummarizeFieldConstraint(), SummarizeLocationConstraint(), SummarizeSourceConstraint(), SummarizeStringConstraint(), tmp, and CConstraint_choice_Base::Which().
Referenced by SummarizeConstraintSet().
◆ SummarizeConstraintSet()
|
private |
Definition at line 1060 of file Suspect_rule.cpp.
References CConstraint_choice_set_Base::Get(), ITERATE, kEmptyStr, str(), SummarizeConstraint(), and tmp.
Referenced by SummarizeRule().
◆ SummarizeEndDistance()
|
private |
Definition at line 857 of file Suspect_rule.cpp.
References CLocation_pos_constraint_Base::e_Dist_from_end, CLocation_pos_constraint_Base::e_Max_dist_from_end, CLocation_pos_constraint_Base::e_Min_dist_from_end, CLocation_pos_constraint_Base::GetDist_from_end(), CLocation_pos_constraint_Base::GetMax_dist_from_end(), CLocation_pos_constraint_Base::GetMin_dist_from_end(), NStr::IntToString(), kEmptyStr, and CLocation_pos_constraint_Base::Which().
Referenced by SummarizeLocationConstraint().
◆ SummarizeFieldConstraint()
|
private |
Definition at line 1004 of file Suspect_rule.cpp.
References CField_constraint_Base::GetField(), CField_constraint_Base::GetString_constraint(), kEmptyStr, label, SummarizeFieldType(), and SummarizeStringConstraint().
Referenced by SummarizeConstraint().
◆ SummarizeFieldType()
|
private |
Definition at line 950 of file Suspect_rule.cpp.
References CField_type_Base::e_Cds_gene_prot, CField_type_Base::e_Dblink, CField_type_Base::e_Feature_field, CField_type_Base::e_Misc, CField_type_Base::e_Molinfo_field, CFeat_qual_choice_Base::e_not_set, CField_type_Base::e_not_set, CField_type_Base::e_Pub, CField_type_Base::e_Rna_field, CField_type_Base::e_Source_qual, CField_type_Base::e_Struc_comment_field, ENUM_METHOD_NAME, CField_type_Base::GetFeature_field(), CFeature_field_Base::GetField(), CFeature_field_Base::GetType(), label, str(), CFeat_qual_choice_Base::Which(), and CField_type_Base::Which().
Referenced by SummarizeFieldConstraint().
◆ SummarizeLocationConstraint()
|
private |
Definition at line 873 of file Suspect_rule.cpp.
References CLocation_constraint_Base::CanGetEnd3(), CLocation_constraint_Base::CanGetEnd5(), eLocation_type_constraint_joined, eLocation_type_constraint_ordered, eLocation_type_constraint_single_interval, ePartial_constraint_complete, ePartial_constraint_either, ePartial_constraint_partial, eSeqtype_constraint_nuc, eSeqtype_constraint_prot, eStrand_constraint_minus, eStrand_constraint_plus, CLocation_constraint_Base::GetEnd3(), CLocation_constraint_Base::GetEnd5(), CLocation_constraint_Base::GetLocation_type(), CLocation_constraint_Base::GetPartial3(), CLocation_constraint_Base::GetPartial5(), CLocation_constraint_Base::GetSeq_type(), CLocation_constraint_Base::GetStrand(), kEmptyStr, str(), and SummarizeEndDistance().
Referenced by SummarizeConstraint().
◆ SummarizeReplaceRule()
|
private |
Definition at line 747 of file Suspect_rule.cpp.
References CSimple_replace_Base::CanGetReplace(), CReplace_func_Base::e_Haem_replace, CReplace_func_Base::e_Simple_replace, CReplace_func_Base::GetHaem_replace(), CReplace_rule_Base::GetMove_to_note(), CSimple_replace_Base::GetReplace(), CReplace_rule_Base::GetReplace_func(), CReplace_func_Base::GetSimple_replace(), CSimple_replace_Base::GetWeasel_to_putative(), CSimple_replace_Base::GetWhole_string(), kEmptyStr, str(), and CReplace_func_Base::Which().
Referenced by SummarizeRule().
◆ SummarizeRule()
| string CSuspect_rule::SummarizeRule | ( | void | ) | const |
Definition at line 1095 of file Suspect_rule.cpp.
References CSuspect_rule_Base::CanGetExcept(), CSuspect_rule_Base::CanGetFeat_constraint(), CSuspect_rule_Base::CanGetReplace(), CSuspect_rule_Base::GetDescription(), CSuspect_rule_Base::GetExcept(), CSuspect_rule_Base::GetFeat_constraint(), CSuspect_rule_Base::GetFind(), CSuspect_rule_Base::GetReplace(), GetRuleTypeName(), CSuspect_rule_Base::IsSetDescription(), kEmptyStr, out(), SummarizeConstraintSet(), SummarizeReplaceRule(), and SummarizeSearchFunc().
Referenced by CSuspectProductRulesEditor::AddRule(), and CSuspectProductRulesEditor::ReplaceRule().
◆ SummarizeSearchFunc()
|
private |
Definition at line 825 of file Suspect_rule.cpp.
References CSearch_func_Base::e_All_caps, CSearch_func_Base::e_Contains_plural, CSearch_func_Base::e_Has_term, CSearch_func_Base::e_N_or_more_brackets_or_parentheses, CSearch_func_Base::e_Prefix_and_numbers, CSearch_func_Base::e_String_constraint, CSearch_func_Base::e_Three_numbers, CSearch_func_Base::e_Too_long, CSearch_func_Base::e_Unbalanced_paren, CSearch_func_Base::e_Underscore, CSearch_func_Base::GetHas_term(), CSearch_func_Base::GetN_or_more_brackets_or_parentheses(), CSearch_func_Base::GetPrefix_and_numbers(), CSearch_func_Base::GetString_constraint(), CSearch_func_Base::GetToo_long(), NStr::IntToString(), SummarizeStringConstraint(), and CSearch_func_Base::Which().
Referenced by SummarizeRule().
◆ SummarizeSourceConstraint()
|
private |
Definition at line 1012 of file Suspect_rule.cpp.
References kEmptyStr.
Referenced by SummarizeConstraint().
◆ SummarizeStringConstraint()
|
private |
Definition at line 766 of file Suspect_rule.cpp.
References CString_constraint_Base::CanGetIgnore_words(), CString_constraint_Base::CanGetMatch_text(), eString_location_contains, eString_location_ends, eString_location_equals, eString_location_inlist, eString_location_starts, CWord_substitution_set_Base::Get(), CString_constraint_Base::GetCase_sensitive(), CString_constraint_Base::GetIgnore_punct(), CString_constraint_Base::GetIgnore_space(), CString_constraint_Base::GetIgnore_weasel(), CString_constraint_Base::GetIgnore_words(), CString_constraint_Base::GetIs_all_caps(), CString_constraint_Base::GetIs_all_lower(), CString_constraint_Base::GetIs_all_punct(), CString_constraint_Base::GetMatch_location(), CString_constraint_Base::GetMatch_text(), CString_constraint_Base::GetNot_present(), CString_constraint_Base::GetWhole_word(), ITERATE, kEmptyStr, and str().
Referenced by SummarizeConstraint(), SummarizeFieldConstraint(), and SummarizeSearchFunc().
The documentation for this class was generated from the following files:
- include/objects/macro/Suspect_rule.hpp
- src/objects/macro/Suspect_rule.cpp
