BeoSubActionDive Class Reference

Helper base class for BeoSub dive actions. More...

#include <BeoSub/BeoSubAction.H>

Inheritance diagram for BeoSubActionDive:

[legend]

Collaboration diagram for BeoSubActionDive:

[legend]

List of all members.

Public Member Functions
	BeoSubActionDive (BeoSub *bs, bool pulseWidthControl=false)
	Constructor.
virtual	~BeoSubActionDive ()
	Destructor.
Protected Member Functions
virtual bool	activate (const bool incr)
	Dive for one step (go deeper if incr=true).
virtual bool	turnOnMotor (const bool incr)
virtual bool	turnOffMotor (const bool incr)
virtual float	getPosition () const
	Get a reading of the current depth.
virtual bool	stabilize (const bool pulseWidthControl=false)
	Stabilize the heading.
virtual float	difference (float pos, float target)
	Calculate current and target value differences.

---

Detailed Description

Helper base class for BeoSub dive actions.

Definition at line 106 of file BeoSubAction.H.

---

Constructor & Destructor Documentation

BeoSubActionDive::BeoSubActionDive	(	BeoSub *	bs,
		bool	pulseWidthControl = false
	)

Constructor.

Definition at line 177 of file BeoSubAction.C.

References BeoSub::getHeading(), BeoSubAction::itsDeadBand, BeoSubAction::itsGainD, BeoSubAction::itsGainI, and BeoSubAction::itsGainP.

BeoSubActionDive::~BeoSubActionDive

(

)

[virtual]

Destructor.

Definition at line 196 of file BeoSubAction.C.

---

Member Function Documentation

bool BeoSubActionDive::activate

(

const bool

incr

)

[protected, virtual]

Dive for one step (go deeper if incr=true).

Implements BeoSubAction.

Definition at line 200 of file BeoSubAction.C.

float BeoSubActionDive::difference	(	float	pos,
		float	target
	)			[protected, virtual]

Calculate current and target value differences.

Implements BeoSubAction.

Definition at line 232 of file BeoSubAction.C.

float BeoSubActionDive::getPosition

(

)

const [protected, virtual]

Get a reading of the current depth.

Implements BeoSubAction.

Definition at line 220 of file BeoSubAction.C.

References BeoSub::getDepth().

bool BeoSubActionDive::stabilize

(

const bool

pulseWidthControl = false

)

[protected, virtual]

Stabilize the heading.

Implements BeoSubAction.

Definition at line 224 of file BeoSubAction.C.

References BeoSubAction::execute().

---

The documentation for this class was generated from the following files:

• src/BeoSub/BeoSubAction.H
• src/BeoSub/BeoSubAction.C