#include <objects/general/Date.hpp>
Inheritance diagram for CDate:
Collaboration diagram for CDate:
Public Types | |
| enum | EPrecision { ePrecision_day , ePrecision_second } |
| for conversion from CTime More... | |
| enum | ECompare { eCompare_before = -1 , eCompare_same , eCompare_after , eCompare_unknown } |
| How *this relates to another date. More... | |
| Public Types inherited from CDate_Base | |
| enum | E_Choice { e_not_set = 0 , e_Str , e_Std } |
| Choice variants. More... | |
| enum | E_ChoiceStopper { e_MaxChoice = 3 } |
| Maximum+1 value of the choice variant enumerator. More... | |
| typedef string | TStr |
| typedef CDate_std | TStd |
| 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... | |
Public Member Functions | |
| CDate (void) | |
| CDate (const CTime &time, EPrecision prec=ePrecision_second) | |
| CDate (time_t time, EPrecision prec=ePrecision_second) | |
| ~CDate (void) | |
| void | SetToTime (const CTime &time, EPrecision prec=ePrecision_second) |
| CTime | AsCTime (CTime::ETimeZone tz=CTime::eLocal) const |
| ECompare | Compare (const CDate &date) const |
| void | GetDate (string *label, bool year_only=false) const |
| Append a standardized string representation of the date to the label. More... | |
| void | GetDate (string *label, const string &format) const |
| Append a custom string representation of the date to the label. More... | |
| void | GetDate (string *label, const char *format) const |
| Public Member Functions inherited from CDate_Base | |
| CDate_Base (void) | |
| virtual | ~CDate_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 | IsStr (void) const |
| Check if variant Str is selected. More... | |
| const TStr & | GetStr (void) const |
| Get the variant data. More... | |
| TStr & | SetStr (void) |
| Select the variant. More... | |
| void | SetStr (const TStr &value) |
| Select the variant and set its data. More... | |
| bool | IsStd (void) const |
| Check if variant Std is selected. More... | |
| const TStd & | GetStd (void) const |
| Get the variant data. More... | |
| TStd & | SetStd (void) |
| Select the variant. More... | |
| void | SetStd (TStd &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 |
Private Types | |
| typedef CDate_Base | Tparent |
Private Member Functions | |
| CDate (const CDate &value) | |
| CDate & | operator= (const CDate &value) |
Additional Inherited Members | |
| Static Public Member Functions inherited from CDate_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) |
| 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
Member Typedef Documentation
◆ Tparent
|
private |
Member Enumeration Documentation
◆ ECompare
| enum CDate::ECompare |
◆ EPrecision
| enum CDate::EPrecision |
Constructor & Destructor Documentation
◆ CDate() [1/4]
◆ CDate() [2/4]
|
inline |
Definition at line 136 of file Date.hpp.
References SetToTime().
◆ CDate() [3/4]
|
inlineexplicit |
Definition at line 141 of file Date.hpp.
References SetToTime().
◆ ~CDate()
◆ CDate() [4/4]
Member Function Documentation
◆ AsCTime()
| CTime CDate::AsCTime | ( | CTime::ETimeZone | tz = CTime::eLocal | ) | const |
Definition at line 70 of file Date.cpp.
References CDate_std::AsCTime(), CDate_Base::e_Std, CDate_Base::e_Str, CTime::eEmpty, CDate_Base::GetStd(), CDate_Base::GetStr(), and CDate_Base::Which().
Referenced by CProjectDescr::GetCreateDate(), NSnp::GetCreateTime(), CGBenchVersionInfo::GetLabel(), CProjectDescr::GetModifiedDate(), s_ExpandProjectFolder(), s_FormatDate(), s_ListProjectFolder(), and x_FindLatestSequence().
◆ Compare()
| CDate::ECompare CDate::Compare | ( | const CDate & | date | ) | const |
Definition at line 83 of file Date.cpp.
References CDate_std::Compare(), eCompare_same, eCompare_unknown, CDate_Base::GetStd(), CDate_Base::GetStr(), CDate_Base::IsStd(), and CDate_Base::IsStr().
Referenced by CSubSource::CheckDateFormat(), CheckSegDescrChoice(), CAutoColValidatordate::DoValidate(), FixDupDates(), FixEmblUpdateDates(), CSubSource::IsCollectionDateAfterTime(), SLaterDate::operator()(), RemoveEarlierDates(), s_GetLaterDate(), CCitSubUpdater::sx_GetCitSubForSequence(), CValidError_bioseq::ValidateSeqDescContext(), CValidError_bioseq::ValidateUpdateDateContext(), CLocusItem::x_GetLaterDate(), and CSrcWriter::xGather().
◆ GetDate() [1/3]
Append a standardized string representation of the date to the label.
Dates internally represented as strings necessarily appear as is. Structured dates with known months and days normally appear in a mm-dd-yyyy format; however, if either field is missing, or year_only is true, this method will yield only the year.
Definition at line 149 of file Date.hpp.
References label.
Referenced by DateToString(), GetDate(), GetDateString(), CCit_gen::GetLabelV1(), CCit_pat::GetLabelV1(), CCit_sub::GetLabelV1(), CCit_pat::GetLabelV2(), CCit_sub::GetLabelV2(), ICitationBase::GetParenthesizedYear(), GetSprotDescr(), CDiscrepancyObject::GetTextObjectDescription(), GetTextObjectDescription(), CReadBlastApp::printGeneralInfo(), CCleanup::s_CleanupGenomeAssembly(), s_CreateHistCommentString(), s_FormatYear(), s_GetContentLabel(), CPubField::x_GetImprintField(), ICitationBase::x_GetLabelV1(), CStartItem::x_SetDate(), and CVcfWriter::x_WriteMetaCreateNew().
◆ GetDate() [2/3]
◆ GetDate() [3/3]
Append a custom string representation of the date to the label.
format controls the treatment of Date-std. (Strings necessarily remain as is.) Specifically,
/// %Y -> year /// %M -> month as number /// %N -> month as (English) word /// %D -> day /// %S -> season /// %h -> hour /// %m -> minute /// %s -> second ///
Each of the above can contain a number immediately following the percent sign, indicating the number of characters to yield.
In addition, there are special directives to deal with optional elements: %{ ... %} (which may be nested) may be used to delimit subsequences that should vanish altogether if optional elements they contain are missing, and %| may be used to designate fallbacks. (For instance, the above interface defaults to a format of "%{%2M-%2D-%}%Y", and one might format dates for GenBank with "%{%{%2D%|01%}-%3N%|01-JAN%}-%Y" if one wanted to fudge legal values if necessary.)
Finally, %% -> %.
Definition at line 94 of file Date.cpp.
References CDate_Base::e_Std, CDate_Base::e_Str, format, CDate_std::GetDate(), CDate_Base::GetStd(), CDate_Base::GetStr(), label, and CDate_Base::Which().
◆ operator=()
◆ SetToTime()
| void CDate::SetToTime | ( | const CTime & | time, |
| CDate::EPrecision | prec = ePrecision_second |
||
| ) |
Definition at line 57 of file Date.cpp.
References CTime::AsString(), CDate_Base::e_not_set, CDate_Base::e_Std, CDate_Base::e_Str, CDate_Base::SetStd(), CDate_Base::SetStr(), CDate_std::SetToTime(), and CDate_Base::Which().
Referenced by BOOST_AUTO_TEST_CASE(), CDate(), CGBenchFeedbackRequest::CGBenchFeedbackRequest(), CSequenceEditingEventHandler::CreateSeqSubmit(), GetGenBankDescr(), s_ActualizeUpdateDate(), CCitSubUpdater::sx_GetCitSubForSequence(), CGFFReader::x_ParseDateComment(), CAgpConverter::x_SetCreateAndUpdateDatesToToday(), CMacroFunction_SetPubStatus::x_SetStatus(), and CSubmissionWizard::x_SetSubmissionDate().
The documentation for this class was generated from the following files:
