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

Represents ASN.1 type PluginValueConstraint defined in file gui_objects.asn

Search Toolkit Book for CPluginValueConstraint

#include <gui/objects/PluginValueConstraint.hpp>

+ Inheritance diagram for CPluginValueConstraint:
+ Collaboration diagram for CPluginValueConstraint:

Public Member Functions

 CPluginValueConstraint (void)
 ~CPluginValueConstraint (void)
CPluginValueConstraintoperator, (const string &val)
CPluginValueConstraintoperator, (int val)
- Public Member Functions inherited from CPluginValueConstraint_Base
 CPluginValueConstraint_Base (void)
virtual ~CPluginValueConstraint_Base (void)
virtual void Reset (void)
 Reset the whole object. More...
virtual void ResetSelection (void)
 Reset the selection (set it to e_not_set). More...
E_Choice Which (void) const
 Which variant is currently selected. More...
void CheckSelected (E_Choice index) const
 Verify selection, throw exception if it differs from the expected. More...
void ThrowInvalidSelection (E_Choice index) const
 Throw 'InvalidSelection' exception. More...
void Select (E_Choice index, EResetVariant reset=eDoResetVariant)
 Select the requested variant if needed. More...
void Select (E_Choice index, EResetVariant reset, CObjectMemoryPool *pool)
 Select the requested variant if needed, allocating CObject variants from memory pool. More...
bool IsLower (void) const
 Check if variant Lower is selected. More...
const TLowerGetLower (void) const
 Get the variant data. More...
TLowerSetLower (void)
 Select the variant. More...
void SetLower (const TLower &value)
 Select the variant and set its data. More...
bool IsUpper (void) const
 Check if variant Upper is selected. More...
const TUpperGetUpper (void) const
 Get the variant data. More...
TUpperSetUpper (void)
 Select the variant. More...
void SetUpper (const TUpper &value)
 Select the variant and set its data. More...
bool IsRange (void) const
 Check if variant Range is selected. More...
const TRangeGetRange (void) const
 Get the variant data. More...
TRangeSetRange (void)
 Select the variant. More...
void SetRange (TRange &value)
 Select the variant and set its data. More...
bool IsSet (void) const
 Check if variant Set is selected. More...
const TSetGetSet (void) const
 Get the variant data. More...
TSetSetSet (void)
 Select the variant. More...
bool IsSeq_repr (void) const
 Check if variant Seq_repr is selected. More...
const TSeq_reprGetSeq_repr (void) const
 Get the variant data. More...
TSeq_reprSetSeq_repr (void)
 Select the variant. More...
bool IsSeq_mol (void) const
 Check if variant Seq_mol is selected. More...
const TSeq_molGetSeq_mol (void) const
 Get the variant data. More...
TSeq_molSetSeq_mol (void)
 Select the variant. More...
bool IsSeq_mol_same_type (void) const
 Check if variant Seq_mol_same_type is selected. More...
void SetSeq_mol_same_type (void)
 Select the variant. More...
bool IsSeq_length_lower (void) const
 Check if variant Seq_length_lower is selected. More...
TSeq_length_lower GetSeq_length_lower (void) const
 Get the variant data. More...
TSeq_length_lowerSetSeq_length_lower (void)
 Select the variant. More...
void SetSeq_length_lower (TSeq_length_lower value)
 Select the variant and set its data. More...
bool IsSeq_length_upper (void) const
 Check if variant Seq_length_upper is selected. More...
TSeq_length_upper GetSeq_length_upper (void) const
 Get the variant data. More...
TSeq_length_upperSetSeq_length_upper (void)
 Select the variant. More...
void SetSeq_length_upper (TSeq_length_upper value)
 Select the variant and set its data. More...
bool IsSeq_length_range (void) const
 Check if variant Seq_length_range is selected. More...
const TSeq_length_rangeGetSeq_length_range (void) const
 Get the variant data. More...
TSeq_length_rangeSetSeq_length_range (void)
 Select the variant. More...
void SetSeq_length_range (TSeq_length_range &value)
 Select the variant and set its data. More...
bool IsSeq_length_same (void) const
 Check if variant Seq_length_same is selected. More...
void SetSeq_length_same (void)
 Select the variant. More...
bool IsEntry_type (void) const
 Check if variant Entry_type is selected. More...
TEntry_type GetEntry_type (void) const
 Get the variant data. More...
TEntry_typeSetEntry_type (void)
 Select the variant. More...
void SetEntry_type (TEntry_type value)
 Select the variant and set its data. More...
bool IsAnnot_type (void) const
 Check if variant Annot_type is selected. More...
TAnnot_type GetAnnot_type (void) const
 Get the variant data. More...
TAnnot_typeSetAnnot_type (void)
 Select the variant. More...
void SetAnnot_type (TAnnot_type value)
 Select the variant and set its data. More...
bool IsFeat_type (void) const
 Check if variant Feat_type is selected. More...
const TFeat_typeGetFeat_type (void) const
 Get the variant data. More...
TFeat_typeSetFeat_type (void)
 Select the variant. More...
bool IsFeat_subtype (void) const
 Check if variant Feat_subtype is selected. More...
const TFeat_subtypeGetFeat_subtype (void) const
 Get the variant data. More...
TFeat_subtypeSetFeat_subtype (void)
 Select the variant. More...
bool IsFeat_has_product (void) const
 Check if variant Feat_has_product is selected. More...
void SetFeat_has_product (void)
 Select the variant. More...
bool IsProject_item_type (void) const
 Check if variant Project_item_type is selected. More...
const TProject_item_typeGetProject_item_type (void) const
 Get the variant data. More...
TProject_item_typeSetProject_item_type (void)
 Select the variant. More...
void SetProject_item_type (const TProject_item_type &value)
 Select the variant and set its data. 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 Member Functions

static CPluginValueConstraintCreateLower (const string &low_val)
static CPluginValueConstraintCreateUpper (const string &hi_val)
static CPluginValueConstraintCreateRange (const string &low_val, const string &hi_val)
static CPluginValueConstraintCreateSet (void)
static CPluginValueConstraintCreateSeqRepr ()
static CPluginValueConstraintCreateSeqMol ()
static CPluginValueConstraintCreateSeqSameMol (void)
static CPluginValueConstraintCreateSeqLenLower (TSeqPos min_len)
static CPluginValueConstraintCreateSeqLenUpper (TSeqPos max_len)
static CPluginValueConstraintCreateSeqLenRange (TSeqPos min_len, TSeqPos max_len)
static CPluginValueConstraintCreateAnnotType (CSeq_annot::TData::E_Choice)
static CPluginValueConstraintCreateFeatType ()
static CPluginValueConstraintCreateFeatSubtype ()
static CPluginValueConstraintCreateFeatProduct ()
static CPluginValueConstraintCreateProjectItemType (const CTypeInfo *info)
- Static Public Member Functions inherited from CPluginValueConstraint_Base
static string SelectionName (E_Choice index)
 Retrieve selection name (for diagnostic purposes). 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)

Private Types

typedef CPluginValueConstraint_Base Tparent

Private Member Functions

 CPluginValueConstraint (const CPluginValueConstraint &value)
CPluginValueConstraintoperator= (const CPluginValueConstraint &value)

Additional Inherited Members

- Public Types inherited from CPluginValueConstraint_Base
enum  E_Choice {
  e_not_set = 0 , e_Lower , e_Upper , e_Range ,
  e_Set , e_Seq_repr , e_Seq_mol , e_Seq_mol_same_type ,
  e_Seq_length_lower , e_Seq_length_upper , e_Seq_length_range , e_Seq_length_same ,
  e_Entry_type , e_Annot_type , e_Feat_type , e_Feat_subtype ,
  e_Feat_has_product , e_Project_item_type
 Choice variants. More...
enum  E_ChoiceStopper { e_MaxChoice = 18 }
 Maximum+1 value of the choice variant enumerator. More...
typedef string TLower
typedef string TUpper
typedef CPluginValueRangeConstraint TRange
typedef list< stringTSet
typedef list< intTSeq_repr
typedef list< intTSeq_mol
typedef int TSeq_length_lower
typedef int TSeq_length_upper
typedef CPluginValueRangeConstraint TSeq_length_range
typedef int TEntry_type
typedef int TAnnot_type
typedef list< intTFeat_type
typedef list< intTFeat_subtype
typedef string TProject_item_type
- 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 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 PluginValueConstraint.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 55 of file PluginValueConstraint.hpp.

Constructor & Destructor Documentation

◆ CPluginValueConstraint() [1/2]

CPluginValueConstraint::CPluginValueConstraint ( void  )

◆ ~CPluginValueConstraint()

CPluginValueConstraint::~CPluginValueConstraint ( void  )

Definition at line 52 of file PluginValueConstraint.cpp.

◆ CPluginValueConstraint() [2/2]

CPluginValueConstraint::CPluginValueConstraint ( const CPluginValueConstraint value)

Member Function Documentation

◆ CreateAnnotType()

CPluginValueConstraint * CPluginValueConstraint::CreateAnnotType ( CSeq_annot::TData::E_Choice  type)

◆ CreateFeatProduct()

CPluginValueConstraint * CPluginValueConstraint::CreateFeatProduct ( )

◆ CreateFeatSubtype()

CPluginValueConstraint * CPluginValueConstraint::CreateFeatSubtype ( )

◆ CreateFeatType()

CPluginValueConstraint * CPluginValueConstraint::CreateFeatType ( )

◆ CreateLower()

CPluginValueConstraint * CPluginValueConstraint::CreateLower ( const string low_val)

◆ CreateProjectItemType()

CPluginValueConstraint * CPluginValueConstraint::CreateProjectItemType ( const CTypeInfo info)

◆ CreateRange()

CPluginValueConstraint * CPluginValueConstraint::CreateRange ( const string low_val,
const string hi_val 

◆ CreateSeqLenLower()

CPluginValueConstraint * CPluginValueConstraint::CreateSeqLenLower ( TSeqPos  min_len)

◆ CreateSeqLenRange()

CPluginValueConstraint * CPluginValueConstraint::CreateSeqLenRange ( TSeqPos  min_len,
TSeqPos  max_len 

◆ CreateSeqLenUpper()

CPluginValueConstraint * CPluginValueConstraint::CreateSeqLenUpper ( TSeqPos  max_len)

◆ CreateSeqMol()

CPluginValueConstraint * CPluginValueConstraint::CreateSeqMol ( void  )

◆ CreateSeqRepr()

CPluginValueConstraint * CPluginValueConstraint::CreateSeqRepr ( void  )

◆ CreateSeqSameMol()

CPluginValueConstraint * CPluginValueConstraint::CreateSeqSameMol ( void  )

◆ CreateSet()

CPluginValueConstraint * CPluginValueConstraint::CreateSet ( void  )

◆ CreateUpper()

CPluginValueConstraint * CPluginValueConstraint::CreateUpper ( const string hi_val)

◆ operator,() [1/2]

CPluginValueConstraint & CPluginValueConstraint::operator, ( const string val)

◆ operator,() [2/2]

CPluginValueConstraint & CPluginValueConstraint::operator, ( int  val)

◆ operator=()

CPluginValueConstraint& CPluginValueConstraint::operator= ( const CPluginValueConstraint value)

The documentation for this class was generated from the following files:
Modified on Wed Jun 07 02:56:12 2023 by rev. 662518