dnac::RenameAnimatedMapCommand Class Reference

RenameAnimatedMapCommand is used to rename an animated map. More...

#include <RenameAnimatedMapCommand.h>

Inheritance diagram for dnac::RenameAnimatedMapCommand:

Collaboration diagram for dnac::RenameAnimatedMapCommand:

Classes
class	Impl

Public Member Functions
DNACAPI	RenameAnimatedMapCommand (MemoryResource *memRes=nullptr)
DNACAPI	RenameAnimatedMapCommand (std::uint16_t animatedMapIndex, const char *newName, MemoryResource *memRes=nullptr)
DNACAPI	RenameAnimatedMapCommand (const char *oldName, const char *newName, MemoryResource *memRes=nullptr)
DNACAPI	~RenameAnimatedMapCommand ()
	RenameAnimatedMapCommand (const RenameAnimatedMapCommand &)=delete
RenameAnimatedMapCommand &	operator= (const RenameAnimatedMapCommand &)=delete
DNACAPI	RenameAnimatedMapCommand (RenameAnimatedMapCommand &&)
DNACAPI RenameAnimatedMapCommand &	operator= (RenameAnimatedMapCommand &&)
DNACAPI void	setName (std::uint16_t animatedMapIndex, const char *newName)
	Method for setting a new name for animated map with given index. More...
DNACAPI void	setName (const char *oldName, const char *newName)
	Method for setting a new name for animated map with given name. 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

RenameAnimatedMapCommand is used to rename an animated map.

Constructor & Destructor Documentation

RenameAnimatedMapCommand() [1/5]

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

explicit

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

RenameAnimatedMapCommand() [2/5]

dnac::RenameAnimatedMapCommand::RenameAnimatedMapCommand	(	std::uint16_t	animatedMapIndex,
		const char *	newName,
		MemoryResource *	memRes = nullptr
	)

                                                                                                                            :
    pImpl{makeScoped<Impl>(memRes)} {
 
    pImpl->setName(animatedMapIndex, newName);
}

References pImpl.

RenameAnimatedMapCommand() [3/5]

dnac::RenameAnimatedMapCommand::RenameAnimatedMapCommand	(	const char *	oldName,
		const char *	newName,
		MemoryResource *	memRes = nullptr
	)

                                                                                                                   :
    pImpl{makeScoped<Impl>(memRes)} {
 
    pImpl->setName(oldName, newName);
}

References pImpl.

~RenameAnimatedMapCommand()

dnac::RenameAnimatedMapCommand::~RenameAnimatedMapCommand ( )

default

RenameAnimatedMapCommand() [4/5]

dnac::RenameAnimatedMapCommand::RenameAnimatedMapCommand ( const RenameAnimatedMapCommand &  )

delete

RenameAnimatedMapCommand() [5/5]

dnac::RenameAnimatedMapCommand::RenameAnimatedMapCommand ( RenameAnimatedMapCommand &&  )

default

Member Function Documentation

operator=() [1/2]

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

delete

operator=() [2/2]

RenameAnimatedMapCommand & dnac::RenameAnimatedMapCommand::operator= ( RenameAnimatedMapCommand &&  )

default

run()

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

overridevirtual

Implements dnac::Command.

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

References pImpl.

setName() [1/2]

void dnac::RenameAnimatedMapCommand::setName	(	const char *	oldName,
		const char *	newName
	)

Method for setting a new name for animated map with given name.

Note

The renaming will not happen if there is no animated map with given current name.

Parameters

oldName	The current name of the animated map whose name to change.
newName	The new name for the animated map.

                                                                               {
    pImpl->setName(oldName, newName);
}

References pImpl.

setName() [2/2]

void dnac::RenameAnimatedMapCommand::setName	(	std::uint16_t	animatedMapIndex,
		const char *	newName
	)

Method for setting a new name for animated map with given index.

Parameters

animatedMapIndex	The index of the animated map whose name to change.
newName	The new name for the animated map.

                                                                                        {
    pImpl->setName(animatedMapIndex, newName);
}

References pImpl.

Member Data Documentation

pImpl

ScopedPtr<Impl> dnac::RenameAnimatedMapCommand::pImpl

private

Referenced by RenameAnimatedMapCommand(), run(), and setName().

---

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

• RenameAnimatedMapCommand.h
• RenameAnimatedMapCommand.cpp