dnac::RemoveJointCommand Class Reference

RemoveJointCommand is used to remove a joint. More...

#include <RemoveJointCommand.h>

Inheritance diagram for dnac::RemoveJointCommand:

Collaboration diagram for dnac::RemoveJointCommand:

Classes
class	Impl

Public Member Functions
DNACAPI	RemoveJointCommand (MemoryResource *memRes=nullptr)
DNACAPI	RemoveJointCommand (std::uint16_t jointIndex, MemoryResource *memRes=nullptr)
DNACAPI	~RemoveJointCommand ()
	RemoveJointCommand (const RemoveJointCommand &)=delete
RemoveJointCommand &	operator= (const RemoveJointCommand &)=delete
DNACAPI	RemoveJointCommand (RemoveJointCommand &&)
DNACAPI RemoveJointCommand &	operator= (RemoveJointCommand &&)
DNACAPI void	setJointIndex (std::uint16_t jointIndex)
	Method for setting the index of the joint 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

RemoveJointCommand is used to remove a joint.

Constructor & Destructor Documentation

RemoveJointCommand() [1/4]

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

explicit

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

RemoveJointCommand() [2/4]

dnac::RemoveJointCommand::RemoveJointCommand	(	std::uint16_t	jointIndex,
		MemoryResource *	memRes = nullptr
	)

                                                                                     :
    pImpl{makeScoped<Impl>(memRes)} {
 
    pImpl->setJointIndex(jointIndex);
}

References pImpl.

~RemoveJointCommand()

dnac::RemoveJointCommand::~RemoveJointCommand ( )

default

RemoveJointCommand() [3/4]

dnac::RemoveJointCommand::RemoveJointCommand ( const RemoveJointCommand &  )

delete

RemoveJointCommand() [4/4]

dnac::RemoveJointCommand::RemoveJointCommand ( RemoveJointCommand &&  )

default

Member Function Documentation

operator=() [1/2]

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

delete

operator=() [2/2]

RemoveJointCommand & dnac::RemoveJointCommand::operator= ( RemoveJointCommand &&  )

default

run()

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

overridevirtual

Implements dnac::Command.

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

References pImpl.

setJointIndex()

void dnac::RemoveJointCommand::setJointIndex

(

std::uint16_t

jointIndex

)

Method for setting the index of the joint to remove.

Parameters

jointIndex

The index of the joint.

                                                             {
    pImpl->setJointIndex(jointIndex);
}

References pImpl.

Member Data Documentation

pImpl

ScopedPtr<Impl> dnac::RemoveJointCommand::pImpl

private

Referenced by RemoveJointCommand(), run(), and setJointIndex().

---

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

• RemoveJointCommand.h
• RemoveJointCommand.cpp