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

Represents ASN.1 type String-constraint defined in file macro.asn

Search Toolkit Book for CString_constraint

#include <objects/macro/String_constraint.hpp>

+ Inheritance diagram for CString_constraint:
+ Collaboration diagram for CString_constraint:

Public Member Functions

 CString_constraint ()
 
virtual ~CString_constraint ()
 
template<class T >
void GetStringsFromObject (const T &obj, vector< string > &strs) const
 
bool Match (const CMatchString &str) const
 
bool Empty () const
 
bool ReplaceStringConstraintPortionInString (string &result, const CMatchString &str, const string &replace) const
 
void SetMatch_text (const TMatch_text &value)
 
TMatch_textSetMatch_text (void)
 
- Public Member Functions inherited from CString_constraint_Base
 CString_constraint_Base (void)
 
virtual ~CString_constraint_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetMatch_text (void) const
 Check if a value has been assigned to Match_text data member. More...
 
bool CanGetMatch_text (void) const
 Check if it is safe to call GetMatch_text method. More...
 
void ResetMatch_text (void)
 Reset Match_text data member. More...
 
const TMatch_textGetMatch_text (void) const
 Get the Match_text member data. More...
 
void SetMatch_text (const TMatch_text &value)
 Assign a value to Match_text data member. More...
 
void SetMatch_text (TMatch_text &&value)
 
TMatch_textSetMatch_text (void)
 Assign a value to Match_text data member. More...
 
bool IsSetMatch_location (void) const
 Check if a value has been assigned to Match_location data member. More...
 
bool CanGetMatch_location (void) const
 Check if it is safe to call GetMatch_location method. More...
 
void ResetMatch_location (void)
 Reset Match_location data member. More...
 
void SetDefaultMatch_location (void)
 Assign default value to Match_location data member. More...
 
TMatch_location GetMatch_location (void) const
 Get the Match_location member data. More...
 
void SetMatch_location (TMatch_location value)
 Assign a value to Match_location data member. More...
 
TMatch_locationSetMatch_location (void)
 Assign a value to Match_location data member. More...
 
bool IsSetCase_sensitive (void) const
 Check if a value has been assigned to Case_sensitive data member. More...
 
bool CanGetCase_sensitive (void) const
 Check if it is safe to call GetCase_sensitive method. More...
 
void ResetCase_sensitive (void)
 Reset Case_sensitive data member. More...
 
void SetDefaultCase_sensitive (void)
 Assign default value to Case_sensitive data member. More...
 
TCase_sensitive GetCase_sensitive (void) const
 Get the Case_sensitive member data. More...
 
void SetCase_sensitive (TCase_sensitive value)
 Assign a value to Case_sensitive data member. More...
 
TCase_sensitiveSetCase_sensitive (void)
 Assign a value to Case_sensitive data member. More...
 
bool IsSetIgnore_space (void) const
 Check if a value has been assigned to Ignore_space data member. More...
 
bool CanGetIgnore_space (void) const
 Check if it is safe to call GetIgnore_space method. More...
 
void ResetIgnore_space (void)
 Reset Ignore_space data member. More...
 
void SetDefaultIgnore_space (void)
 Assign default value to Ignore_space data member. More...
 
TIgnore_space GetIgnore_space (void) const
 Get the Ignore_space member data. More...
 
void SetIgnore_space (TIgnore_space value)
 Assign a value to Ignore_space data member. More...
 
TIgnore_spaceSetIgnore_space (void)
 Assign a value to Ignore_space data member. More...
 
bool IsSetIgnore_punct (void) const
 Check if a value has been assigned to Ignore_punct data member. More...
 
bool CanGetIgnore_punct (void) const
 Check if it is safe to call GetIgnore_punct method. More...
 
void ResetIgnore_punct (void)
 Reset Ignore_punct data member. More...
 
void SetDefaultIgnore_punct (void)
 Assign default value to Ignore_punct data member. More...
 
TIgnore_punct GetIgnore_punct (void) const
 Get the Ignore_punct member data. More...
 
void SetIgnore_punct (TIgnore_punct value)
 Assign a value to Ignore_punct data member. More...
 
TIgnore_punctSetIgnore_punct (void)
 Assign a value to Ignore_punct data member. More...
 
bool IsSetIgnore_words (void) const
 Check if a value has been assigned to Ignore_words data member. More...
 
bool CanGetIgnore_words (void) const
 Check if it is safe to call GetIgnore_words method. More...
 
void ResetIgnore_words (void)
 Reset Ignore_words data member. More...
 
const TIgnore_wordsGetIgnore_words (void) const
 Get the Ignore_words member data. More...
 
