PitchIF.h

Go to the documentation of this file.

#ifndef PITCHIF_H_
#define PITCHIF_H_

#include "data/ElementURI.h"

namespace PitchIF
{
static const Str NAME( "Pitch" );


static const SettingURI DEPTH_SETTING( "depth", "Desired depth to direct the "
                                       "vehicle to. If specified with Pitch, only the absolute value of Pitch "
                                       "is used", Units::METER );

static const SettingURI DEPTH_RATE_SETTING( "depthRate", "Desired depth rate "
        "for the vehicle. Can be specified alone, or with Depth. Overrides "
        "Pitch and PitchRate settings", Units::METER_PER_SECOND );

static const SettingURI ELEVATOR_ANGLE_SETTING( "elevatorAngle", "Desired "
        "elevator angle for the vehicle. Overrides all other settings "
        "except massPosition", Units::RADIAN );

static const SettingURI MASS_POSITION_SETTING( "massPosition", "Desired "
        "massPosition for the vehicle. Overrides all other settings except "
        "ElevatorAngle", Units::METER );

static const SettingURI PITCH_SETTING( "pitch", "Desired pitch of the vehicle. "
                                       "If specified with PitchRate only the absolute value of PitchRate is "
                                       "used. If specified with Depth, only the absolute value of Pitch is "
                                       "used. Overriden by DepthRate setting", Units::RADIAN );

static const SettingURI PITCH_RATE_SETTING( "pitchRate", "Desired pitch rate "
        "of the vehicle. Valid until the vehicle reaches its maximum pitch. "
        "If specified with Pitch, only the absolute value of PitchRate is "
        "used. Overriden by DepthRate setting", Units::RADIAN_PER_SECOND );

}

#endif /*PITCHIF_H_*/