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

Search Toolkit Book for CValidErrItem

#include <objects/valerr/ValidErrItem.hpp>

+ Inheritance diagram for CValidErrItem:
+ Collaboration diagram for CValidErrItem:

Public Member Functions

 CValidErrItem ()
 
 ~CValidErrItem ()
 
EDiagSev GetSeverity () const
 
const string GetErrCode () const
 
const string GetErrGroup () const
 
const string GetVerbose () const
 
const CSerialObjectGetObject () const
 
bool IsSetObject () const
 
void SetObject (const CSerialObject &obj)
 
bool IsSetContext () const
 
const CSeq_entryGetContext () const
 
void SetContext (CConstRef< CSeq_entry > ctx)
 
void SetFeatureObjDescFromFields ()
 
 CValidErrItem (EDiagSev sev, unsigned int ec, const string &msg, const string &obj_desc, const CSerialObject *obj, const CSeq_entry *context, const string &acc, const int ver, const int seq_offset=0)
 
- Public Member Functions inherited from CValidErrItem_Base
 CValidErrItem_Base (void)
 
virtual ~CValidErrItem_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetSev (void) const
 Check if a value has been assigned to Sev data member. More...
 
bool CanGetSev (void) const
 Check if it is safe to call GetSev method. More...
 
void ResetSev (void)
 Reset Sev data member. More...
 
TSev GetSev (void) const
 Get the Sev member data. More...
 
void SetSev (TSev value)
 Assign a value to Sev data member. More...
 
TSevSetSev (void)
 Assign a value to Sev data member. More...
 
bool IsSetErrIndex (void) const
 Check if a value has been assigned to ErrIndex data member. More...
 
bool CanGetErrIndex (void) const
 Check if it is safe to call GetErrIndex method. More...
 
void ResetErrIndex (void)
 Reset ErrIndex data member. More...
 
TErrIndex GetErrIndex (void) const
 Get the ErrIndex member data. More...
 
void SetErrIndex (TErrIndex value)
 Assign a value to ErrIndex data member. More...
 
TErrIndexSetErrIndex (void)
 Assign a value to ErrIndex data member. More...
 
bool IsSetMsg (void) const
 Check if a value has been assigned to Msg data member. More...
 
bool CanGetMsg (void) const
 Check if it is safe to call GetMsg method. More...
 
void ResetMsg (void)
 Reset Msg data member. More...
 
const TMsgGetMsg (void) const
 Get the Msg member data. More...
 
void SetMsg (const TMsg &value)
 Assign a value to Msg data member. More...
 
void SetMsg (TMsg &&value)
 
TMsgSetMsg (void)
 Assign a value to Msg data member. More...
 
bool IsSetObjDesc (void) const
 Check if a value has been assigned to ObjDesc data member. More...
 
bool CanGetObjDesc (void) const
 Check if it is safe to call GetObjDesc method. More...
 
void ResetObjDesc (void)
 Reset ObjDesc data member. More...
 
const TObjDescGetObjDesc (void) const
 Get the ObjDesc member data. More...
 
void SetObjDesc (const TObjDesc &value)
 Assign a value to ObjDesc data member. More...
 
void SetObjDesc (TObjDesc &&value)
 
TObjDescSetObjDesc (void)
 Assign a value to ObjDesc data member. More...
 
bool IsSetAccession (void) const
 Check if a value has been assigned to Accession data member. More...
 
bool CanGetAccession (void) const
 Check if it is safe to call GetAccession method. More...
 
void ResetAccession (void)
 Reset Accession data member. More...
 
const TAccessionGetAccession (void) const
 Get the Accession member data. More...
 
void SetAccession (const TAccession &value)
 Assign a value to Accession data member. More...
 
void SetAccession (TAccession &&value)
 
TAccessionSetAccession (void)
 Assign a value to Accession data member. More...
 
bool IsSetFeatureId (void) const
 Check if a value has been assigned to FeatureId data member. More...
 
bool CanGetFeatureId (void) const
 Check if it is safe to call GetFeatureId method. More...
 
void ResetFeatureId (void)
 Reset FeatureId data member. More...
 
const TFeatureIdGetFeatureId (void) const
 Get the FeatureId member data. More...
 
void SetFeatureId (const TFeatureId &value)
 Assign a value to FeatureId data member. More...
 
void SetFeatureId (TFeatureId &&value)
 
TFeatureIdSetFeatureId (void)
 Assign a value to FeatureId data member. More...
 
