[Tinyos-contrib-commits] CVS: tinyos-1.x/contrib/wustl/apps/Agilla/interfaces ClusterheadDirectoryI.nc, NONE, 1.1 ExpLoggerI.nc, NONE, 1.1

[Chien-Liang Fok]

Update of /cvsroot/tinyos/tinyos-1.x/contrib/wustl/apps/Agilla/interfaces
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv12992/interfaces

Added Files:
	ClusterheadDirectoryI.nc ExpLoggerI.nc 
Log Message:


--- NEW FILE: ClusterheadDirectoryI.nc ---
// $Id: ClusterheadDirectoryI.nc,v 1.1 2006/04/06 02:10:50 chien-liang Exp $

/* Agilla - A middleware for wireless sensor networks.
 * Copyright (C) 2004, Washington University in Saint Louis
 * By Chien-Liang Fok.
 *
 * Washington University states that Agilla is free software;
 * you can redistribute it and/or modify it under the terms of
 * the current version of the GNU Lesser General Public License
 * as published by the Free Software Foundation.
 *
 * Agilla is distributed in the hope that it will be useful, but
 * THERE ARE NO WARRANTIES, WHETHER ORAL OR WRITTEN, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.
 *
 * YOU UNDERSTAND THAT AGILLA IS PROVIDED "AS IS" FOR WHICH NO
 * WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. THERE ARE NO
 * WARRANTIES AND NO REPRESENTATION THAT AGILLA IS FREE OF
 * INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER
 * PROPRIETARY RIGHTS.  THERE ARE NO WARRANTIES THAT SOFTWARE IS
 * FREE FROM "BUGS", "VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS",
 * OR OTHER HARMFUL CODE.
 *
 * YOU ASSUME THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR
 * ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF
 * INFORMATION GENERATED USING SOFTWARE. By using Agilla you agree to
 * indemnify, defend, and hold harmless WU, its employees, officers and
 * agents from any and all claims, costs, or liabilities, including
 * attorneys fees and court costs at both the trial and appellate levels
 * for any loss, damage, or injury caused by your actions or actions of
 * your officers, servants, agents or third parties acting on behalf or
 * under authorization from you, as a result of using Agilla.
 *
 * See the GNU Lesser General Public License for more details, which can
 * be found here: http://www.gnu.org/copyleft/lesser.html
 */

includes Agilla;
includes LocationDirectory;

/**
 * The Clusterhead Directory interface allows setting and retrieving
 * clusterhead information like the cluster members, bounding box etc.
 *
 * @author Sangeeta Bhattacharya
 */
interface ClusterheadDirectoryI {


  /**
   * Inserts a cluster member into the directory and updates the bounding box
   *
   * @param nbr Id of neighbor who is a clustermember
   * @param range Communication range of neighbor
   */
  command result_t addClusterMember(uint16_t nbr/*, uint16_t range*/);


  /**
   * Removes a cluster member
   *
   * @param nbr Id of cluster member which should be removed from the database
   */
  command result_t removeClusterMember(uint16_t nbr);

  /**
   * Adds an agent to the clusterhead Agent Directory
   *
   * @param aid Agent id
   * @param atype Agent type
   * @param aloc Agent location
   * @param timestamp Timestamp at which agent was detected
   * @param known Indicates if the agent was previously reported (+ve indicates yes, 0 indicates no).
   */
  command result_t addAgent(AgillaAgentID* aid, uint16_t atype, AgillaLocation* aloc, tos_time_t* timestamp, int8_t* known);

  /**
   * Removes an agent from the clusterhead Agent Directory
   *
   * @param aid Agent id
   */
  command result_t removeAgent(AgillaAgentID* aid);

  /**
    * Returns the location of the agent with id "aid" in "aLoc".
    * If agent is not known, the operation returns FAIL
    *
    * @param aid Agent id
    * @param aLoc Agent location returned by the method
   */
  command result_t getAgent(AgillaAgentID* aid, AgillaLocation* aLoc);

  /**
    * Returns the id and location of an agent closest to agent with id "aid" and location "aLoc".
    * If a nearest agent is not found, the operation returns FAIL
    *
    * @param aid Agent id of querying agent
    * @param aLoc Agent location of querying agent
    * @param nearestAgentId Agent id of nearest agent
    * @param nearestAgentLoc Agent location of nearest agent
    */
  command result_t getNearestAgent(AgillaAgentID* aid, AgillaLocation* aLoc, uint16_t* aType,
            AgillaAgentID* nearestAgentId, AgillaLocation* nearestAgentLoc);


  /**
   * Returns agent id and location of all agents of a certain type, stored in the directory
   *
   * @param agentList Pointer to array of struct containing agent id and location
   * @param numAgents Number of agents that are returned in the array
   * @param aType   Type of agents being returned
   */
  command result_t getAllAgents(AgillaLocMAgentInfo* agentList, uint8_t* num_agents, uint16_t* aType);

}

--- NEW FILE: ExpLoggerI.nc ---
/**
 * Logs statistics about the directory service operations.
 *
 * @author Chien-Liang Fok
 */
interface ExpLoggerI
{
  command result_t reset();
  command result_t incQueryMsg();
  command result_t incNumUpdates();
  command result_t sendQueryLatency(uint32_t latency);
  command result_t sendTrace(uint16_t agentID, uint16_t nodeID, uint16_t action, uint16_t success, AgillaLocation loc);
}