timeutil.nc

传感器网络中的嵌入式操作系统源代码

// $Id: TimeUtil.nc,v 1.4.4.4 2003/08/26 09:08:13 cssharp Exp $

/*									tab:4
 * "Copyright (c) 2000-2003 The Regents of the University  of California.  
 * All rights reserved.
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose, without fee, and without written agreement is
 * hereby granted, provided that the above copyright notice, the following
 * two paragraphs and the author appear in all copies of this software.
 * 
 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR
 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
 * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
 * CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS."
 *
 * Copyright (c) 2002-2003 Intel Corporation
 * All rights reserved.
 *
 * This file is distributed under the terms in the attached INTEL-LICENSE     
 * file. If you do not find these files, copies can be found by writing to
 * Intel Research Berkeley, 2150 Shattuck Avenue, Suite 1300, Berkeley, CA, 
 * 94704.  Attention:  Intel License Inquiry.
 */

/*
 * Authors:		Su Ping  <[e-mail]>
 *
 */

/**
 * The  TimeUtil interface provides utility commands for handling logical time
 * or other 64 bits intergers in Mica platform. 
 * @author Su Ping <[e-mail]>
 */
includes TosTime;
interface TimeUtil {

  /**
   *  Add a signed 32 bits integer  to a logical time
   *
   * @param a  Logical Time
   *
   * @Param x  A 32 bit integer. If it represent a time, the unit
   *           should be binary milliseconds
   * @return   The new time in tos_time_t format.
   */
  async command tos_time_t addint32( tos_time_t a , int32_t x);

  /** 
   *  Add a unsigned 32 bits integer  to a logical time   
   *  
   * @param a  Logical Time
   *
   * @Param x  A unsigned 32 bit integer. If it represent a time, the unit 
   *           should be binary milliseconds
   * @return   The difference in tos_time_t format.
   */
  async command tos_time_t addUint32( tos_time_t a , uint32_t x);

  /**
   *  Subtract a unsigned 32 bits integer  from a logical time
   *
   * @param a  Logical Time
   *
   * @Param x  A unsigned 32 bit integer. If it represent a time, the unit
   *           should be binary milliseconds
   * @return   The result in tos_time_t format.
   */
  async command  tos_time_t subtractUint32( tos_time_t a, uint32_t x);

  /**
   *  Compare logical time a and b. 
   *  If a>b return 1, if a=b return 0 if a<b return -1
   */
  async command char compare(tos_time_t a,  tos_time_t b);

  /**
   *  Add logical time a and b return the sum
   */
  async command tos_time_t add( tos_time_t a, tos_time_t b);

  /**
   * Subtract logical time b from a, return the difference
   */
  async command tos_time_t subtract( tos_time_t a, tos_time_t b);

  /** 
   * Create a logical time from two unsigned 32 bits integer
   *
   * @param timeH represent the high 32 bits of a logical time
   *
   * @param timeL low 32 bits of a logical time
   *
   * @return The created logical time
   */ 
  async command tos_time_t create(uint32_t timeH, uint32_t timeL);
  
  /**
   * Extract higher 32 bits from a given logical time
   *
   * @param a logical time
   *
   * @return The higher 32 bits of logical time a
   */
  async command uint32_t high32(tos_time_t a);

  /**
   * Extract Lower 32 bits from a given logical time
   *
   * @param a logical time
   *
   * @return The lower 32 bits of logical time a
   */
  async command uint32_t low32(tos_time_t a);

}