bool IsSetSeqOffset (void) const
 Check if a value has been assigned to SeqOffset data member. More...
 
bool CanGetSeqOffset (void) const
 Check if it is safe to call GetSeqOffset method. More...
 
void ResetSeqOffset (void)
 Reset SeqOffset data member. More...
 
TSeqOffset GetSeqOffset (void) const
 Get the SeqOffset member data. More...
 
void SetSeqOffset (TSeqOffset value)
 Assign a value to SeqOffset data member. More...
 
TSeqOffsetSetSeqOffset (void)
 Assign a value to SeqOffset data member. More...
 
bool IsSetObjectType (void) const
 Check if a value has been assigned to ObjectType data member. More...
 
bool CanGetObjectType (void) const
 Check if it is safe to call GetObjectType method. More...
 
void ResetObjectType (void)
 Reset ObjectType data member. More...
 
TObjectType GetObjectType (void) const
 Get the ObjectType member data. More...
 
void SetObjectType (TObjectType value)
 Assign a value to ObjectType data member. More...
 
TObjectTypeSetObjectType (void)
 Assign a value to ObjectType data member. More...
 
bool IsSetErrorName (void) const
 Check if a value has been assigned to ErrorName data member. More...
 
bool CanGetErrorName (void) const
 Check if it is safe to call GetErrorName method. More...
 
void ResetErrorName (void)
 Reset ErrorName data member. More...
 
const TErrorNameGetErrorName (void) const
 Get the ErrorName member data. More...
 
void SetErrorName (const TErrorName &value)
 Assign a value to ErrorName data member. More...
 
void SetErrorName (TErrorName &&value)
 
TErrorNameSetErrorName (void)
 Assign a value to ErrorName data member. More...
 
bool IsSetErrorGroup (void) const
 Check if a value has been assigned to ErrorGroup data member. More...
 
bool CanGetErrorGroup (void) const
 Check if it is safe to call GetErrorGroup method. More...
 
void ResetErrorGroup (void)
 Reset ErrorGroup data member. More...
 
const TErrorGroupGetErrorGroup (void) const
 Get the ErrorGroup member data. More...
 
void SetErrorGroup (const TErrorGroup &value)
 Assign a value to ErrorGroup data member. More...
 
void SetErrorGroup (TErrorGroup &&value)
 
TErrorGroupSetErrorGroup (void)
 Assign a value to ErrorGroup data member. More...
 
bool IsSetAccnver (void) const
 Check if a value has been assigned to Accnver data member. More...
 
bool CanGetAccnver (void) const
 Check if it is safe to call GetAccnver method. More...
 
void ResetAccnver (void)
 Reset Accnver data member. More...
 
const TAccnverGetAccnver (void) const
 Get the Accnver member data. More...
 
void SetAccnver (const TAccnver &value)
 Assign a value to Accnver data member. More...
 
void SetAccnver (TAccnver &&value)
 
TAccnverSetAccnver (void)
 Assign a value to Accnver data member. More...
 
bool IsSetVersion (void) const
 Check if a value has been assigned to Version data member. More...
 
bool CanGetVersion (void) const
 Check if it is safe to call GetVersion method. More...
 
void ResetVersion (void)
 Reset Version data member. More...
 
TVersion GetVersion (void) const
 Get the Version member data. More...
 
void SetVersion (TVersion value)
 Assign a value to Version data member. More...
 
TVersionSetVersion (void)
 Assign a value to Version data member. More...
 
bool IsSetLocation (void) const
 Check if a value has been assigned to Location data member. More...
 
bool CanGetLocation (void) const
 Check if it is safe to call GetLocation method. More...
 
void ResetLocation (void)
 Reset Location data member. More...
 
const TLocationGetLocation (void) const
 Get the Location member data. More...
 
void SetLocation (const TLocation &value)
 Assign a value to Location data member. More...
 
void SetLocation (TLocation &&value)
 
TLocationSetLocation (void)
 Assign a value to Location data member. More...
 
bool IsSetProduct_loc (void) const
 Check if a value has been assigned to Product_loc data member. More...
 
bool CanGetProduct_loc (void) const
 Check if it is safe to call GetProduct_loc method. More...
 
void ResetProduct_loc (void)
 Reset Product_loc data member. More...
 
const TProduct_locGetProduct_loc (void) const
 Get the Product_loc member data. More...
 
void SetProduct_loc (const TProduct_loc &value)
 Assign a value to Product_loc data member. More...
 
void SetProduct_loc (TProduct_loc &&value)
 
