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

Represents ASN.1 type Date-std defined in file general.asn

Search Toolkit Book for CDate_std

#include <objects/general/Date_std.hpp>

+ Inheritance diagram for CDate_std:
+ Collaboration diagram for CDate_std:

Public Member Functions

 CDate_std (void)
 
 CDate_std (const CTime &time, CDate::EPrecision prec=CDate::ePrecision_second)
 
 CDate_std (time_t time, CDate::EPrecision prec=CDate::ePrecision_second)
 
 ~CDate_std (void)
 
void SetToTime (const CTime &time, CDate::EPrecision prec=CDate::ePrecision_second)
 
CTime AsCTime (CTime::ETimeZone tz=CTime::eLocal) const
 
CDate::ECompare Compare (const CDate_std &date) const
 Indicate how *this relates to another date. More...
 
void GetDate (string *label, const string &format) const
 Append a custom string representation of the date to the label. More...
 
- Public Member Functions inherited from CDate_std_Base
 CDate_std_Base (void)
 
virtual ~CDate_std_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetYear (void) const
 full year (including 1900) Check if a value has been assigned to Year data member. More...
 
bool CanGetYear (void) const
 Check if it is safe to call GetYear method. More...
 
void ResetYear (void)
 Reset Year data member. More...
 
TYear GetYear (void) const
 Get the Year member data. More...
 
void SetYear (TYear value)
 Assign a value to Year data member. More...
 
TYearSetYear (void)
 Assign a value to Year data member. More...
 
bool IsSetMonth (void) const
 month (1-12) Check if a value has been assigned to Month data member. More...
 
bool CanGetMonth (void) const
 Check if it is safe to call GetMonth method. More...
 
void ResetMonth (void)
 Reset Month data member. More...
 
TMonth GetMonth (void) const
 Get the Month member data. More...
 
void SetMonth (TMonth value)
 Assign a value to Month data member. More...
 
TMonthSetMonth (void)
 Assign a value to Month data member. More...
 
bool IsSetDay (void) const
 day of month (1-31) Check if a value has been assigned to Day data member. More...
 
bool CanGetDay (void) const
 Check if it is safe to call GetDay method. More...
 
void ResetDay (void)
 Reset Day data member. More...
 
TDay GetDay (void) const
 Get the Day member data. More...
 
void SetDay (TDay value)
 Assign a value to Day data member. More...
 
TDaySetDay (void)
 Assign a value to Day data member. More...
 
bool IsSetSeason (void) const
 for "spring", "may-june", etc Check if a value has been assigned to Season data member. More...
 
bool CanGetSeason (void) const
 Check if it is safe to call GetSeason method. More...
 
void ResetSeason (void)
 Reset Season data member. More...
 
const TSeasonGetSeason (void) const
 Get the Season member data. More...
 
void SetSeason (const TSeason &value)
 Assign a value to Season data member. More...
 
void SetSeason (TSeason &&value)
 
TSeasonSetSeason (void)
 Assign a value to Season data member. More...
 
bool IsSetHour (void) const
 hour of day (0-23) Check if a value has been assigned to Hour data member. More...
 
bool CanGetHour (void) const
 Check if it is safe to call GetHour method. More...
 
void ResetHour (void)
 Reset Hour data member. More...
 
THour GetHour (void) const
 Get the Hour member data. More...
 
void SetHour (THour value)
 Assign a value to Hour data member. More...
 
THourSetHour (void)
 Assign a value to Hour data member. More...
 
bool IsSetMinute (void) const
 minute of hour (0-59) Check if a value has been assigned to Minute data member. More...
 
bool CanGetMinute (void) const
 Check if it is safe to call GetMinute method. More...
 
void ResetMinute (void)
 Reset Minute data member. More...
 
TMinute GetMinute (void) const
 Get the Minute member data. More...
 
void SetMinute (TMinute value)
 Assign a value to Minute data member. More...
 
TMinuteSetMinute (void)
 Assign a value to Minute data member. More...
 
bool IsSetSecond (void) const
 second of minute (0-59) Check if a value has been assigned to Second data member. More...
 
bool CanGetSecond (void) const
 Check if it is safe to call GetSecond method. More...
 
void ResetSecond (void)
 Reset Second data member. More...
 
TSecond GetSecond (void) const
 Get the Second member data. More...
 
void SetSecond (TSecond value)
 Assign a value to Second data member. More...
 
TSecondSetSecond (void)
 Assign a value to Second 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 CDate_std_Base Tparent
 

Private Member Functions

 CDate_std (const CDate_std &value)
 
CDate_stdoperator= (const CDate_std &value)
 

Additional Inherited Members

- Public Types inherited from CDate_std_Base
enum class  E_memberIndex {
  e__allMandatory = 0 , e_year , e_month , e_day ,
  e_season , e_hour , e_minute , e_second
}
 
typedef int TYear
 
typedef int TMonth
 
typedef int TDay
 
typedef string TSeason
 
typedef int THour
 
typedef int TMinute
 
typedef int TSecond
 
typedef Tparent::CMemberIndex< E_memberIndex, 8 > 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 52 of file Date_std.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 54 of file Date_std.hpp.

Constructor & Destructor Documentation

◆ CDate_std() [1/4]

CDate_std::CDate_std ( void  )
inline

Definition at line 92 of file Date_std.hpp.

◆ CDate_std() [2/4]

CDate_std::CDate_std ( const CTime time,
CDate::EPrecision  prec = CDate::ePrecision_second 
)
inline

Definition at line 97 of file Date_std.hpp.

References SetToTime().

◆ CDate_std() [3/4]

CDate_std::CDate_std ( time_t  time,
CDate::EPrecision  prec = CDate::ePrecision_second 
)
inlineexplicit

Definition at line 103 of file Date_std.hpp.

References SetToTime().

◆ ~CDate_std()

CDate_std::~CDate_std ( void  )

Definition at line 54 of file Date_std.cpp.

◆ CDate_std() [4/4]

CDate_std::CDate_std ( const CDate_std value)
private

Member Function Documentation

◆ AsCTime()

CTime CDate_std::AsCTime ( CTime::ETimeZone  tz = CTime::eLocal) const

◆ Compare()

CDate::ECompare CDate_std::Compare ( const CDate_std date) const

◆ GetDate()

void CDate_std::GetDate ( string label,
const string format 
) const

◆ operator=()

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

◆ SetToTime()

void CDate_std::SetToTime ( const CTime time,
CDate::EPrecision  prec = CDate::ePrecision_second 
)

The documentation for this class was generated from the following files:
Modified on Wed Feb 21 09:57:33 2024 by modify_doxy.py rev. 669887