dnac::ConditionalCommand< TCommand, TCondition > Class Template Reference

ConditionalCommand is used to run a command if the specified condition is met. More...

#include <ConditionalCommand.h>

Inheritance diagram for dnac::ConditionalCommand< TCommand, TCondition >:

Collaboration diagram for dnac::ConditionalCommand< TCommand, TCondition >:

Public Member Functions
	ConditionalCommand ()
	ConditionalCommand (CommandType *command_, ConditionType condition_)
	~ConditionalCommand ()=default
	ConditionalCommand (const ConditionalCommand &)=delete
ConditionalCommand &	operator= (const ConditionalCommand &)=delete
	ConditionalCommand (ConditionalCommand &&)=default
ConditionalCommand &	operator= (ConditionalCommand &&)=default
void	setCommand (Command *command_)
	Method for setting the command to run. More...
void	setCondition (ConditionType condition_)
	Method for setting the condition under which the command should run. More...
void	run (DNACalibDNAReader *output) override
Public Member Functions inherited from dnac::Command
virtual	~Command ()
virtual void	run (DNACalibDNAReader *output)=0

Private Types
using	CommandType = TCommand
using	ConditionType = TCondition

Private Attributes
CommandType *	command
ConditionType	condition

Detailed Description

template<class TCommand, class TCondition>
class dnac::ConditionalCommand< TCommand, TCondition >

ConditionalCommand is used to run a command if the specified condition is met.

Member Typedef Documentation

CommandType

template<class TCommand , class TCondition >

using dnac::ConditionalCommand< TCommand, TCondition >::CommandType = TCommand

private

ConditionType

template<class TCommand , class TCondition >

using dnac::ConditionalCommand< TCommand, TCondition >::ConditionType = TCondition

private

Constructor & Destructor Documentation

ConditionalCommand() [1/4]

template<class TCommand , class TCondition >

dnac::ConditionalCommand< TCommand, TCondition >::ConditionalCommand ( )

inline

                             :
            command{nullptr},
            condition{} {
        }

ConditionalCommand() [2/4]

template<class TCommand , class TCondition >

dnac::ConditionalCommand< TCommand, TCondition >::ConditionalCommand ( CommandType *  command_, ConditionType  condition_  )

inline

                                                                            :
            command{command_},
            condition{condition_} {
        }

~ConditionalCommand()

template<class TCommand , class TCondition >

dnac::ConditionalCommand< TCommand, TCondition >::~ConditionalCommand ( )

default

ConditionalCommand() [3/4]

template<class TCommand , class TCondition >

dnac::ConditionalCommand< TCommand, TCondition >::ConditionalCommand ( const ConditionalCommand< TCommand, TCondition > &  )

delete

ConditionalCommand() [4/4]

template<class TCommand , class TCondition >

dnac::ConditionalCommand< TCommand, TCondition >::ConditionalCommand ( ConditionalCommand< TCommand, TCondition > &&  )

default

Member Function Documentation

operator=() [1/2]

template<class TCommand , class TCondition >

ConditionalCommand & dnac::ConditionalCommand< TCommand, TCondition >::operator= ( ConditionalCommand< TCommand, TCondition > &&  )

default

operator=() [2/2]

template<class TCommand , class TCondition >

ConditionalCommand & dnac::ConditionalCommand< TCommand, TCondition >::operator= ( const ConditionalCommand< TCommand, TCondition > &  )

delete

run()

template<class TCommand , class TCondition >

void dnac::ConditionalCommand< TCommand, TCondition >::run ( DNACalibDNAReader *  output )

inlineoverridevirtual

Implements dnac::Command.

                                                     {
            if (command && condition(command, output)) {
                command->run(output);
            }
        }

References dnac::ConditionalCommand< TCommand, TCondition >::command, and dnac::ConditionalCommand< TCommand, TCondition >::condition.

setCommand()

template<class TCommand , class TCondition >

void dnac::ConditionalCommand< TCommand, TCondition >::setCommand ( Command *  command_ )

inline

Method for setting the command to run.

Parameters

command_

The command to run.

                                           {
            command = command_;
        }

References dnac::ConditionalCommand< TCommand, TCondition >::command.

setCondition()

template<class TCommand , class TCondition >

void dnac::ConditionalCommand< TCommand, TCondition >::setCondition ( ConditionType  condition_ )

inline

Method for setting the condition under which the command should run.

Parameters

condition_

The condition that should be met.

                                                    {
            condition = condition_;
        }

References dnac::ConditionalCommand< TCommand, TCondition >::condition.

Member Data Documentation

command

template<class TCommand , class TCondition >

CommandType* dnac::ConditionalCommand< TCommand, TCondition >::command

private

Referenced by dnac::ConditionalCommand< TCommand, TCondition >::run(), and dnac::ConditionalCommand< TCommand, TCondition >::setCommand().

condition

template<class TCommand , class TCondition >

ConditionType dnac::ConditionalCommand< TCommand, TCondition >::condition

private

Referenced by dnac::ConditionalCommand< TCommand, TCondition >::run(), and dnac::ConditionalCommand< TCommand, TCondition >::setCondition().

---

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

• ConditionalCommand.h