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

Represents ASN.1 type TMgr-Message defined in file trackmgr.asn

Search Toolkit Book for CTMgr_Message

#include <objects/trackmgr/TMgr_Message.hpp>

+ Inheritance diagram for CTMgr_Message:
+ Collaboration diagram for CTMgr_Message:

Public Member Functions

 CTMgr_Message (void)
 
 CTMgr_Message (TLevel level)
 
 CTMgr_Message (TLevel level, const TMessage &message)
 
 ~CTMgr_Message (void)
 
 operator string () const
 
- Public Member Functions inherited from CTMgr_Message_Base
 CTMgr_Message_Base (void)
 
virtual ~CTMgr_Message_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetLevel (void) const
 Check if a value has been assigned to Level data member. More...
 
bool CanGetLevel (void) const
 Check if it is safe to call GetLevel method. More...
 
void ResetLevel (void)
 Reset Level data member. More...
 
TLevel GetLevel (void) const
 Get the Level member data. More...
 
void SetLevel (TLevel value)
 Assign a value to Level data member. More...
 
TLevelSetLevel (void)
 Assign a value to Level data member. More...
 
bool IsSetMessage (void) const
 Check if a value has been assigned to Message data member. More...
 
bool CanGetMessage (void) const
 Check if it is safe to call GetMessage method. More...
 
void ResetMessage (void)
 Reset Message data member. More...
 
const TMessageGetMessage (void) const
 Get the Message member data. More...
 
void SetMessage (const TMessage &value)
 Assign a value to Message data member. More...
 
void SetMessage (TMessage &&value)
 
TMessageSetMessage (void)
 Assign a value to Message 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 int GetDefaultMesgLevel (void)
 
static int GetMesgLevel (const string &level)
 
- 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 CTMgr_Message_Base Tparent
 

Private Member Functions

 CTMgr_Message (const CTMgr_Message &value)
 
CTMgr_Messageoperator= (const CTMgr_Message &value)
 

Additional Inherited Members

- Public Types inherited from CTMgr_Message_Base
enum class  E_memberIndex { e__allMandatory = 0 , e_level , e_message }
 
typedef int TLevel
 
typedef string TMessage
 
typedef Tparent::CMemberIndex< E_memberIndex, 3 > 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 52 of file TMgr_Message.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 54 of file TMgr_Message.hpp.

Constructor & Destructor Documentation

◆ CTMgr_Message() [1/4]

CTMgr_Message::CTMgr_Message ( void  )
inline

Definition at line 87 of file TMgr_Message.hpp.

◆ CTMgr_Message() [2/4]

CTMgr_Message::CTMgr_Message ( TLevel  level)

Definition at line 44 of file TMgr_Message.cpp.

References CTMgr_Message_Base::SetLevel().

◆ CTMgr_Message() [3/4]

CTMgr_Message::CTMgr_Message ( TLevel  level,
const TMessage message 
)

◆ ~CTMgr_Message()

CTMgr_Message::~CTMgr_Message ( void  )

Definition at line 57 of file TMgr_Message.cpp.

◆ CTMgr_Message() [4/4]

CTMgr_Message::CTMgr_Message ( const CTMgr_Message value)
private

Member Function Documentation

◆ GetDefaultMesgLevel()

static int CTMgr_Message::GetDefaultMesgLevel ( void  )
inlinestatic

Definition at line 67 of file TMgr_Message.hpp.

References eTMgr_MessageLevel_info.

◆ GetMesgLevel()

static int CTMgr_Message::GetMesgLevel ( const string level)
inlinestatic

Definition at line 72 of file TMgr_Message.hpp.

References CEnumeratedTypeValues::FindValue().

◆ operator string()

CTMgr_Message::operator string ( ) const
inline

◆ operator=()

CTMgr_Message& CTMgr_Message::operator= ( const CTMgr_Message value)
private

The documentation for this class was generated from the following files:
Modified on Sat Jun 22 10:40:43 2024 by modify_doxy.py rev. 669887