xCPS
Public Member Functions | Protected Attributes | List of all members
Separator Class Reference

#include <Separator.h>

Collaboration diagram for Separator:
Collaboration graph

Public Member Functions

 Separator ()
 
void enable ()
 
void disable ()
 
bool isClosed ()
 
bool isOpen ()
 
void initComm (CommSystem *communication)
 

Protected Attributes

CommSystemcomm
 
int _writemask
 
int _readmaskclosed
 
int _readmaskopen
 
int _writecard
 
int _readcard
 

Detailed Description

Author
Max Houwing
Date
November 23rd, 2015

Control of the separator is offered through this class. Similarly to for example the IndexTable, simply enable() and disable() methods are available to operate the separator. On top of this, two boolean returns methods are available, that can return whether the separator is open (isOpen()), or is closed (isClosed()). Note that calling the enable() method will keep the separator enabled until disable() is called.

Constructor & Destructor Documentation

Separator::Separator ( )

Initializes the separator. Note that the separator has both a sensor for closed and open, so two different masks are used. Also, the _readcard is technically the channel, not the card (but is called card for consistency)

Member Function Documentation

void Separator::disable ( )

Disable the separator.

void Separator::enable ( )

Enables the separator. Note that it will stay enabled until disable() is called.

void Separator::initComm ( CommSystem communication)

Initializes the commmunication between the Seperator and the xCPS system. This function is called in the init() function of the xCPS class, and should otherwise only be used if the usage is known!

bool Separator::isClosed ( )

Function to check if separator is closed. Returns true if indeed closed.

bool Separator::isOpen ( )

Function to check if separator is open. Returns true if indeed open.


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