Interface to EDL date-time class. More...

#include <edl/edltime.h>

Inheritance diagram for IEDLTime:

Classes
class	Data
	Initialization data. More...

Public Member Functions
	DECLARE_CLASS_ID (IEDLTimeID)
virtual bool	setYear (uint16 year)=0
	Sets the year.
virtual uint16	getYear () const =0
	Retrieves the year value.
virtual bool	setMonth (uint16 month)=0
	Sets the month.
virtual uint16	getMonth () const =0
	Retrieves the month value.
virtual bool	setDay (uint16 day)=0
	Sets the day.
virtual uint16	getDay () const =0
	Retrieves the day value.
virtual bool	setTime (uint16 hour=0, uint16 min=0, uint16 sec=0, uint16 ms=0, int16 tzd_sign=1, uint16 tzd_hour=0, uint16 tzd_min=0)=0
	Sets the time.
virtual void	getTime (uint16 &hour, uint16 &min, uint16 &sec, uint16 &ms, int16 &tzd_sign, uint16 &tzd_hour, uint16 &tzd_min) const =0
	Retrieves the time.
virtual EDLSysString	toW3CDTF () const =0
	Convert IEDLTime to string with W3CDTF format.
virtual bool	fromW3CDTF (const EDLSysString &strTime)=0
	Fill IEDLTime value from string with W3CDTF format.
virtual EDLSysString	toPDFDate (bool fullDate=false) const =0
	Convert IEDLTime to string with PDF date format.
virtual bool	fromPDFDate (const EDLSysString &strTime)=0
	Fill IEDLTime value from string with PDF date format.
virtual bool	isEqualTo (const IEDLTimePtr &ptrTime) const =0
	Check this IEDLTime for equality to another IEDLTime.
virtual int32	compare (const IEDLTimePtr &ptrTime) const =0
	Compare this time against ptrTime.
virtual void	now ()=0
	Sets date/time to the current system date and time.
virtual void	toUTC ()=0
	Convert UTC date/time.
virtual void	toLocalTime ()=0
	Convert to local date/time.
Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject.
virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory.
virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.
Public Member Functions inherited from JawsMako::IHashable
virtual	~IHashable ()
virtual uint64	hash () const
	Obtain a 64-bit hash of the receiving object.
virtual void	updateHash (uint64 &hash) const =0
	Update the given hash to include the receiver.

Static Public Member Functions
static EDL_API IEDLTimePtr	createNow (IEDLClassFactory *pFactory)
	Simplified creator to create the time as of now.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

Interface to EDL date-time class.

Member Function Documentation

◆ compare()

virtual int32 IEDLTime::compare ( const IEDLTimePtr & ptrTime ) const

pure virtual

Compare this time against ptrTime.

Parameters

ptrTime The time to compare.

Returns: int32 -1 if this time is earlier than ptrTime, 0 if this time is equal to ptrTime or 1 if this time is later than ptrTime.

◆ createNow()

EDL_API IEDLTimePtr IEDLTime::createNow ( IEDLClassFactory * pFactory )

static

Simplified creator to create the time as of now.

Parameters

pFactory The EDL Class factory to use.

Returns: IEDLTimePtr The current time

◆ DECLARE_CLASS_ID()

IEDLTime::DECLARE_CLASS_ID ( IEDLTimeID )

◆ fromPDFDate()

virtual bool IEDLTime::fromPDFDate ( const EDLSysString & strTime )

pure virtual

Fill IEDLTime value from string with PDF date format.

Parameters

strTime The string

Returns: bool Returns true on success, false if the call fails.

◆ fromW3CDTF()

virtual bool IEDLTime::fromW3CDTF ( const EDLSysString & strTime )

pure virtual

Fill IEDLTime value from string with W3CDTF format.

Parameters

strTime The string

Returns: bool Returns true on success, false if the call fails.

◆ getDay()

