/** \file
 *
 *  Specifies the interface details for the WaitDepth component in the
 *  GuidanceModule.
 *
 *  WaitDepth.h should only be included by WaitDepth.cpp
 *  Other classes should include WaitDepthIF.h
 *
 *  Copyright (c) 2007,2008,2009 MBARI
 *  MBARI Proprietary Information.  All Rights Reserved
 */

#ifndef WAITDEPTHIF_H_
#define WAITDEPTHIF_H_

#include "data/ElementURI.h"

/**
 *  Specifies the interface details for the  WaitDepth component in the
 *  GuidanceModule.
 *
 *  WaitDepth.h should only be included by WaitDepth.cpp
 *  Other classes should include  WaitDepthIF.h
 *
 *  \ingroup modules_guidance
 */
namespace WaitDepthIF
{
/// Static const for component name
/// (Can be used by other components)
static const Str NAME( "WaitDepth" );

// Static consts for input settings

/// Target depth. Wait unitl target depth is reached or unitl Timeout if omitted.
static const SettingURI TARGET_DEPTH_SETTING( "targetDepth", "Target depth to reach. Wait "
        "unitl target depth is reached.", Units::METER );

static const SettingURI DEPTH_DEADBAND_SETTING( "depthDeadband", "Deadband tolerance around target depth", Units::METER );

static const SettingURI TIMEOUT_SETTING( "timeout", "Max duration of wait. Satisfies even if the vehicle has not reached the target depth.", Units::SECOND );

}

#endif /*WAITDEPTHIF_H_*/