dnac::RemoveAnimatedMapCommand Class Reference

RemoveAnimatedMapCommand is used to remove animated maps. More...

#include <RemoveAnimatedMapCommand.h>

Inheritance diagram for dnac::RemoveAnimatedMapCommand:

Collaboration diagram for dnac::RemoveAnimatedMapCommand:

Classes
class	Impl

Public Member Functions
DNACAPI	RemoveAnimatedMapCommand (MemoryResource *memRes=nullptr)
DNACAPI	RemoveAnimatedMapCommand (std::uint16_t animatedMapIndex, MemoryResource *memRes=nullptr)
DNACAPI	RemoveAnimatedMapCommand (ConstArrayView< std::uint16_t > animatedMapIndices, MemoryResource *memRes=nullptr)
DNACAPI	~RemoveAnimatedMapCommand ()
	RemoveAnimatedMapCommand (const RemoveAnimatedMapCommand &)=delete
RemoveAnimatedMapCommand &	operator= (const RemoveAnimatedMapCommand &)=delete
DNACAPI	RemoveAnimatedMapCommand (RemoveAnimatedMapCommand &&)
DNACAPI RemoveAnimatedMapCommand &	operator= (RemoveAnimatedMapCommand &&)
DNACAPI void	setAnimatedMapIndex (std::uint16_t animatedMapIndex)
	Method for setting the index of the animated map to remove. More...
DNACAPI void	setAnimatedMapIndices (ConstArrayView< std::uint16_t > animatedMapIndices)
	Method for setting the indices of animated maps to remove. More...
DNACAPI void	run (DNACalibDNAReader *output) override
Public Member Functions inherited from dnac::Command
virtual	~Command ()
virtual void	run (DNACalibDNAReader *output)=0

Private Attributes
ScopedPtr< Impl >	pImpl

Detailed Description

RemoveAnimatedMapCommand is used to remove animated maps.

Constructor & Destructor Documentation

RemoveAnimatedMapCommand() [1/5]

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

explicit

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

RemoveAnimatedMapCommand() [2/5]

dnac::RemoveAnimatedMapCommand::RemoveAnimatedMapCommand	(	std::uint16_t	animatedMapIndex,
		MemoryResource *	memRes = nullptr
	)

                                                                                                       :
    pImpl{makeScoped<Impl>(memRes)} {
 
    pImpl->setAnimatedMapIndex(animatedMapIndex);
}

References pImpl.

RemoveAnimatedMapCommand() [3/5]

dnac::RemoveAnimatedMapCommand::RemoveAnimatedMapCommand	(	ConstArrayView< std::uint16_t >	animatedMapIndices,
		MemoryResource *	memRes = nullptr
	)

                                                                                                                         :
    pImpl{makeScoped<Impl>(memRes)} {
 
    pImpl->setAnimatedMapIndices(animatedMapIndices);
}

References pImpl.

~RemoveAnimatedMapCommand()

dnac::RemoveAnimatedMapCommand::~RemoveAnimatedMapCommand ( )

default

RemoveAnimatedMapCommand() [4/5]

dnac::RemoveAnimatedMapCommand::RemoveAnimatedMapCommand ( const RemoveAnimatedMapCommand &  )

delete

RemoveAnimatedMapCommand() [5/5]

dnac::RemoveAnimatedMapCommand::RemoveAnimatedMapCommand ( RemoveAnimatedMapCommand &&  )

default

Member Function Documentation

operator=() [1/2]

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

delete

operator=() [2/2]

RemoveAnimatedMapCommand & dnac::RemoveAnimatedMapCommand::operator= ( RemoveAnimatedMapCommand &&  )

default

run()

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

overridevirtual

Implements dnac::Command.

                                                            {
    pImpl->run(static_cast<DNACalibDNAReaderImpl*>(output));
}

References pImpl.

setAnimatedMapIndex()

void dnac::RemoveAnimatedMapCommand::setAnimatedMapIndex

(

std::uint16_t

animatedMapIndex

)

Method for setting the index of the animated map to remove.

Parameters

animatedMapIndex

The index of the animated map.

Note

Call to either setter overwrites previous setter calls. When running the command, the last set animated map(s) will be removed.

                                                                               {
    pImpl->setAnimatedMapIndex(animatedMapIndex);
}

References pImpl.

setAnimatedMapIndices()

void dnac::RemoveAnimatedMapCommand::setAnimatedMapIndices

(

ConstArrayView< std::uint16_t >

animatedMapIndices

)

Method for setting the indices of animated maps to remove.

Parameters

animatedMapIndices

The animated map indices.

Note

Call to either setter overwrites previous setter calls. When running the command, the last set animated map(s) will be removed.

                                                                                                   {
    pImpl->setAnimatedMapIndices(animatedMapIndices);
}

References pImpl.

Member Data Documentation

pImpl

ScopedPtr<Impl> dnac::RemoveAnimatedMapCommand::pImpl

private

Referenced by RemoveAnimatedMapCommand(), run(), setAnimatedMapIndex(), and setAnimatedMapIndices().

---

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

• RemoveAnimatedMapCommand.h
• RemoveAnimatedMapCommand.cpp