APM:Libraries
Classes | Public Types | Public Member Functions | Static Public Attributes | Private Attributes | Friends | List of all members
AP_LeakDetector Class Reference

#include <AP_LeakDetector.h>

Collaboration diagram for AP_LeakDetector:
[legend]

Classes

struct  LeakDetector_State
 

Public Types

enum  LeakDetector_Type { LEAKDETECTOR_TYPE_NONE = 0, LEAKDETECTOR_TYPE_DIGITAL = 1, LEAKDETECTOR_TYPE_ANALOG = 2 }
 

Public Member Functions

 AP_LeakDetector ()
 
 AP_LeakDetector (const AP_LeakDetector &other)=delete
 
AP_LeakDetectoroperator= (const AP_LeakDetector &)=delete
 
bool get_status (void) const
 
void set_detect (void)
 
void init (void)
 
bool update (void)
 

Static Public Attributes

static const struct AP_Param::GroupInfo var_info []
 

Private Attributes

AP_LeakDetector_Backend_drivers [LEAKDETECTOR_MAX_INSTANCES]
 
LeakDetector_State _state [LEAKDETECTOR_MAX_INSTANCES]
 
bool _status
 
uint32_t _last_detect_ms
 
AP_Int8 _type [LEAKDETECTOR_MAX_INSTANCES]
 
AP_Int8 _pin [LEAKDETECTOR_MAX_INSTANCES]
 
AP_Int8 _default_reading [LEAKDETECTOR_MAX_INSTANCES]
 

Friends

class AP_LeakDetector_Analog
 
class AP_LeakDetector_Digital
 

Detailed Description

Definition at line 11 of file AP_LeakDetector.h.

Member Enumeration Documentation

◆ LeakDetector_Type

Enumerator
LEAKDETECTOR_TYPE_NONE 
LEAKDETECTOR_TYPE_DIGITAL 
LEAKDETECTOR_TYPE_ANALOG 

Definition at line 23 of file AP_LeakDetector.h.

Constructor & Destructor Documentation

◆ AP_LeakDetector() [1/2]

AP_LeakDetector::AP_LeakDetector ( )

Definition at line 56 of file AP_LeakDetector.cpp.

Here is the call graph for this function:

◆ AP_LeakDetector() [2/2]

AP_LeakDetector::AP_LeakDetector ( const AP_LeakDetector other)
delete

Member Function Documentation

◆ get_status()

bool AP_LeakDetector::get_status ( void  ) const
inline

Definition at line 35 of file AP_LeakDetector.h.

Here is the call graph for this function:

◆ init()

void AP_LeakDetector::init ( void  )

Definition at line 66 of file AP_LeakDetector.cpp.

Referenced by get_status().

Here is the caller graph for this function:

◆ operator=()

AP_LeakDetector& AP_LeakDetector::operator= ( const AP_LeakDetector )
delete

◆ set_detect()

void AP_LeakDetector::set_detect ( void  )

Definition at line 103 of file AP_LeakDetector.cpp.

Referenced by get_status().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ update()

bool AP_LeakDetector::update ( void  )

Definition at line 85 of file AP_LeakDetector.cpp.

Referenced by get_status().

Here is the call graph for this function:
Here is the caller graph for this function:

Friends And Related Function Documentation

◆ AP_LeakDetector_Analog

friend class AP_LeakDetector_Analog
friend

Definition at line 13 of file AP_LeakDetector.h.

Referenced by init().

◆ AP_LeakDetector_Digital

friend class AP_LeakDetector_Digital
friend

Definition at line 14 of file AP_LeakDetector.h.

Referenced by init().

Member Data Documentation

◆ _default_reading

AP_Int8 AP_LeakDetector::_default_reading[LEAKDETECTOR_MAX_INSTANCES]
private

◆ _drivers

AP_LeakDetector_Backend* AP_LeakDetector::_drivers[LEAKDETECTOR_MAX_INSTANCES]
private

Definition at line 49 of file AP_LeakDetector.h.

Referenced by AP_LeakDetector(), init(), and update().

◆ _last_detect_ms

uint32_t AP_LeakDetector::_last_detect_ms
private

Definition at line 53 of file AP_LeakDetector.h.

Referenced by set_detect(), and update().

◆ _pin

AP_Int8 AP_LeakDetector::_pin[LEAKDETECTOR_MAX_INSTANCES]
private

◆ _state

LeakDetector_State AP_LeakDetector::_state[LEAKDETECTOR_MAX_INSTANCES]
private

Definition at line 50 of file AP_LeakDetector.h.

Referenced by AP_LeakDetector(), init(), and update().

◆ _status

bool AP_LeakDetector::_status
private

Definition at line 52 of file AP_LeakDetector.h.

Referenced by get_status(), and update().

◆ _type

AP_Int8 AP_LeakDetector::_type[LEAKDETECTOR_MAX_INSTANCES]
private

Definition at line 55 of file AP_LeakDetector.h.

◆ var_info

const AP_Param::GroupInfo AP_LeakDetector::var_info
static

Definition at line 46 of file AP_LeakDetector.h.

Referenced by AP_LeakDetector().


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