void SetIgnore_words (TIgnore_words &value)
 Assign a value to Ignore_words data member. More...
 
TIgnore_wordsSetIgnore_words (void)
 Assign a value to Ignore_words data member. More...
 
bool IsSetWhole_word (void) const
 Check if a value has been assigned to Whole_word data member. More...
 
bool CanGetWhole_word (void) const
 Check if it is safe to call GetWhole_word method. More...
 
void ResetWhole_word (void)
 Reset Whole_word data member. More...
 
void SetDefaultWhole_word (void)
 Assign default value to Whole_word data member. More...
 
TWhole_word GetWhole_word (void) const
 Get the Whole_word member data. More...
 
void SetWhole_word (TWhole_word value)
 Assign a value to Whole_word data member. More...
 
TWhole_wordSetWhole_word (void)
 Assign a value to Whole_word data member. More...
 
bool IsSetNot_present (void) const
 Check if a value has been assigned to Not_present data member. More...
 
bool CanGetNot_present (void) const
 Check if it is safe to call GetNot_present method. More...
 
void ResetNot_present (void)
 Reset Not_present data member. More...
 
void SetDefaultNot_present (void)
 Assign default value to Not_present data member. More...
 
TNot_present GetNot_present (void) const
 Get the Not_present member data. More...
 
void SetNot_present (TNot_present value)
 Assign a value to Not_present data member. More...
 
TNot_presentSetNot_present (void)
 Assign a value to Not_present data member. More...
 
bool IsSetIs_all_caps (void) const
 Check if a value has been assigned to Is_all_caps data member. More...
 
bool CanGetIs_all_caps (void) const
 Check if it is safe to call GetIs_all_caps method. More...
 
void ResetIs_all_caps (void)
 Reset Is_all_caps data member. More...
 
void SetDefaultIs_all_caps (void)
 Assign default value to Is_all_caps data member. More...
 
TIs_all_caps GetIs_all_caps (void) const
 Get the Is_all_caps member data. More...
 
void SetIs_all_caps (TIs_all_caps value)
 Assign a value to Is_all_caps data member. More...
 
TIs_all_capsSetIs_all_caps (void)
 Assign a value to Is_all_caps data member. More...
 
bool IsSetIs_all_lower (void) const
 Check if a value has been assigned to Is_all_lower data member. More...
 
bool CanGetIs_all_lower (void) const
 Check if it is safe to call GetIs_all_lower method. More...
 
void ResetIs_all_lower (void)
 Reset Is_all_lower data member. More...
 
void SetDefaultIs_all_lower (void)
 Assign default value to Is_all_lower data member. More...
 
TIs_all_lower GetIs_all_lower (void) const
 Get the Is_all_lower member data. More...
 
void SetIs_all_lower (TIs_all_lower value)
 Assign a value to Is_all_lower data member. More...
 
TIs_all_lowerSetIs_all_lower (void)
 Assign a value to Is_all_lower data member. More...
 
bool IsSetIs_all_punct (void) const
 Check if a value has been assigned to Is_all_punct data member. More...
 
bool CanGetIs_all_punct (void) const
 Check if it is safe to call GetIs_all_punct method. More...
 
void ResetIs_all_punct (void)
 Reset Is_all_punct data member. More...
 
void SetDefaultIs_all_punct (void)
 Assign default value to Is_all_punct data member. More...
 
TIs_all_punct GetIs_all_punct (void) const
 Get the Is_all_punct member data. More...
 
void SetIs_all_punct (TIs_all_punct value)
 Assign a value to Is_all_punct data member. More...
 
TIs_all_punctSetIs_all_punct (void)
 Assign a value to Is_all_punct data member. More...
 
bool IsSetIgnore_weasel (void) const
 Check if a value has been assigned to Ignore_weasel data member. More...
 
bool CanGetIgnore_weasel (void) const
 Check if it is safe to call GetIgnore_weasel method. More...
 
void ResetIgnore_weasel (void)
 Reset Ignore_weasel data member. More...
 
void SetDefaultIgnore_weasel (void)
 Assign default value to Ignore_weasel data member. More...
 
TIgnore_weasel GetIgnore_weasel (void) const
 Get the Ignore_weasel member data. More...
 
void SetIgnore_weasel (TIgnore_weasel value)
 Assign a value to Ignore_weasel data member. More...
 
TIgnore_weaselSetIgnore_weasel (void)
 Assign a value to Ignore_weasel data member. More...
 
bool IsSetIs_first_cap (void) const
 Check if a value has been assigned to Is_first_cap data member. More...
 
bool CanGetIs_first_cap (void) const
 Check if it is safe to call GetIs_first_cap method. More...
 
void ResetIs_first_cap (void)
 Reset Is_first_cap data member. More...
 
