dnac::RenameJointCommand Class Reference

RenameJointCommand is used to rename a joint. More...

#include <RenameJointCommand.h>

Inheritance diagram for dnac::RenameJointCommand:

Collaboration diagram for dnac::RenameJointCommand:

Classes
class	Impl

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

RenameJointCommand is used to rename a joint.

Constructor & Destructor Documentation

RenameJointCommand() [1/5]

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

explicit

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

RenameJointCommand() [2/5]

dnac::RenameJointCommand::RenameJointCommand	(	std::uint16_t	jointIndex,
		const char *	newName,
		MemoryResource *	memRes = nullptr
	)

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

References pImpl.

RenameJointCommand() [3/5]

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

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

References pImpl.

~RenameJointCommand()

dnac::RenameJointCommand::~RenameJointCommand ( )

default

RenameJointCommand() [4/5]

dnac::RenameJointCommand::RenameJointCommand ( const RenameJointCommand &  )

delete

RenameJointCommand() [5/5]

dnac::RenameJointCommand::RenameJointCommand ( RenameJointCommand &&  )

default

Member Function Documentation

operator=() [1/2]

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

delete

operator=() [2/2]

RenameJointCommand & dnac::RenameJointCommand::operator= ( RenameJointCommand &&  )

default

run()

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

overridevirtual

Implements dnac::Command.

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

References pImpl.

setName() [1/2]

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

Method for setting a new name for joint with given name.

Note

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

Parameters

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

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

References pImpl.

setName() [2/2]

void dnac::RenameJointCommand::setName	(	std::uint16_t	jointIndex,
		const char *	newName
	)

Method for setting a new name for joint with given index.

Parameters

jointIndex	The index of the joint whose name to change.
newName	The new name for the joint.

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

References pImpl.

Referenced by main().

Member Data Documentation

pImpl

ScopedPtr<Impl> dnac::RenameJointCommand::pImpl

private

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

---

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

• RenameJointCommand.h
• RenameJointCommand.cpp