TProduct_locSetProduct_loc (void)
 Assign a value to Product_loc data member. More...
 
bool IsSetBioseq (void) const
 Check if a value has been assigned to Bioseq data member. More...
 
bool CanGetBioseq (void) const
 Check if it is safe to call GetBioseq method. More...
 
void ResetBioseq (void)
 Reset Bioseq data member. More...
 
const TBioseqGetBioseq (void) const
 Get the Bioseq member data. More...
 
void SetBioseq (const TBioseq &value)
 Assign a value to Bioseq data member. More...
 
void SetBioseq (TBioseq &&value)
 
TBioseqSetBioseq (void)
 Assign a value to Bioseq data member. More...
 
bool IsSetLocus_tag (void) const
 Check if a value has been assigned to Locus_tag data member. More...
 
bool CanGetLocus_tag (void) const
 Check if it is safe to call GetLocus_tag method. More...
 
void ResetLocus_tag (void)
 Reset Locus_tag data member. More...
 
const TLocus_tagGetLocus_tag (void) const
 Get the Locus_tag member data. More...
 
void SetLocus_tag (const TLocus_tag &value)
 Assign a value to Locus_tag data member. More...
 
void SetLocus_tag (TLocus_tag &&value)
 
TLocus_tagSetLocus_tag (void)
 Assign a value to Locus_tag data member. More...
 
bool IsSetObj_content (void) const
 Check if a value has been assigned to Obj_content data member. More...
 
bool CanGetObj_content (void) const
 Check if it is safe to call GetObj_content method. More...
 
void ResetObj_content (void)
 Reset Obj_content data member. More...
 
const TObj_contentGetObj_content (void) const
 Get the Obj_content member data. More...
 
void SetObj_content (const TObj_content &value)
 Assign a value to Obj_content data member. More...
 
void SetObj_content (TObj_content &&value)
 
TObj_contentSetObj_content (void)
 Assign a value to Obj_content 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 Member Functions

static size_t GetErrCount ()
 
static const stringConvertSeverity (EDiagSev sev)
 
static const stringConvertErrCode (unsigned int)
 
static const stringConvertErrGroup (unsigned int)
 
static unsigned int ConvertToErrCode (const string &str)
 
- Static Public Member Functions inherited from CValidErrItem_Base
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() ESev (void)
 Access to ESev's attributes (values, names) as defined in spec. More...
 
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() EObjectType (void)
 Access to EObjectType's attributes (values, names) as defined in spec. 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 CValidErrItem_Base Tparent
 

Private Member Functions

 CValidErrItem (const CValidErrItem &value)=delete
 
CValidErrItemoperator= (const CValidErrItem &value)=delete
 

Private Attributes

CConstRef< CSerialObjectm_Object
 
CConstRef< CSeq_entrym_Ctx
 

Static Private Attributes

static const string sm_Terse []
 
static const string sm_Verbose []
 

Additional Inherited Members

- Public Types inherited from CValidErrItem_Base
enum  ESev {
  eSev_info = 0 , eSev_warning = 1 , eSev_error = 2 , eSev_critical = 3 ,
  eSev_fatal = 4 , eSev_trace = 5
}
 
enum  EObjectType {
  eObjectType_seqentry = 1 , eObjectType_bioseq = 2 , eObjectType_bioseqset = 3 , eObjectType_seqdesc = 4 ,
  eObjectType_seqannot = 5 , eObjectType_annotdesc = 6 , eObjectType_seqfeat = 7 , eObjectType_seqalign = 8 ,
  eObjectType_seqgraph = 9 , eObjectType_seqsub = 10 , eObjectType_submitblock = 11
}
 
enum class  E_memberIndex {
  e__allMandatory = 0 , e_sev , e_errIndex , e_msg ,
  e_objDesc , e_accession , e_featureId , e_seqOffset ,
  e_objectType , e_errorName , e_errorGroup , e_accnver ,
  e_version , e_location , e_product_loc , e_bioseq ,
  e_locus_tag , e_obj_content
}
 
typedef int TSev
 
typedef unsigned int TErrIndex
 
typedef string TMsg
 
typedef string TObjDesc
 
typedef string TAccession
 
typedef string TFeatureId
 
typedef int TSeqOffset
 
typedef int TObjectType
 
typedef string TErrorName
 
typedef string TErrorGroup
 
typedef string TAccnver
 
typedef int TVersion
 
typedef string TLocation
 
typedef string TProduct_loc
 
typedef string TBioseq
 