void SetDefaultIs_first_cap (void)
 Assign default value to Is_first_cap data member. More...
 
TIs_first_cap GetIs_first_cap (void) const
 Get the Is_first_cap member data. More...
 
void SetIs_first_cap (TIs_first_cap value)
 Assign a value to Is_first_cap data member. More...
 
TIs_first_capSetIs_first_cap (void)
 Assign a value to Is_first_cap data member. More...
 
bool IsSetIs_first_each_cap (void) const
 Check if a value has been assigned to Is_first_each_cap data member. More...
 
bool CanGetIs_first_each_cap (void) const
 Check if it is safe to call GetIs_first_each_cap method. More...
 
void ResetIs_first_each_cap (void)
 Reset Is_first_each_cap data member. More...
 
void SetDefaultIs_first_each_cap (void)
 Assign default value to Is_first_each_cap data member. More...
 
TIs_first_each_cap GetIs_first_each_cap (void) const
 Get the Is_first_each_cap member data. More...
 
void SetIs_first_each_cap (TIs_first_each_cap value)
 Assign a value to Is_first_each_cap data member. More...
 
TIs_first_each_capSetIs_first_each_cap (void)
 Assign a value to Is_first_each_cap 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
 

Static Public Attributes

static const vector< strings_WeaselWords
 
- 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...
 

Private Types

enum  ECase { e_original , e_lowercase , e_uppercase , e_automatic }
 
typedef CString_constraint_Base Tparent
 

Private Member Functions

 CString_constraint (const CString_constraint &value)=delete
 
CString_constraintoperator= (const CString_constraint &value)=delete
 
CTempString x_GetConstraintString (ECase e_case=e_automatic) const
 
CTempString x_GetCompareString (const CMatchString &s, ECase e_case=e_automatic) const
 
bool x_DoesSingleStringMatchConstraint (const CMatchString &str) const
 
bool x_IsAllCaps (const CMatchString &str) const
 
bool x_IsAllLowerCase (const CMatchString &str) const
 
bool x_IsAllPunctuation (const CMatchString &str) const
 
bool x_IsSkippable (const char ch) const
 
bool x_IsAllSkippable (const CTempString &str) const
 
bool x_IsFirstCap (const CMatchString &str) const
 
bool x_IsFirstEachCap (const CMatchString &str) const
 
bool x_PartialCompare (const string &str, const string &pattern, char prev_char, size_t &match_len) const
 
bool x_AdvancedStringCompare (const string &str, const string &str_match, const char prev_char, size_t *ini_target_match_len=0) const
 
bool x_AdvancedStringMatch (const string &str, const string &tmp_match) const
 
bool x_IsWholeWordMatch (const CTempString &start, size_t found, size_t match_len, bool disallow_slash=false) const
 
bool x_MatchFound (CTempString &search, CTempString &pattern) const
 
bool x_ReplaceContains (string &val, const string &replace) const
 

Private Attributes

CMatchString m_match
 

Additional Inherited Members

- Public Types inherited from CString_constraint_Base
enum class  E_memberIndex {
  e__allMandatory = 0 , e_match_text , e_match_location , e_case_sensitive ,
  e_ignore_space , e_ignore_punct , e_ignore_words , e_whole_word ,
  e_not_present , e_is_all_caps , e_is_all_lower , e_is_all_punct ,
  e_ignore_weasel , e_is_first_cap , e_is_first_each_cap
}
 
typedef string TMatch_text
 
typedef EString_location TMatch_location
 
typedef bool TCase_sensitive
 
typedef bool TIgnore_space
 
typedef bool TIgnore_punct
 
typedef CWord_substitution_set TIgnore_words
 
typedef bool TWhole_word
 
typedef bool TNot_present
 
typedef bool TIs_all_caps
 
typedef bool TIs_all_lower
 
typedef bool TIs_all_punct
 
typedef bool TIgnore_weasel
 
typedef bool TIs_first_cap
 
typedef bool TIs_first_each_cap
 
typedef Tparent::CMemberIndex< E_memberIndex, 15 > 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)
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 178 of file String_constraint.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 180 of file String_constraint.hpp.

Member Enumeration Documentation

◆ ECase

Enumerator
e_original 
e_lowercase 
e_uppercase 
e_automatic 

Definition at line 217 of file String_constraint.hpp.

Constructor & Destructor Documentation

◆ CString_constraint() [1/2]

CString_constraint::CString_constraint ( )

Definition at line 193 of file String_constraint.cpp.

◆ ~CString_constraint()

CString_constraint::~CString_constraint ( )
virtual

Definition at line 198 of file String_constraint.cpp.

◆ CString_constraint() [2/2]

