HAN-FUN API  1.5.3
This project provides the common implementation of ULE Alliance's HAN-FUN application protocol.
HF::Interfaces::ColourControl::Saturation_Transition Struct Reference

Saturation Transition. More...

#include <colour_control.h>

+ Inheritance diagram for HF::Interfaces::ColourControl::Saturation_Transition:
+ Collaboration diagram for HF::Interfaces::ColourControl::Saturation_Transition:

Public Member Functions

 Saturation_Transition (IServer &_server, uint16_t period, int32_t step=0, uint16_t n_steps=0, uint16_t end=0)
 Constructor. More...
 
 Saturation_Transition ()=default
 Default constructor.
 
 ~Saturation_Transition ()
 Empty destructor.
 
bool run (uint16_t time)
 Run the transition. More...
 
bool next ()
 Check if the transition should continue. More...
 
- Public Member Functions inherited from HF::Interfaces::ColourControl::ITransition
 ITransition (IServer &_server, uint16_t period)
 Constructor. More...
 

Data Fields

int32_t step
 Hue or Saturation step.
 
uint16_t n_steps
 Counter for the steps needed. More...
 
uint16_t end
 End value to stop the iteration. More...
 
- Data Fields inherited from HF::Interfaces::ColourControl::ITransition
IServerserver
 The server instance.
 
uint16_t period
 Time period for the transition (in 100 msec units). More...
 
uint16_t remaining_time
 Remaining time until the transition is ran. More...
 

Detailed Description

Saturation Transition.

Definition at line 1011 of file colour_control.h.

Constructor & Destructor Documentation

◆ Saturation_Transition()

HF::Interfaces::ColourControl::Saturation_Transition::Saturation_Transition ( IServer _server,
uint16_t  period,
int32_t  step = 0,
uint16_t  n_steps = 0,
uint16_t  end = 0 
)
inline

Constructor.

Parameters
[in]_serverserver instance
[in]periodthe Transition period. In units of 100msec.
[in]stepthe step size for each transition iteration.
[in]n_stepsnumber of steps.
[in]endend value for the transition.

Definition at line 1026 of file colour_control.h.

1028  :
1029  ITransition(_server, period), step(step), n_steps(n_steps), end(end)
1030  {}
uint16_t period
Time period for the transition (in 100 msec units).
ITransition(IServer &_server, uint16_t period)
Constructor.
uint16_t end
End value to stop the iteration.
uint16_t n_steps
Counter for the steps needed.

Member Function Documentation

◆ next()

bool HF::Interfaces::ColourControl::Saturation_Transition::next ( )
inlinevirtual

Check if the transition should continue.

Return values
truethe transition continues.
falsethe transition ended.

Implements HF::Interfaces::ColourControl::ITransition.

Definition at line 1041 of file colour_control.h.

References HF::Interfaces::ColourControl::ITransition::period.

1042  {
1043  return (period != 0 ? true : false);
1044  }
uint16_t period
Time period for the transition (in 100 msec units).

◆ run()

bool HF::Interfaces::ColourControl::Saturation_Transition::run ( uint16_t  time)
virtual

Run the transition.

This will update the remaining time and check if the transition should run.

Parameters
[in]timetime elapsed time since the last call.
Return values
truerun the transition specialization.
falsedon't run the transition specialization.

Reimplemented from HF::Interfaces::ColourControl::ITransition.

Field Documentation

◆ end

uint16_t HF::Interfaces::ColourControl::Saturation_Transition::end

End value to stop the iteration.

Definition at line 1015 of file colour_control.h.

◆ n_steps

uint16_t HF::Interfaces::ColourControl::Saturation_Transition::n_steps

Counter for the steps needed.

Definition at line 1014 of file colour_control.h.


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