virtual uint16 IEDLTime::getDay ( ) const

pure virtual

Retrieves the day value.

Returns: uint16 The month value.

◆ getMonth()

virtual uint16 IEDLTime::getMonth ( ) const

pure virtual

Retrieves the month value.

Returns: uint16 The month value.

◆ getTime()

virtual void IEDLTime::getTime	(	uint16 &	hour,
		uint16 &	min,
		uint16 &	sec,
		uint16 &	ms,
		int16 &	tzd_sign,
		uint16 &	tzd_hour,
		uint16 &	tzd_min ) const

pure virtual

Retrieves the time.

Parameters

hour	The hour component
min	The minute component
sec	The second component
ms	The fractional second component
tzd_sign	The timezone sign component
tzd_hour	The timezone hour component
tzd_min	The timezone minute component

◆ getYear()

virtual uint16 IEDLTime::getYear ( ) const

pure virtual

Retrieves the year value.

Returns: uint16 The year value.

◆ isEqualTo()

virtual bool IEDLTime::isEqualTo ( const IEDLTimePtr & ptrTime ) const

pure virtual

Check this IEDLTime for equality to another IEDLTime.

Parameters

ptrTime The time to compare.

Returns: bool Returns true on success, false if the call fails.

◆ now()

virtual void IEDLTime::now ( )

pure virtual

Sets date/time to the current system date and time.

◆ setDay()

virtual bool IEDLTime::setDay ( uint16 day )

pure virtual

Sets the day.

Parameters

day	The day value.

Returns: bool Returns true on success, false if the call fails.

◆ setMonth()

virtual bool IEDLTime::setMonth ( uint16 month )

pure virtual

Sets the month.

Parameters

month The month value.

Returns: bool Returns true on success, false if the call fails.

◆ setTime()

virtual bool IEDLTime::setTime	(	uint16	hour = 0,
		uint16	min = 0,
		uint16	sec = 0,
		uint16	ms = 0,
		int16	tzd_sign = 1,
		uint16	tzd_hour = 0,
		uint16	tzd_min = 0 )

pure virtual

Sets the time.

Parameters

hour	The hour component
min	The minute component
sec	The second component
ms	The fractional second component
tzd_sign	The timezone sign component
tzd_hour	The timezone hour component
tzd_min	The timezone minute component

Returns: bool Returns true on success, false if the call fails.

◆ setYear()

virtual bool IEDLTime::setYear ( uint16 year )

pure virtual

Sets the year.

Parameters

year	The year value.

Returns: bool Returns true on success, false if the call fails.

◆ toLocalTime()

virtual void IEDLTime::toLocalTime ( )

pure virtual

Convert to local date/time.

◆ toPDFDate()

virtual EDLSysString IEDLTime::toPDFDate ( bool fullDate = false ) const

pure virtual

Convert IEDLTime to string with PDF date format.

Parameters

fullDate If true, the entire date is emitted even if some entries are zero and could ordinarily be emitted.

Returns: EDLSysString Returns IEDLTime value as string in PDF date format.

◆ toUTC()

virtual void IEDLTime::toUTC ( )

pure virtual

Convert UTC date/time.

◆ toW3CDTF()

virtual EDLSysString IEDLTime::toW3CDTF ( ) const

pure virtual

Convert IEDLTime to string with W3CDTF format.

Returns: EDLSysString Returns IEDLTime value as string in W3CDTF format

The documentation for this class was generated from the following file:

edl/edltime.h

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ compare()

◆ createNow()

◆ DECLARE_CLASS_ID()

◆ fromPDFDate()

◆ fromW3CDTF()

◆ getDay()

◆ getMonth()

◆ getTime()

◆ getYear()

◆ isEqualTo()

◆ now()

◆ setDay()

◆ setMonth()

◆ setTime()

◆ setYear()

◆ toLocalTime()

◆ toPDFDate()

◆ toUTC()

◆ toW3CDTF()