dnac::CommandSequence Class Reference

CommandSequence is used to run a sequence of commands on the same DNA. More...

#include <CommandSequence.h>

Inheritance diagram for dnac::CommandSequence:

Collaboration diagram for dnac::CommandSequence:

Classes
class	Impl

Public Member Functions
DNACAPI	CommandSequence (MemoryResource *memRes=nullptr)
DNACAPI	~CommandSequence ()
	CommandSequence (const CommandSequence &)=delete
CommandSequence &	operator= (const CommandSequence &)=delete
DNACAPI	CommandSequence (CommandSequence &&)
DNACAPI CommandSequence &	operator= (CommandSequence &&)
DNACAPI void	run (DNACalibDNAReader *output) override
DNACAPI void	add (Command *command)
	Method for adding a command to a sequence of commands to run. More...
DNACAPI void	add (ArrayView< Command > commands)
	Method for adding multiple commands to a sequence of commands to run. More...
template<class ... Commands>
void	add (Commands... commands)
DNACAPI void	remove (Command *command)
	Method for removing a command from the sequence of commands to run. More...
DNACAPI void	remove (ArrayView< Command > commands)
	Method for removing an array of commands from the sequence of commands to run. More...
template<class ... Commands>
void	remove (Commands... commands)
DNACAPI bool	contains (Command *command) const
	Method for checking if the provided command is part of the command sequence. More...
DNACAPI std::size_t	size () const
	Number of commands in command sequence. More...
Public Member Functions inherited from dnac::Command
virtual	~Command ()
virtual void	run (DNACalibDNAReader *output)=0

Private Attributes
ScopedPtr< Impl >	pImpl

Detailed Description

CommandSequence is used to run a sequence of commands on the same DNA.

Note

Commands will be run in the order in which they were added to the sequence.

CommandSequence holds pointers to commands, but does not own them.

Constructor & Destructor Documentation

CommandSequence() [1/3]

dnac::CommandSequence::CommandSequence ( MemoryResource *  memRes = nullptr )

explicit

                                                       :
    pImpl{makeScoped<Impl>(memRes)} {
}

~CommandSequence()

dnac::CommandSequence::~CommandSequence ( )

default

CommandSequence() [2/3]

dnac::CommandSequence::CommandSequence ( const CommandSequence &  )

delete

CommandSequence() [3/3]

dnac::CommandSequence::CommandSequence ( CommandSequence &&  )

default

Member Function Documentation

add() [1/3]

void dnac::CommandSequence::add

(

ArrayView< Command >

commands

)

Method for adding multiple commands to a sequence of commands to run.

Parameters

commands

The commands to add.

                                                     {
    for (auto& cmd : commands) {
        pImpl->add(&cmd);
    }
}

References pImpl.

add() [2/3]

void dnac::CommandSequence::add

(

Command *

command

)

Method for adding a command to a sequence of commands to run.

Parameters

command

The command to add.

                                          {
    pImpl->add(command);
}

References pImpl.

Referenced by add(), and main().

add() [3/3]

template<class ... Commands>

void dnac::CommandSequence::add ( Commands...  commands )

inline

                                       {
            static_assert(sizeof...(commands) > 0, "At least one command must be passed.");
            Command* commandList[] = {commands ...};
            for (auto cmd : commandList) {
                add(cmd);
            }
        }

References add().

contains()

bool dnac::CommandSequence::contains

(

Command *

command

)

const

Method for checking if the provided command is part of the command sequence.

Parameters

command

The command to check.

                                                     {
    return pImpl->contains(command);
}

References pImpl.

operator=() [1/2]

CommandSequence & dnac::CommandSequence::operator= ( CommandSequence &&  )

default

operator=() [2/2]

CommandSequence & dnac::CommandSequence::operator= ( const CommandSequence &  )

delete

remove() [1/3]

void dnac::CommandSequence::remove

(

ArrayView< Command >

commands

)

Method for removing an array of commands from the sequence of commands to run.

Parameters

commands

The commands to remove.

                                                        {
    for (auto& cmd : commands) {
        pImpl->remove(&cmd);
    }
}

References pImpl.

remove() [2/3]

void dnac::CommandSequence::remove

(

Command *

command

)

Method for removing a command from the sequence of commands to run.

Parameters

command

The command to remove.

                                             {
    pImpl->remove(command);
}

References pImpl.

Referenced by main(), and remove().

remove() [3/3]

template<class ... Commands>

void dnac::CommandSequence::remove ( Commands...  commands )

inline

                                          {
            static_assert(sizeof...(commands) > 0, "At least one command must be passed.");
            Command* commandList[] = {commands ...};
            for (auto cmd : commandList) {
                remove(cmd);
            }
        }

References remove().

run()

void dnac::CommandSequence::run ( DNACalibDNAReader *  output )

overridevirtual

Implements dnac::Command.

                                                   {
    pImpl->run(output);
}

References pImpl.

Referenced by main().

size()

std::size_t dnac::CommandSequence::size

(

)

const

Number of commands in command sequence.

                                      {
    return pImpl->size();
}

References pImpl.

Member Data Documentation

pImpl

ScopedPtr<Impl> dnac::CommandSequence::pImpl

private

Referenced by add(), contains(), remove(), run(), and size().

---

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

• CommandSequence.h
• src/dnacalib/commands/CommandSequence.cpp