CString_constraint::CString_constraint ( const CString_constraint value)
privatedelete

Member Function Documentation

◆ Empty()

bool CString_constraint::Empty ( void  ) const

◆ GetStringsFromObject()

template<class T >
void CString_constraint::GetStringsFromObject ( const T obj,
vector< string > &  strs 
) const
inline

◆ Match()

bool CString_constraint::Match ( const CMatchString str) const

◆ operator=()

CString_constraint& CString_constraint::operator= ( const CString_constraint value)
privatedelete

◆ ReplaceStringConstraintPortionInString()

bool CString_constraint::ReplaceStringConstraintPortionInString ( string result,
const CMatchString str,
const string replace 
) const

◆ SetMatch_text() [1/2]

void CString_constraint::SetMatch_text ( const TMatch_text value)
inline

◆ SetMatch_text() [2/2]

TMatch_text& CString_constraint::SetMatch_text ( void  )
inline

◆ x_AdvancedStringCompare()

bool CString_constraint::x_AdvancedStringCompare ( const string str,
const string str_match,
const char  prev_char,
size_t *  ini_target_match_len = 0 
) const
private

◆ x_AdvancedStringMatch()

bool CString_constraint::x_AdvancedStringMatch ( const string str,
const string tmp_match 
) const
private

◆ x_DoesSingleStringMatchConstraint()

bool CString_constraint::x_DoesSingleStringMatchConstraint ( const CMatchString str) const
private

◆ x_GetCompareString()

CTempString CString_constraint::x_GetCompareString ( const CMatchString s,
ECase  e_case = e_automatic 
) const
private

◆ x_GetConstraintString()

CTempString CString_constraint::x_GetConstraintString ( ECase  e_case = e_automatic) const
private

◆ x_IsAllCaps()

bool CString_constraint::x_IsAllCaps ( const CMatchString str) const
private

Definition at line 218 of file String_constraint.cpp.

References e_original, e_uppercase, str(), and x_GetCompareString().

Referenced by x_DoesSingleStringMatchConstraint().

◆ x_IsAllLowerCase()

bool CString_constraint::x_IsAllLowerCase ( const CMatchString str) const
private

Definition at line 223 of file String_constraint.cpp.

References e_lowercase, e_original, str(), and x_GetCompareString().

Referenced by x_DoesSingleStringMatchConstraint().

◆ x_IsAllPunctuation()

bool CString_constraint::x_IsAllPunctuation ( const CMatchString str) const
private

Definition at line 228 of file String_constraint.cpp.

References e_original, i, ispunct(), match(), str(), and x_GetCompareString().

Referenced by x_DoesSingleStringMatchConstraint().

◆ x_IsAllSkippable()

bool CString_constraint::x_IsAllSkippable ( const CTempString str) const
private

Definition at line 248 of file String_constraint.cpp.

References i, match(), and x_IsSkippable().

Referenced by x_PartialCompare().

◆ x_IsFirstCap()

bool CString_constraint::x_IsFirstCap ( const CMatchString str) const
private

◆ x_IsFirstEachCap()

bool CString_constraint::x_IsFirstEachCap ( const CMatchString str) const
private

◆ x_IsSkippable()

bool CString_constraint::x_IsSkippable ( const char  ch) const
private

◆ x_IsWholeWordMatch()

bool CString_constraint::x_IsWholeWordMatch ( const CTempString start,
size_t  found,
size_t  match_len,
bool  disallow_slash = false 
) const
private

Definition at line 303 of file String_constraint.cpp.

References CTempString::empty(), and CTempString::size().

Referenced by x_MatchFound().

◆ x_MatchFound()

bool CString_constraint::x_MatchFound ( CTempString search,
CTempString pattern 
) const
private

◆ x_PartialCompare()

bool CString_constraint::x_PartialCompare ( const string str,
const string pattern,
char  prev_char,
size_t &  match_len 
) const
private

◆ x_ReplaceContains()

bool CString_constraint::x_ReplaceContains ( string val,
const string replace 
) const
private

Member Data Documentation

◆ m_match

CMatchString CString_constraint::m_match
mutableprivate

◆ s_WeaselWords

const vector< string > CString_constraint::s_WeaselWords
static
Initial value:
= {
"candidate",
"hypothetical",
"novel",
"possible",
"potential",
"predicted",
"probable",
"putative",
"uncharacterized",
"unique"
}

Definition at line 210 of file String_constraint.hpp.

Referenced by x_DoesSingleStringMatchConstraint(), and CMatchString::x_PopWeasel().


The documentation for this class was generated from the following files:
Modified on Thu Apr 25 08:17:34 2024 by modify_doxy.py rev. 669887