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

Represents ASN.1 type ProjectDescr defined in file gbproj.asn

Search Toolkit Book for CProjectDescr

#include <objects/gbproj/ProjectDescr.hpp>

+ Inheritance diagram for CProjectDescr:
+ Collaboration diagram for CProjectDescr:

Public Member Functions

 CProjectDescr (void)
 
 ~CProjectDescr (void)
 
void SetCreateDate (const CTime &time)
 SetCreateDate() will add a descriptor for creation date. More...
 
void SetCreateDate (const CDate &date)
 
CTime GetCreateDate () const
 
void SetModifiedDate (const CTime &time)
 SetModifiedDate() will add a descriptor for the update date. More...
 
void SetModifiedDate (const CDate &date)
 
CTime GetModifiedDate () const
 
- Public Member Functions inherited from CProjectDescr_Base
 CProjectDescr_Base (void)
 
virtual ~CProjectDescr_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetTitle (void) const
 user-defined title for the workspace Check if a value has been assigned to Title data member. More...
 
bool CanGetTitle (void) const
 Check if it is safe to call GetTitle method. More...
 
void ResetTitle (void)
 Reset Title data member. More...
 
const TTitleGetTitle (void) const
 Get the Title member data. More...
 
void SetTitle (const TTitle &value)
 Assign a value to Title data member. More...
 
void SetTitle (TTitle &&value)
 
TTitleSetTitle (void)
 Assign a value to Title data member. More...
 
bool IsSetCreate_date (void) const
 basic (required) descriptors Check if a value has been assigned to Create_date data member. More...
 
bool CanGetCreate_date (void) const
 Check if it is safe to call GetCreate_date method. More...
 
void ResetCreate_date (void)
 Reset Create_date data member. More...
 
const TCreate_dateGetCreate_date (void) const
 Get the Create_date member data. More...
 
void SetCreate_date (TCreate_date &value)
 Assign a value to Create_date data member. More...
 
TCreate_dateSetCreate_date (void)
 Assign a value to Create_date data member. More...
 
bool IsSetModified_date (void) const
 Check if a value has been assigned to Modified_date data member. More...
 
bool CanGetModified_date (void) const
 Check if it is safe to call GetModified_date method. More...
 
void ResetModified_date (void)
 Reset Modified_date data member. More...
 
const TModified_dateGetModified_date (void) const
 Get the Modified_date member data. More...
 
void SetModified_date (TModified_date &value)
 Assign a value to Modified_date data member. More...
 
TModified_dateSetModified_date (void)
 Assign a value to Modified_date data member. More...
 
bool IsSetComment (void) const
 optional descriptors Check if a value has been assigned to Comment data member. More...
 
bool CanGetComment (void) const
 Check if it is safe to call GetComment method. More...
 
void ResetComment (void)
 Reset Comment data member. More...
 
const TCommentGetComment (void) const
 Get the Comment member data. More...
 
void SetComment (const TComment &value)
 Assign a value to Comment data member. More...
 
void SetComment (TComment &&value)
 
TCommentSetComment (void)
 Assign a value to Comment 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
 

Private Types

typedef CProjectDescr_Base Tparent
 

Private Member Functions

 CProjectDescr (const CProjectDescr &value)
 
CProjectDescroperator= (const CProjectDescr &value)
 

Additional Inherited Members

- Public Types inherited from CProjectDescr_Base
enum class  E_memberIndex {
  e__allMandatory = 0 , e_title , e_create_date , e_modified_date ,
  e_comment
}
 
typedef string TTitle
 
typedef CDate TCreate_date
 
typedef CDate TModified_date
 
typedef string TComment
 
typedef Tparent::CMemberIndex< E_memberIndex, 5 > 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)
 
- 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 ProjectDescr.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 55 of file ProjectDescr.hpp.

Constructor & Destructor Documentation

◆ CProjectDescr() [1/2]

CProjectDescr::CProjectDescr ( void  )
inline

Definition at line 85 of file ProjectDescr.hpp.

◆ ~CProjectDescr()

CProjectDescr::~CProjectDescr ( void  )

Definition at line 50 of file ProjectDescr.cpp.

◆ CProjectDescr() [2/2]

CProjectDescr::CProjectDescr ( const CProjectDescr value)
private

Member Function Documentation

◆ GetCreateDate()

CTime CProjectDescr::GetCreateDate ( ) const

Definition at line 68 of file ProjectDescr.cpp.

References CDate::AsCTime(), and CProjectDescr_Base::GetCreate_date().

◆ GetModifiedDate()

CTime CProjectDescr::GetModifiedDate ( ) const

◆ operator=()

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

◆ SetCreateDate() [1/2]

void CProjectDescr::SetCreateDate ( const CDate date)

◆ SetCreateDate() [2/2]

void CProjectDescr::SetCreateDate ( const CTime time)

SetCreateDate() will add a descriptor for creation date.

Definition at line 56 of file ProjectDescr.cpp.

Referenced by CSelectProjectOptions::CreateProject(), and CGBProject_ver2::SetCreateDate().

◆ SetModifiedDate() [1/2]

void CProjectDescr::SetModifiedDate ( const CDate date)

◆ SetModifiedDate() [2/2]

void CProjectDescr::SetModifiedDate ( const CTime time)

SetModifiedDate() will add a descriptor for the update date.

Definition at line 75 of file ProjectDescr.cpp.

Referenced by CSelectProjectOptions::CreateProject(), and CGBProject_ver2::SetModifiedDate().


The documentation for this class was generated from the following files:
Modified on Wed Apr 17 13:11:02 2024 by modify_doxy.py rev. 669887