acstime.midl

Go to the documentation of this file.

/* @(#) $Id: acstime.midl,v 1.1 2004/11/22 11:47:01 jibsen Exp $
 *
 * Copyright (C) 2001
 * Associated Universities, Inc. Washington DC, USA.
 *
 * Produced for the ALMA project
 *
 * This library is free software; you can redistribute it and/or modify it it 
 * under the terms of the GNU Library General Public License as published by 
 * the Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This library is distributed in the hope that it will be useful but WITHOUT 
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public 
 * License for more details.
 *
 * You should have received a copy of the GNU Library General Public License 
 * along with this library; if not, write to the Free Software Foundation, 
 * Inc., 675 Massachusetts Ave, Cambridge, MA, 02139, USA.
 *
 * Correspondence concerning ALMA should be addressed as follows:
 * Internet email: alma-sw-admin@nrao.edu
 */
#ifndef ACSTIME_IDL
#define ACSTIME_IDL

#include <baci.idl>
#include "ACSTimeError.idl"

#pragma prefix "alma"

module acstime
{
    const ACS::Time ACE_BEGIN = 122192928000000000;
                      
    const unsigned long STARTDATE = 577735;

    const double EpochOriginInMJD = -100840.0;

    const double EpochOriginInYears = 1582.793292;

    enum TimeComparison
    {
        TCEqualTo,       // values are equal
        TCLessThan,      // this is less than comparee
        TCGreaterThan,   // this is greater than comparee
        TCIndeterminate  // comparison cannot be done
    };
    
    enum TimeSystem
    {
        TSArray,   // array time
        TSTAI,     // International Atomic Time (TAI)
        TSUTC      // Universal Coordinate Time (UTC)
    };
    
    struct Epoch
    {
        ACS::Time value;
    };

    struct Duration
    {
        ACS::TimeInterval value;
    };
    
    interface TimeoutHandler : ACS::OffShoot
        {
        void handleTimeout(in Epoch time);
        };

    interface Timer : ACS::ACSComponent
        {
        long schedule(in TimeoutHandler handler,
                      in Epoch start,
                      in Duration period)
            raises(ACSTimeError::ArgErrorEx);
        
        void cancel(in long id)
            raises(ACSTimeError::InvalidIDEx);
        };

    interface Clock : ACS::CharacteristicComponent
        {
        Duration getTimeInterval(in Epoch prevEpoch);
        
        readonly attribute ACS::RWlong array2TAI;
        
        readonly attribute ACS::RWlong TAI2UTC;


        readonly attribute ACS::ROuLongLong now;

        //UTILITY METHODS
        Epoch fromISO8601(in TimeSystem ts, in string iso)
            raises (ACSTimeError::ArgErrorEx);

        string toISO8601(in TimeSystem ts, in Epoch timeValue)
            raises (ACSTimeError::ArgErrorEx);
        };
};
#endif /* ! ACSTIME_IDL */

---