typedef string TLocus_tag
 
typedef string TObj_content
 
typedef Tparent::CMemberIndex< E_memberIndex, 18 > 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 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 815 of file ValidErrItem.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 817 of file ValidErrItem.hpp.

Constructor & Destructor Documentation

◆ CValidErrItem() [1/3]

CValidErrItem::CValidErrItem ( )
inline

Definition at line 885 of file ValidErrItem.hpp.

◆ ~CValidErrItem()

CValidErrItem::~CValidErrItem ( )

Definition at line 2530 of file ValidErrItem.cpp.

◆ CValidErrItem() [2/3]

CValidErrItem::CValidErrItem ( EDiagSev  sev,
unsigned int  ec,
const string msg,
const string obj_desc,
const CSerialObject obj,
const CSeq_entry context,
const string acc,
const int  ver,
const int  seq_offset = 0 
)

◆ CValidErrItem() [3/3]

CValidErrItem::CValidErrItem ( const CValidErrItem value)
privatedelete

Member Function Documentation

◆ ConvertErrCode()

const string & CValidErrItem::ConvertErrCode ( unsigned int  err_int)
static

◆ ConvertErrGroup()

const string & CValidErrItem::ConvertErrGroup ( unsigned int  err_int)
static

◆ ConvertSeverity()

const string & CValidErrItem::ConvertSeverity ( EDiagSev  sev)
static

◆ ConvertToErrCode()

unsigned int CValidErrItem::ConvertToErrCode ( const string str)
static

◆ GetContext()

const CSeq_entry & CValidErrItem::GetContext ( void  ) const
inline

Definition at line 905 of file ValidErrItem.hpp.

References m_Ctx.

◆ GetErrCode()

const string CValidErrItem::GetErrCode ( void  ) const

◆ GetErrCount()

size_t CValidErrItem::GetErrCount ( )
static

Definition at line 2541 of file ValidErrItem.cpp.

◆ GetErrGroup()

const string CValidErrItem::GetErrGroup ( ) const

◆ GetObject()

const CSerialObject & CValidErrItem::GetObject ( void  ) const

Definition at line 2610 of file ValidErrItem.cpp.

References m_Object.

◆ GetSeverity()

EDiagSev CValidErrItem::GetSeverity ( void  ) const
inline

◆ GetVerbose()

const string CValidErrItem::GetVerbose ( void  ) const

Definition at line 2597 of file ValidErrItem.cpp.

References eErr_MAX, eErr_UNKNOWN, and CValidErrItem_Base::GetErrIndex().

◆ IsSetContext()

bool CValidErrItem::IsSetContext ( void  ) const
inline

Definition at line 899 of file ValidErrItem.hpp.

References m_Ctx, and CConstRef< C, Locker >::NotEmpty().

◆ IsSetObject()

bool CValidErrItem::IsSetObject ( ) const

Definition at line 2616 of file ValidErrItem.cpp.

References m_Object, and CConstRef< C, Locker >::NotEmpty().

◆ operator=()

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

◆ SetContext()

void CValidErrItem::SetContext ( CConstRef< CSeq_entry ctx)
inline

Definition at line 848 of file ValidErrItem.hpp.

References ctx, and m_Ctx.

◆ SetFeatureObjDescFromFields()

void CValidErrItem::SetFeatureObjDescFromFields ( )

◆ SetObject()

void CValidErrItem::SetObject ( const CSerialObject obj)

Definition at line 2622 of file ValidErrItem.cpp.

References m_Object, and CConstRef< C, Locker >::Reset().

Referenced by CValidErrItem().

Member Data Documentation

◆ m_Ctx

CConstRef<CSeq_entry> CValidErrItem::m_Ctx
private

Definition at line 875 of file ValidErrItem.hpp.

Referenced by CValidErrItem(), GetContext(), IsSetContext(), and SetContext().

◆ m_Object

CConstRef<CSerialObject> CValidErrItem::m_Object
private

Definition at line 874 of file ValidErrItem.hpp.

Referenced by GetObject(), IsSetObject(), and SetObject().

◆ sm_Terse

const string CValidErrItem::sm_Terse[]
staticprivate

Definition at line 877 of file ValidErrItem.hpp.

◆ sm_Verbose

const string CValidErrItem::sm_Verbose[]
staticprivate

Definition at line 878 of file ValidErrItem.hpp.


The documentation for this class was generated from the following files:
Modified on Fri Sep 20 14:57:06 2024 by modify_doxy.py rev. 669887