BlackLib::errorPWM Struct Reference

Holds BlackPWM errors. More...

#include <BlackErr.h>

Public Member Functions

 errorPWM ()
 errorPWM struct's constructor. More...
 
 errorPWM (errorCorePWM *base)
 errorPWM struct's constructor with errorCorePWM pointer parameter. More...
 

Public Attributes

errorCorePWMpwmCoreErrors
 Pointer of errorCorePWM struct, which stores errors of BlackCorePWM class. More...
 
bool periodFileError
 Period file reading error. More...
 
bool dutyFileError
 Duty file reading error. More...
 
bool runFileError
 Run file reading error. More...
 
bool polarityFileError
 Polarity file reading error. More...
 
bool outOfRange
 Out of range value error. More...
 

Detailed Description

Holds BlackPWM errors.

This struct holds PWM errors and includes pointer of errorCorePWM struct.

Constructor & Destructor Documentation

BlackLib::errorPWM::errorPWM ( )
inline

errorPWM struct's constructor.

This function clears all flags and initializes errorCorePWM struct.

BlackLib::errorPWM::errorPWM ( errorCorePWM base)
inline

errorPWM struct's constructor with errorCorePWM pointer parameter.

Parameters
[in]*basepointer of errorCorePWM struct.

This function clears all flags and assigns input parameter to pwmCoreErrors variable.

Member Data Documentation

bool BlackLib::errorPWM::dutyFileError

Duty file reading error.

Its value can change, when opening pwm's duty value file, at

  • getValue()
  • getNumericValue()
  • getDutyValue()
  • getNumericDutyValue()
  • setDutyPercent()
  • setPeriodTime()
  • setSpaceRatioTime()
  • setLoadRatioTime()

functions in BlackPWM class.

See also
BlackPWM::getValue()
BlackPWM::getNumericValue()
BlackPWM::getDutyValue()
BlackPWM::getNumericDutyValue()
BlackPWM::setDutyPercent()
BlackPWM::setPeriodTime()
BlackPWM::setSpaceRatioTime()
BlackPWM::setLoadRatioTime()
bool BlackLib::errorPWM::outOfRange

Out of range value error.

Its value can change, when setting some variables of pwm, at

  • setDutyPercent()
  • setPeriodTime()
  • setSpaceRatioTime()
  • setLoadRatioTime()

functions in BlackPWM class.

See also
BlackPWM::setDutyPercent()
BlackPWM::setPeriodTime()
BlackPWM::setSpaceRatioTime()
BlackPWM::setLoadRatioTime()
bool BlackLib::errorPWM::periodFileError

Period file reading error.

Its value can change, when opening pwm's period value file, at

  • getValue()
  • getNumericValue()
  • getPeriodValue()
  • getNumericPeriodValue()
  • setPeriodTime()
  • setSpaceRatioTime()
  • setLoadRatioTime()

functions in BlackPWM class.

See also
BlackPWM::getValue()
BlackPWM::getNumericValue()
BlackPWM::getPeriodValue()
BlackPWM::getNumericPeriodValue()
BlackPWM::setPeriodTime()
BlackPWM::setSpaceRatioTime()
BlackPWM::setLoadRatioTime()
bool BlackLib::errorPWM::polarityFileError

Polarity file reading error.

Its value can change, when opening pwm's polarity value file, at

  • getPolarityValue()
  • isPolarityStraight()
  • isPolarityReverse()
  • setPolarity()
  • tooglePolarity()

functions in BlackPWM class.

See also
BlackPWM::getPolarityValue()
BlackPWM::isPolarityStraight()
BlackPWM::isPolarityReverse()
BlackPWM::setPolarity()
BlackPWM::tooglePolarity()
errorCorePWM* BlackLib::errorPWM::pwmCoreErrors

Pointer of errorCorePWM struct, which stores errors of BlackCorePWM class.

This struct initializes at constructor in BlackPWM class.
Its value can set with

  • getErrorsFromCorePWM()

function in BlackCorePWM class.

See also
BlackPWM::BlackPWM()
BlackCorePWM::getErrorsFromCorePWM()
bool BlackLib::errorPWM::runFileError

Run file reading error.

Its value can change, when opening pwm's run value file, at

  • getRunValue()
  • isRunning()
  • setRunState()
  • toggleRunState()

functions in BlackPWM class.

See also
BlackPWM::getRunValue()
BlackPWM::isRunning()
BlackPWM::setRunState()
BlackPWM::toggleRunState()

The documentation for this struct was generated from the following file: