ASN1C C/C++ Common Runtime
ASN1C v7.2.x
|
#include <ASN1CTime.h>
Public Member Functions | |
EXTRTMETHOD | ASN1CTime (OSRTMessageBufferIF &msgBuf, char *&buf, int bufSize, OSBOOL useDerRules) |
EXTRTMETHOD | ASN1CTime (OSRTMessageBufferIF &msgBuf, ASN1VisibleString &buf, OSBOOL useDerRules) |
EXTRTMETHOD | ASN1CTime (OSRTContext &ctxt, char *&buf, int bufSize, OSBOOL useDerRules) |
EXTRTMETHOD | ASN1CTime (OSRTContext &ctxt, ASN1VisibleString &buf, OSBOOL useDerRules) |
EXTRTMETHOD | ASN1CTime (const ASN1CTime &original) |
EXTRTMETHOD | ~ASN1CTime () |
virtual EXTRTMETHOD int | getYear () |
virtual EXTRTMETHOD int | getMonth () |
virtual EXTRTMETHOD int | getDay () |
virtual EXTRTMETHOD int | getHour () |
virtual EXTRTMETHOD int | getMinute () |
virtual EXTRTMETHOD int | getSecond () |
virtual EXTRTMETHOD int | getFraction () |
virtual EXTRTMETHOD double | getFractionAsDouble () |
virtual EXTRTMETHOD int | getFractionStr (char *const pBuf, size_t bufSize) |
virtual EXTRTMETHOD int | getFractionLen () |
virtual EXTRTMETHOD int | getDiffHour () |
virtual EXTRTMETHOD int | getDiffMinute () |
virtual EXTRTMETHOD int | getDiff () |
virtual EXTRTMETHOD OSBOOL | getUTC () |
virtual EXTRTMETHOD time_t | getTime () |
void | setDER (OSBOOL bvalue) |
virtual EXTRTMETHOD int | setUTC (OSBOOL utc) |
virtual EXTRTMETHOD int | setYear (short year_) |
virtual EXTRTMETHOD int | setMonth (short month_) |
virtual EXTRTMETHOD int | setDay (short day_) |
virtual EXTRTMETHOD int | setHour (short hour_) |
virtual EXTRTMETHOD int | setMinute (short minute_) |
virtual EXTRTMETHOD int | setSecond (short second_) |
virtual EXTRTMETHOD int | setFraction (int fraction, int fracLen=-1) |
virtual EXTRTMETHOD int | setFraction (double frac, int fracLen) |
virtual EXTRTMETHOD int | setFraction (char const *frac) |
virtual int | setTime (time_t time, OSBOOL diffTime)=0 |
virtual EXTRTMETHOD int | setDiffHour (short dhour) |
virtual EXTRTMETHOD int | setDiff (short dhour, short dminute) |
virtual EXTRTMETHOD int | setDiff (short inMinutes) |
virtual EXTRTMETHOD int | parseString (const char *string) |
virtual EXTRTMETHOD void | clear () |
virtual EXTRTMETHOD int | equals (ASN1CTime &) |
EXTRTMETHOD size_t | getTimeStringLen () |
EXTRTMETHOD const char * | getTimeString (char *pbuf, size_t bufsize) |
EXTRTMETHOD const ASN1CTime & | operator= (const ASN1CTime &) |
virtual EXTRTMETHOD OSBOOL | operator== (ASN1CTime &) |
virtual EXTRTMETHOD OSBOOL | operator!= (ASN1CTime &) |
virtual EXTRTMETHOD OSBOOL | operator> (ASN1CTime &) |
virtual EXTRTMETHOD OSBOOL | operator< (ASN1CTime &) |
virtual EXTRTMETHOD OSBOOL | operator>= (ASN1CTime &) |
virtual EXTRTMETHOD OSBOOL | operator<= (ASN1CTime &) |
Public Member Functions inherited from ASN1CType | |
EXTRTMETHOD | ASN1CType (OSRTMessageBufferIF &msgBuf) |
EXTRTMETHOD | ASN1CType (const ASN1CType &orig) |
virtual | ~ASN1CType () |
void | append (OSRTDList &llist, void *pdata) |
OSRTCtxtPtr | getContext () |
OSCTXT * | getCtxtPtr () |
char * | getErrorText (char *textbuf=(char *) 0, OSSIZE bufsize=0) |
int | getStatus () const |
void * | memAlloc (OSSIZE numocts) |
void * | memAllocZ (OSSIZE numocts) |
void | memFreeAll () |
void * | memRealloc (void *ptr, OSSIZE numocts) |
void | memReset () |
void | memFreePtr (void *ptr) |
void | printErrorInfo () |
void | resetError () |
OSBOOL | setDiag (OSBOOL value) |
virtual EXTRTMETHOD int | Encode () |
virtual EXTRTMETHOD int | Decode (OSBOOL free=FALSE) |
virtual int | EncodeTo (OSRTMessageBufferIF &) |
virtual int | DecodeFrom (OSRTMessageBufferIF &, OSBOOL free=TRUE) |
Protected Member Functions | |
EXTRTMETHOD void | checkCapacity () |
EXTRTMETHOD char *& | getTimeStringPtr () |
virtual ASN1TTime & | getTimeObj ()=0 |
virtual const ASN1TTime & | getTimeObj () const =0 |
EXTRTMETHOD | ASN1CTime (char *&buf, int bufSize, OSBOOL useDerRules) |
EXTRTMETHOD | ASN1CTime (ASN1VisibleString &buf, OSBOOL useDerRules) |
virtual int | compileString ()=0 |
Protected Member Functions inherited from ASN1CType | |
EXTRTMETHOD | ASN1CType () |
EXTRTMETHOD | ASN1CType (OSRTContext &ctxt) |
EXTRTMETHOD int | setMsgBuf (OSRTMessageBufferIF &msgBuf, OSBOOL initBuf=FALSE) |
EXTRTMETHOD int | setRunTimeKey (const OSOCTET *key, OSSIZE keylen) |
Protected Attributes | |
OSBOOL | parsed |
OSBOOL | derRules |
char *& | timeStr |
int | strSize |
Protected Attributes inherited from ASN1CType | |
OSRTCtxtPtr | mpContext |
OSRTMessageBufferIF * | mpMsgBuf |
ASN.1 Time control base class. The ASN1CTime class is derived from the ASN1CType base class. It is used as the abstract base class for generated control classes for the ASN.1 Generalized Time ([UNIVERSAL 24] IMPLICIT VisibleString) types and Universal Time ([UNIVERSAL 23] IMPLICIT VisibleString) types. This class provides utility methods for operating on the time information referenced by the generated class. This class can also be used inline to operate on the times within generated time string elements in a SEQUENCE, SET, or CHOICE construct. The time string are generally formatted according to ISO 8601 format with some exceptions (X.680).
EXTRTMETHOD ASN1CTime::ASN1CTime | ( | OSRTMessageBufferIF & | msgBuf, |
char *& | buf, | ||
int | bufSize, | ||
OSBOOL | useDerRules | ||
) |
This constructor creates a time string from buffer.
It does not deep-copy the data; it just assigns the passed array to an internal reference variable. The object will then directly operate on the given data variable.
msgBuf | Reference to an OSRTMessage buffer derived object (for example, ASNBEREncodeBuffer ). |
buf | Reference to a pointer to a time string buffer. |
bufSize | Size of buffer in bytes. |
useDerRules | Use the Distinguished Encoding Rules (DER) to operate on this time value. |
EXTRTMETHOD ASN1CTime::ASN1CTime | ( | OSRTMessageBufferIF & | msgBuf, |
ASN1VisibleString & | buf, | ||
OSBOOL | useDerRules | ||
) |
This constructor creates a time string from an ASN1VisibleString
object.
It does not deep-copy the data; it just assigns the passed object to an internal reference variable. The object will then directly operate on the given data variable.
msgBuf | Reference to an OSRTMessage buffer derived object (for example, ASNBEREncodeBuffer ). |
buf | Reference to a visible string object to hold the time data. |
useDerRules | Use the Distinguished Encoding Rules (DER) to operate on this time value. |
EXTRTMETHOD ASN1CTime::ASN1CTime | ( | OSRTContext & | ctxt, |
char *& | buf, | ||
int | bufSize, | ||
OSBOOL | useDerRules | ||
) |
This constructor creates a time string from buffer.
It does not deep-copy the data; it just assigns the passed array to an internal reference variable. The object will then directly operate on the given data variable.
ctxt | Reference to an OSRTContext data structure. |
buf | Reference to a pointer to a time string buffer. |
bufSize | Size of buffer in bytes. |
useDerRules | Use the Distinguished Encoding Rules (DER) to operate on this time value. |
EXTRTMETHOD ASN1CTime::ASN1CTime | ( | OSRTContext & | ctxt, |
ASN1VisibleString & | buf, | ||
OSBOOL | useDerRules | ||
) |
This constructor creates a time string from an ::ASN1VisibleString object.
It does not deep-copy the data; it just assigns the passed array to an internal reference variable. The object will then directly operate on the given data variable.
ctxt | Reference to an OSRTContext data structure. |
buf | Reference to a pointer to a time string buffer. |
useDerRules | Use the Distinguished Encoding Rules (DER) to operate on this time value. |
EXTRTMETHOD ASN1CTime::ASN1CTime | ( | const ASN1CTime & | original | ) |
The copy constructor. This does not deep-copy the original value. Instead, it assigns references to the internal components.
original | The original time string object value. |
EXTRTMETHOD ASN1CTime::~ASN1CTime | ( | ) |
The destructor; this cleans up the ASN1CTime object.
|
virtual |
This method clears the time string.
Note the action of this method may differ for different inherited ASN1CTime classes.
- | none |
|
protectedpure virtual |
Compiles new time string accoring X.680 and ISO 8601.
Implemented in ASN1CGeneralizedTime, and ASN1CUTCTime.
Referenced by ASN1CGeneralizedTime::ASN1CGeneralizedTime().
|
virtual |
This method compares times.
|
virtual |
This method returns the day of month number component of the time value.
The number of the first day in the month is 1; the number of the last day may be in the interval from 28 to 31. Note that the return value may be differ for different inherited ASN1CTime classes.
- | none |
|
virtual |
This method returns the difference between the time zone of the object and the Coordinated Universal Time (UTC).
The UTC time is the sum of the local time and a positive of negative time difference. Note that the return value may differ for different inherited ASN1CTime classes.
- | none |
|
virtual |
This method returns the hour component of the difference between the time zone of the object and the Coordinated Universal Time (UTC).
The UTC time is the sum of the local time and a positive of negative time difference. Note that the return value may differ for different inherited ASN1CTime classes.
- | none |
|
virtual |
This method returns the minute component of the difference between the time zone of the object and the Coordinated Universal Time (UTC).
The UTC time is the sum of the local time and a positive of negative time difference. Note that the return value may differ for different inherited ASN1CTime classes.
- | none |
|
virtual |
This method returns the second's decimal component of the time value.
Second's decimal fraction is represented by one or more digits from 0 to 9. Note that the return value may differ for different inherited ASN1CTime classes.
- | none |
Reimplemented in ASN1CUTCTime.
|
virtual |
This method returns the second's decimal component of the time value. Second's fraction will be represented as double value more than 0 and less than 1.
Second's decimal fraction is represented by one or more digits from 0 to 9.
|
virtual |
This method returns the number of digits in second's decimal component of the time value.
|
virtual |
This method returns the second's decimal component of the time value. Second's fraction will be represented as string w/o integer part and decimal point.
|
virtual |
This method returns the hour component of the time value.
As the ISO 8601 is based on the 24-hour timekeeping system, hours are represented by two-digit values from 00 to 23. Note that the return value may differ from different inherited ASN1CTime classes.
- | none |
|
virtual |
This method returns the minute component of the time value.
Minutes are represented by the two digits from 00 to 59. Note that the return value may differ from different inherited ASN1CTime classes.
- | none |
|
virtual |
This method returns the month number component of the time value.
The number of January is 1, February 2, ... up to December 12. You may also use enumerated valued for decoded months: ASN1CTime::January, ASN1CTime::February, etc. Also short aliases for months can be used: ASN1CTime::Jan, ASN1CTime::Feb, etc. Note that the return value may differ for different inherited ASN1CTime classes.
- | none |
|
virtual |
This method returns the second component of the time value.
Seconds are represented by two digits from 00 to 59. Note that the return value may differ from different inherited ASN1CTime classes.
- | none |
|
virtual |
This method converts the time string to a value of the built-in C type time_t.
The value is the number of seconds from January 1, 1970. If the time is represned as UTC time plus or minus a time difference, then the resulting value will be recalculated as local time. For example, if the time string is "19991208120000+0930", then this string will be converted to "19991208213000" and then converted to a time_t value. Note that the return value may differ for different inherited ASN1CTime classes.
- | none |
EXTRTMETHOD const char* ASN1CTime::getTimeString | ( | char * | pbuf, |
size_t | bufsize | ||
) |
This method copies the compiled time string into the given buffer.
pbuf | The buffer to receive the time string. |
bufsize | The size of the buffer. |
EXTRTMETHOD size_t ASN1CTime::getTimeStringLen | ( | ) |
This method returns the length of the compiled time string.
|
virtual |
This method returns the UTC flag state.
If the UTC flag is TRUE, then the time is a UTC time and symbol Z is added at the end of the time string. Otherwise, it is local time.
- | none |
|
virtual |
This method returns the year component of the time value.
Note that the return value may differ for different inherited ASN1CTime classes.
- | none |
|
virtual |
The ASN1CTime inequality test.
|
virtual |
The ASN1CTime less-than test.
|
virtual |
The ASN1CTime less-equal test.
This operator assigns this ASN1CTime object to the given ASN1CTime reference.
Referenced by ASN1CGeneralizedTime::ASN1CGeneralizedTime().
|
virtual |
The ASN1CTime equality test.
|
virtual |
The ASN1CTime greater-than test.
|
virtual |
The ASN1CTime greater-equal test.
|
virtual |
This method parses the given time string.
The string is expected to be in the ASN.1 value notation format for the given ASN.1 time string type. Note that the action of this method may differ for different inherited ASN1CTime classes.
string | The time string value to be parsed. |
|
virtual |
This method sets the day of month number component of the time value.
The number of the first day in the month is 1; the number of the last day in the month may be in the interval from 28 to 31. Note that the action of this method may differ for different inherited ASN1CTime classes.
day_ | Day of month component (1 - 31). |
|
inline |
This method sets the 'use DER' flag which enforces the DER rules when time strings are constructed or parsed.
References operator!=(), operator<(), operator<=(), operator==(), operator>(), and operator>=().
|
virtual |
This method sets the hours and the minute components of the difference between the time zone of the object and Coordinated Universal Time (UTC).
The UTC time is the sum of the local time and a positive or negative time difference. Note that the action of this method may differ for different inherited ASN1CTime classes.
dhour | The negative or positive hour component of the difference between the time zone of the object and the UTC time (-12 - +12). |
dminute | The negative or positive minute component of the difference between the time zone of the object and the UTC time (-59 - +59). |
|
virtual |
This method sets the difference between the time zone of the object and Coordinated Universal Time (UTC), in minutes.
The UTC time is the sum of the local time and a positive or negative time difference. Note that the action of this method may differ for different inherited ASN1CTime classes.
inMinutes | The negative or positive difference, in minutes, between the time zone of the object and the UTC time (-12*60 - +12*60) is returned if the operation is successful. |
|
virtual |
This method sets teh hour component of the difference between the time zone of the object and the Coordinated Universal Time (UTC).
The UTC time is the sum of the local time and a positive or negative time difference. Note that the action of this method may differ from different inherited ASN1CTime classes.
dhour | The negative or positive hour component of the difference between the time zone of the object and the UTC time (-12 - +12) is returned if the operation is successful. If the operation fails, a negative value is returned. |
|
virtual |
This method sets the second's decimal fraction component of the time value.
Second's decimal fraction is represented by one or more digits from 0 to 9. Note that the action of this method may differ for different inherited ASN1CTime classes.
fraction | Second's decimal fraction component (0 - 9). |
fracLen | Optional parameter specifies number of digits in second's fraction. |
|
virtual |
This method sets the second's decimal fraction component of the time value. Double value must be greater or equal 0 and less than 1.
frac | Second's decimal fraction component. |
fracLen | Specifies number of digits in second's fraction. |
|
virtual |
This method sets the second's decimal fraction component of the time value. Double value must be greater or equal 0 and less than 1.
frac | Second's decimal fraction component. |
|
virtual |
This method sets the hour component of the time value.
As the ISO 8601 is based on the 24-hour timekeeping system, hours are represented by two digits from 00 to 23. Note that the action of this method may differ for different inherited ASN1CTime classes.
hour_ | Hour component (0 - 23). |
|
virtual |
This method sets the minute component of the time value.
Minutes are represented by two digits from 00 to 59. Note that the action of this method may differ for different inherited ASN1CTime classes.
minute_ | Minute component (0 - 59). |
|
virtual |
This method sets the month number component of the time value.
The number of January is 1, February 2, ..., through December 12. You may use enumerated values for months encoding: ASN1CTime::January, ASN1CTime::February, etc. Also you can use short aliases for months: ASN1CTime::Jan, ASN1CTime::Feb, etc. Note that the action of this method may differ for different inherited ASN1CTime classes.
month_ | Month component (1 - 12). |
|
virtual |
This method sets the second component of the time value.
Seconds are represented by two digits from 00 to 59. Note that the action of this method may differ form different inherited ASN1CTime classes.
second_ | Second component (0 - 59). |
|
pure virtual |
This converts the value of the C built-in type time_t to a time string.
The value is the number of seconds from January 1, 1970. Note that the action of this method may differ for different inherited ASN1CTime Classes.
time | The time value, expressed as a number of seconds from January 1, 1970. |
diffTime | TRUE means the difference between local time and UTC time will be calculated; in other case, only local time will be stored. |
Implemented in ASN1CGeneralizedTime, and ASN1CUTCTime.
Referenced by ASN1CGeneralizedTime::ASN1CGeneralizedTime().
|
virtual |
This method sets teh UTC flag state.
If the UTC flag is TRUE, then the time is a UTC time and symbol 'Z' is added to the end of the string. Otherwise, it is a local time.
utc | UTC flag state. |
|
virtual |
This method sets the year component of the time value.
Note that the action of this method may differ for different inherited ASN1CTime classes.
year_ | Year component (full 4 digits). |