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)

CPluginValueConstraint &	operator, (const string &val)

CPluginValueConstraint &	operator, (int val)

Public Member Functions inherited from CPluginValueConstraint_Base
	CPluginValueConstraint_Base (void)

virtual	~CPluginValueConstraint_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

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 TLower &	GetLower (void) const
	Get the variant data. More...

TLower &	SetLower (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 TUpper &	GetUpper (void) const
	Get the variant data. More...

TUpper &	SetUpper (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 TRange &	GetRange (void) const
	Get the variant data. More...

TRange &	SetRange (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 TSet &	GetSet (void) const
	Get the variant data. More...

TSet &	SetSet (void)
	Select the variant. More...

bool	IsSeq_repr (void) const
	Check if variant Seq_repr is selected. More...

const TSeq_repr &	GetSeq_repr (void) const
	Get the variant data. More...

TSeq_repr &	SetSeq_repr (void)
	Select the variant. More...

bool	IsSeq_mol (void) const
	Check if variant Seq_mol is selected. More...

const TSeq_mol &	GetSeq_mol (void) const
	Get the variant data. More...

TSeq_mol &	SetSeq_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_lower &	SetSeq_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_upper &	SetSeq_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_range &	GetSeq_length_range (void) const
	Get the variant data. More...

TSeq_length_range &	SetSeq_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_type &	SetEntry_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_type &	SetAnnot_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_type &	GetFeat_type (void) const
	Get the variant data. More...

TFeat_type &	SetFeat_type (void)
	Select the variant. More...

bool	IsFeat_subtype (void) const
	Check if variant Feat_subtype is selected. More...

const TFeat_subtype &	GetFeat_subtype (void) const
	Get the variant data. More...

TFeat_subtype &	SetFeat_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_type &	GetProject_item_type (void) const
	Get the variant data. More...

TProject_item_type &	SetProject_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 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

Static Public Member Functions
static CPluginValueConstraint *	CreateLower (const string &low_val)

static CPluginValueConstraint *	CreateUpper (const string &hi_val)

static CPluginValueConstraint *	CreateRange (const string &low_val, const string &hi_val)

static CPluginValueConstraint *	CreateSet (void)

static CPluginValueConstraint *	CreateSeqRepr ()

static CPluginValueConstraint *	CreateSeqMol ()

static CPluginValueConstraint *	CreateSeqSameMol (void)

static CPluginValueConstraint *	CreateSeqLenLower (TSeqPos min_len)

static CPluginValueConstraint *	CreateSeqLenUpper (TSeqPos max_len)

static CPluginValueConstraint *	CreateSeqLenRange (TSeqPos min_len, TSeqPos max_len)

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

static CPluginValueConstraint *	CreateFeatType ()

static CPluginValueConstraint *	CreateFeatSubtype ()

static CPluginValueConstraint *	CreateFeatProduct ()

static CPluginValueConstraint *	CreateProjectItemType (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)

CPluginValueConstraint &	operator= (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< string >	TSet

typedef list< int >	TSeq_repr

typedef list< int >	TSeq_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< int >	TFeat_type

typedef list< int >	TFeat_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< Uint8 >	TCounter
	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

typedef CPluginValueConstraint_Base CPluginValueConstraint::Tparent

private

Definition at line 55 of file PluginValueConstraint.hpp.

Constructor & Destructor Documentation

◆ CPluginValueConstraint() [1/2]

CPluginValueConstraint::CPluginValueConstraint ( void )

inline

Definition at line 140 of file PluginValueConstraint.hpp.

Referenced by CreateAnnotType(), CreateFeatProduct(), CreateFeatSubtype(), CreateFeatType(), CreateLower(), CreateProjectItemType(), CreateRange(), CreateSeqLenLower(), CreateSeqLenRange(), CreateSeqLenUpper(), CreateSeqMol(), CreateSeqRepr(), CreateSeqSameMol(), CreateSet(), and CreateUpper().

◆ ~CPluginValueConstraint()

CPluginValueConstraint::~CPluginValueConstraint ( void )

Definition at line 52 of file PluginValueConstraint.cpp.

◆ CPluginValueConstraint() [2/2]

CPluginValueConstraint::CPluginValueConstraint ( const CPluginValueConstraint & value )

private

Member Function Documentation

◆ CreateAnnotType()

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

static

Definition at line 153 of file PluginValueConstraint.cpp.

References CPluginValueConstraint(), and CRef< C, Locker >::Release().

◆ CreateFeatProduct()

CPluginValueConstraint * CPluginValueConstraint::CreateFeatProduct ( )

static

Definition at line 180 of file PluginValueConstraint.cpp.

References CPluginValueConstraint(), and CRef< C, Locker >::Release().

◆ CreateFeatSubtype()

CPluginValueConstraint * CPluginValueConstraint::CreateFeatSubtype ( )

static

Definition at line 171 of file PluginValueConstraint.cpp.

References CPluginValueConstraint(), and CRef< C, Locker >::Release().

◆ CreateFeatType()

CPluginValueConstraint * CPluginValueConstraint::CreateFeatType ( )

static

Definition at line 162 of file PluginValueConstraint.cpp.

References CPluginValueConstraint(), and CRef< C, Locker >::Release().

◆ CreateLower()

CPluginValueConstraint * CPluginValueConstraint::CreateLower ( const string & low_val )

static

Definition at line 59 of file PluginValueConstraint.cpp.

References CPluginValueConstraint(), and CRef< C, Locker >::Release().

◆ CreateProjectItemType()

CPluginValueConstraint * CPluginValueConstraint::CreateProjectItemType ( const CTypeInfo * info )

static

Definition at line 189 of file PluginValueConstraint.cpp.

References CPluginValueConstraint(), info, and CRef< C, Locker >::Release().

◆ CreateRange()

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

static

Definition at line 77 of file PluginValueConstraint.cpp.

References CPluginValueConstraint(), and CRef< C, Locker >::Release().

◆ CreateSeqLenLower()

CPluginValueConstraint * CPluginValueConstraint::CreateSeqLenLower ( TSeqPos min_len )

static

Definition at line 124 of file PluginValueConstraint.cpp.

References CPluginValueConstraint(), and CRef< C, Locker >::Release().

◆ CreateSeqLenRange()

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

static

Definition at line 142 of file PluginValueConstraint.cpp.

References CPluginValueConstraint(), NStr::IntToString(), compile_time_bits::range(), and CRef< C, Locker >::Release().

◆ CreateSeqLenUpper()

CPluginValueConstraint * CPluginValueConstraint::CreateSeqLenUpper ( TSeqPos max_len )

static

Definition at line 133 of file PluginValueConstraint.cpp.

References CPluginValueConstraint(), and CRef< C, Locker >::Release().

◆ CreateSeqMol()

CPluginValueConstraint * CPluginValueConstraint::CreateSeqMol ( void )

static

Definition at line 106 of file PluginValueConstraint.cpp.

References CPluginValueConstraint(), and CRef< C, Locker >::Release().

◆ CreateSeqRepr()

CPluginValueConstraint * CPluginValueConstraint::CreateSeqRepr ( void )

static

Definition at line 97 of file PluginValueConstraint.cpp.

References CPluginValueConstraint(), and CRef< C, Locker >::Release().

◆ CreateSeqSameMol()

CPluginValueConstraint * CPluginValueConstraint::CreateSeqSameMol ( void )

static

Definition at line 115 of file PluginValueConstraint.cpp.

References CPluginValueConstraint(), and CRef< C, Locker >::Release().

◆ CreateSet()

CPluginValueConstraint * CPluginValueConstraint::CreateSet ( void )

static

Definition at line 88 of file PluginValueConstraint.cpp.

References CPluginValueConstraint(), and CRef< C, Locker >::Release().

◆ CreateUpper()

CPluginValueConstraint * CPluginValueConstraint::CreateUpper ( const string & hi_val )

static

Definition at line 68 of file PluginValueConstraint.cpp.

References CPluginValueConstraint(), and CRef< C, Locker >::Release().

◆ operator,() [1/2]

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

Definition at line 200 of file PluginValueConstraint.cpp.

References CPluginValueConstraint_Base::e_Set, NCBI_THROW, CPluginValueConstraint_Base::SetSet(), val, and CPluginValueConstraint_Base::Which().

◆ operator,() [2/2]

CPluginValueConstraint & CPluginValueConstraint::operator, ( int val )

Definition at line 216 of file PluginValueConstraint.cpp.

References CPluginValueConstraint_Base::e_Feat_subtype, CPluginValueConstraint_Base::e_Feat_type, CPluginValueConstraint_Base::e_Seq_mol, CPluginValueConstraint_Base::e_Seq_repr, NCBI_THROW, CPluginValueConstraint_Base::SetFeat_subtype(), CPluginValueConstraint_Base::SetFeat_type(), CPluginValueConstraint_Base::SetSeq_mol(), CPluginValueConstraint_Base::SetSeq_repr(), val, and CPluginValueConstraint_Base::Which().

◆ operator=()

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

private

The documentation for this class was generated from the following files:

include/gui/objects/PluginValueConstraint.hpp
src/gui/objects/PluginValueConstraint.cpp

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Tparent

Constructor & Destructor Documentation

◆ CPluginValueConstraint() [1/2]

◆ ~CPluginValueConstraint()

◆ CPluginValueConstraint() [2/2]

Member Function Documentation

◆ CreateAnnotType()

◆ CreateFeatProduct()

◆ CreateFeatSubtype()

◆ CreateFeatType()

◆ CreateLower()

◆ CreateProjectItemType()

◆ CreateRange()

◆ CreateSeqLenLower()

◆ CreateSeqLenRange()

◆ CreateSeqLenUpper()

◆ CreateSeqMol()

◆ CreateSeqRepr()

◆ CreateSeqSameMol()

◆ CreateSet()

◆ CreateUpper()

◆ operator,() [1/2]

◆ operator,() [2/2]

◆ operator=()