dnac::RemoveJointCommand Class Reference

RemoveJointCommand is used to remove joints. 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 (ConstArrayView< std::uint16_t > jointIndices, 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	setJointIndices (ConstArrayView< std::uint16_t > jointIndices)
	Method for setting the indices of joints 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 joints.

Constructor & Destructor Documentation

RemoveJointCommand() [1/5]

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

explicit

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

RemoveJointCommand() [2/5]

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

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

References pImpl.

RemoveJointCommand() [3/5]

dnac::RemoveJointCommand::RemoveJointCommand	(	ConstArrayView< std::uint16_t >	jointIndices,
		MemoryResource *	memRes = nullptr
	)

                                                                                                       :
    pImpl{makeScoped<Impl>(memRes)} {
 
    pImpl->setJointIndices(jointIndices);
}

References pImpl.

~RemoveJointCommand()

dnac::RemoveJointCommand::~RemoveJointCommand ( )

default

RemoveJointCommand() [4/5]

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

delete

RemoveJointCommand() [5/5]

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.

Note

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

                                                             {
    pImpl->setJointIndex(jointIndex);
}

References pImpl.

setJointIndices()

void dnac::RemoveJointCommand::setJointIndices

(

ConstArrayView< std::uint16_t >

jointIndices

)

Method for setting the indices of joints to remove.

Parameters

jointIndices

The joint indices.

Note

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

                                                                                 {
    pImpl->setJointIndices(jointIndices);
}

References pImpl.

Member Data Documentation

pImpl

ScopedPtr<Impl> dnac::RemoveJointCommand::pImpl

private

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

---

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

• RemoveJointCommand.h
• RemoveJointCommand.cpp