DESERT 4.0.0
ClMsgMc2CtrStatus Class Reference

#include <uwsc-clmsg.h>

Inheritance diagram for ClMsgMc2CtrStatus:
Inheritance graph
Collaboration diagram for ClMsgMc2CtrStatus:
Collaboration graph

Public Member Functions

 ClMsgMc2CtrStatus (int dest_id)
 
virtual ~ClMsgMc2CtrStatus ()=default
 
ClMsgMc2CtrStatuscopy ()
 
void setRovStatus (bool detect)
 
bool getRovStatus () const
 

Private Attributes

bool rov_status
 

Detailed Description

Class that manages cross layer messages that require the status of the ROV follower.

Constructor & Destructor Documentation

◆ ClMsgMc2CtrStatus()

ClMsgMc2CtrStatus::ClMsgMc2CtrStatus ( int  dest_id)

Class constructor.

Parameters
intID of the destination module

◆ ~ClMsgMc2CtrStatus()

virtual ClMsgMc2CtrStatus::~ClMsgMc2CtrStatus ( )
virtualdefault

Destructor of ClMsgMc2CtrStatus class.

Member Function Documentation

◆ copy()

ClMsgMc2CtrStatus * ClMsgMc2CtrStatus::copy ( )

Creates a copy of the object.

Returns
ClMsgMc2CtrStatus* Pointer to a copy of the object

◆ getRovStatus()

bool ClMsgMc2CtrStatus::getRovStatus ( ) const

Get the rov follower status.

Returns
bool Rov follower status

References rov_status.

◆ setRovStatus()

void ClMsgMc2CtrStatus::setRovStatus ( bool  detect)

Sets the rov follower status.

Parameters
boolRov follower status

References rov_status.

Referenced by UwMissionCoordinatorModule::removeMine().

Member Data Documentation

◆ rov_status

bool ClMsgMc2CtrStatus::rov_status
private

Status of the rov follower, true if detected a mine.

Referenced by getRovStatus(), and setRovStatus().


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