edltime.h

Go to the documentation of this file.

/*
 * Copyright (C) 2007-2025 Global Graphics Software Ltd. All rights reserved.
 */

 
#ifndef EDLTIME_H
#define EDLTIME_H
 
#include <jawsmako/hashable.h>
#include <edl/iedlobject.h>
#include <edl/iedlfactory.h>
#include "edltypes.h"
#include "edlstring.h"
#include <time.h>
 
_BEGIN_EDL_NAMESPACE
 
class IEDLTime;
DECL_SMART_PTR(IEDLTime);

class IEDLTime: public IEDLObject, public JawsMako::IHashable
{
#define IEDLTimeID 0x88d388a7, 0xcd6146bf, 0xa29e9830, 0x722cf8b9
 
    public:
 
    DECLARE_CLASS_ID(IEDLTimeID);

    static EDL_API IEDLTimePtr createNow(IEDLClassFactory *pFactory);

    class Data : public CClassParams
    {
    public:
        Data() : year(0), month(0), day(0), hour(0), minute(0), second(0), ms(0),
        tzd_sign(1), tzd_hour(0), tzd_min(0)
        {}
 
        uint16 year;     //year
        uint16 month;    //month (1=January, etc.)
        uint16 day;      //day of month (01 through 31)
        uint16 hour;     //hour (0 through 23)
        uint16 minute;   //minute (00 through 59)
        uint16 second;   //second (00 through 59)
        uint16 ms;       //decimal fraction of a second
        int16  tzd_sign; //time zone designator - sign (+1 or -1)
        uint16 tzd_hour; //time zone designator - hour
        uint16 tzd_min;  //time zone designator - min
    };

    virtual bool setYear(uint16 year) = 0;

    virtual uint16 getYear() const = 0;

    virtual bool setMonth(uint16 month) = 0;

    virtual uint16 getMonth() const = 0;

    virtual bool setDay(uint16 day) = 0;

    virtual uint16 getDay() const = 0;

    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;
 
#ifdef SWIG
    %apply uint16_t &OUTPUT { uint16 &hour      };
    %apply uint16_t &OUTPUT { uint16 &min       };
    %apply uint16_t &OUTPUT { uint16 &sec       };
    %apply uint16_t &OUTPUT { uint16 &ms        };
    %apply int16_t  &OUTPUT { int16 &tzd_sign   };
    %apply uint16_t &OUTPUT { uint16 &tzd_hour  };
    %apply uint16_t &OUTPUT { uint16 &tzd_min   };
#endif
    virtual void getTime(uint16 &hour, uint16 &min, uint16 &sec, uint16 &ms, int16 &tzd_sign, uint16 &tzd_hour, uint16 &tzd_min) const = 0;
#ifdef SWIG
    %clear uint16 &hour;
    %clear uint16 &min;
    %clear uint16 &sec;
    %clear uint16 &ms;
    %clear int16 &tzd_sign;
    %clear uint16 &tzd_hour;
    %clear uint16 &tzd_min;
#endif

    virtual EDLSysString toW3CDTF() const = 0;

    virtual bool fromW3CDTF(const EDLSysString &strTime) = 0;

    virtual EDLSysString toPDFDate(bool fullDate = false) const = 0;

    virtual bool fromPDFDate(const EDLSysString &strTime) = 0;

    virtual bool isEqualTo(const IEDLTimePtr &ptrTime) const = 0;

    virtual int32 compare(const IEDLTimePtr &ptrTime) const = 0;

    virtual void now() = 0;

    virtual void toUTC() = 0;

    virtual void toLocalTime() = 0;
};
 
#define edlobj2IEDLTime(src) edl_cast((IEDLTime *)NULL, src)
 
_END_EDL_NAMESPACE
 
#endif /* __EDLTIME_H__ */