Simple Arduino FSM
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Door Class Reference

Provides the basic Functions to Controll the Door. More...

#include <Door.h>

Public Member Functions

 Door (int positionClosed, int positionOpen)
 Construct a new Door object. More...
 
bool open ()
 Opens the Door one Step per Function-Call. More...
 
bool close ()
 Closes the Door one Step per Function-Call. More...
 

Private Member Functions

void init ()
 Initialisen the Door in closed Position. More...
 

Private Attributes

const int pPosClosed
 Position of the closed door. More...
 
const int pPosOpen
 Position of the open door. More...
 
int pActualPos = 3
 Initial door position somwhere between. More...
 

Detailed Description

Provides the basic Functions to Controll the Door.

Definition at line 22 of file Door.h.

Constructor & Destructor Documentation

◆ Door()

Door::Door ( int  positionClosed,
int  positionOpen 
)

Construct a new Door object.

positionOpen > positionClosed

Parameters
positionOpen- Position in which the Door is Open
positionClosed- Position in which the Door is Closed

Definition at line 14 of file Door.cpp.

Member Function Documentation

◆ open()

bool Door::open ( )

Opens the Door one Step per Function-Call.

Returns
true - The Door is open
false - The Door is closed
Bug:
Example how do document a bug in doxygen

Definition at line 22 of file Door.cpp.

◆ close()

bool Door::close ( )

Closes the Door one Step per Function-Call.

Returns
true - The Door is closed
false - The Door is open

Definition at line 34 of file Door.cpp.

◆ init()

void Door::init ( )
private

Initialisen the Door in closed Position.

Definition at line 47 of file Door.cpp.

Member Data Documentation

◆ pPosClosed

const int Door::pPosClosed
private

Position of the closed door.

Definition at line 53 of file Door.h.

◆ pPosOpen

const int Door::pPosOpen
private

Position of the open door.

Definition at line 54 of file Door.h.

◆ pActualPos

int Door::pActualPos = 3
private

Initial door position somwhere between.

Definition at line 55 of file Door.h.

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