Package org.robwork.sdurw_models
Class CompositeDeviceCPtr
- java.lang.Object
-
- org.robwork.sdurw_models.CompositeDeviceCPtr
-
public class CompositeDeviceCPtr extends java.lang.Object
Ptr stores a pointer and optionally takes ownership of the value.
-
-
Constructor Summary
Constructors Constructor Description CompositeDeviceCPtr()
Default constructor yielding a NULL-pointer.CompositeDeviceCPtr(long cPtr, boolean cMemoryOwn)
CompositeDeviceCPtr(CompositeDevice ptr)
Do not take ownership of ptr.
ptr can be null.
The constructor is implicit on purpose.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description CompositeDevice
__ref__()
Dereferencing operator.JacobianCalculatorPtr
baseJCend(State state)
DeviceJacobian for the end frame.
By default this method forwards to baseDJframe().JacobianCalculatorPtr
baseJCframe(FrameCPtr frame, State state)
DeviceJacobian for a particular frame.
By default this method forwards to baseDJframes().JacobianCalculatorPtr
baseJCframes(FrameVector frames, State state)
Jacobian
baseJend(State state)
Jacobian
baseJends(State state)
like Device::baseJend() but with a Jacobian calculated for all
end-effectors (see getEnds()).Jacobian
baseJframe(FrameCPtr frame, State state)
Calculates the jacobian matrix of a frame f described in the
robot base frame ^{base}_{frame}\mathbf{J}_{\mathbf{q}}(\mathbf{q})
Jacobian
baseJframes(FrameVector frames, State state)
The Jacobian for a sequence of frames.
A Jacobian is computed for each of the frames and the Jacobians are
stacked on top of eachother.Transform3D
baseTend(State state)
Calculates the homogeneous transform from base to the end frame
\robabx{base}{end}{\mathbf{T}}Transform3D
baseTframe(FrameCPtr f, State state)
Calculates the homogeneous transform from base to a frame f
\robabx{b}{f}{\mathbf{T}}void
delete()
CompositeDevice
deref()
The pointer stored in the object.boolean
equals(CompositeDevice p)
Q
getAccelerationLimits()
PairQ
getBounds()
static long
getCPtr(CompositeDeviceCPtr obj)
CompositeDevice
getDeref()
Member access operator.long
getDOF()
FrameVector
getEnds()
The end-effectors of the composite device.
The end-effectors of the composite device are the end-effectors of
the devices from which the composite device was constructed.
This sequence of end-effectors may or may not include the default
end-effector returned by getEnd().VectorJoint_p
getJoints()
Get all joints of this devicejava.lang.String
getName()
Returns the name of the deviceQ
getQ(State state)
Q
getVelocityLimits()
boolean
isNull()
checks if the pointer is nullboolean
isShared()
check if this Ptr has shared ownership or none
ownershipvoid
setQ(Q q, State state)
The method is implemented via forwarding to the Device::setQ()
methods of the subdevices.Transform3D
worldTbase(State state)
Calculates the homogeneous transform from world to base \robabx{w}{b}{\mathbf{T}}
-
-
-
Constructor Detail
-
CompositeDeviceCPtr
public CompositeDeviceCPtr(long cPtr, boolean cMemoryOwn)
-
CompositeDeviceCPtr
public CompositeDeviceCPtr()
Default constructor yielding a NULL-pointer.
-
CompositeDeviceCPtr
public CompositeDeviceCPtr(CompositeDevice ptr)
Do not take ownership of ptr.
ptr can be null.
The constructor is implicit on purpose.
-
-
Method Detail
-
getCPtr
public static long getCPtr(CompositeDeviceCPtr obj)
-
delete
public void delete()
-
deref
public CompositeDevice deref()
The pointer stored in the object.
-
__ref__
public CompositeDevice __ref__()
Dereferencing operator.
-
getDeref
public CompositeDevice getDeref()
Member access operator.
-
equals
public boolean equals(CompositeDevice p)
-
isShared
public boolean isShared()
check if this Ptr has shared ownership or none
ownership- Returns:
- true if Ptr has shared ownership, false if it has no ownership.
-
isNull
public boolean isNull()
checks if the pointer is null- Returns:
- Returns true if the pointer is null
-
setQ
public void setQ(Q q, State state)
The method is implemented via forwarding to the Device::setQ()
methods of the subdevices.
-
baseJends
public Jacobian baseJends(State state)
like Device::baseJend() but with a Jacobian calculated for all
end-effectors (see getEnds()).
-
getEnds
public FrameVector getEnds()
The end-effectors of the composite device.
The end-effectors of the composite device are the end-effectors of
the devices from which the composite device was constructed.
This sequence of end-effectors may or may not include the default
end-effector returned by getEnd().
-
getJoints
public VectorJoint_p getJoints()
Get all joints of this device- Returns:
- all joints
-
getDOF
public long getDOF()
-
getBounds
public PairQ getBounds()
-
getVelocityLimits
public Q getVelocityLimits()
-
getAccelerationLimits
public Q getAccelerationLimits()
-
baseJCframes
public JacobianCalculatorPtr baseJCframes(FrameVector frames, State state)
-
getName
public java.lang.String getName()
Returns the name of the device- Returns:
- name of the device
-
baseTframe
public Transform3D baseTframe(FrameCPtr f, State state)
Calculates the homogeneous transform from base to a frame f
\robabx{b}{f}{\mathbf{T}}- Returns:
- the homogeneous transform \robabx{b}{f}{\mathbf{T}}
-
baseTend
public Transform3D baseTend(State state)
Calculates the homogeneous transform from base to the end frame
\robabx{base}{end}{\mathbf{T}}- Returns:
- the homogeneous transform \robabx{base}{end}{\mathbf{T}}
-
worldTbase
public Transform3D worldTbase(State state)
Calculates the homogeneous transform from world to base \robabx{w}{b}{\mathbf{T}}
- Returns:
- the homogeneous transform \robabx{w}{b}{\mathbf{T}}
-
baseJframe
public Jacobian baseJframe(FrameCPtr frame, State state)
Calculates the jacobian matrix of a frame f described in the
robot base frame ^{base}_{frame}\mathbf{J}_{\mathbf{q}}(\mathbf{q})
- Parameters:
frame
- [in] Frame for which to calculate the Jacobianstate
- [in] State for which to calculate the Jacobian
- Returns:
- the 6*ndof jacobian matrix:
{^{base}_{frame}}\mathbf{J}_{\mathbf{q}}(\mathbf{q})
This method calculates the jacobian relating joint velocities ( \mathbf{\dot{q}} ) to the frame f velocity seen from base-frame
( \nu^{base}_{frame} )
\nu^{base}_{frame} = {^{base}_{frame}}\mathbf{J}_\mathbf{q}(\mathbf{q})\mathbf{\dot{q}}
The jacobian matrix {^{base}_n}\mathbf{J}_{\mathbf{q}}(\mathbf{q})
is defined as:
{^{base}_n}\mathbf{J}_{\mathbf{q}}(\mathbf{q}) = \frac{\partial ^{base}\mathbf{x}_n}{\partial \mathbf{q}}
By default the method forwards to baseJframes().
-
baseJframes
public Jacobian baseJframes(FrameVector frames, State state)
The Jacobian for a sequence of frames.
A Jacobian is computed for each of the frames and the Jacobians are
stacked on top of eachother.- Parameters:
frames
- [in] the frames to calculate the frames fromstate
- [in] the state to calculate in- Returns:
- the jacobian
-
baseJCend
public JacobianCalculatorPtr baseJCend(State state)
DeviceJacobian for the end frame.
By default this method forwards to baseDJframe().
-
baseJCframe
public JacobianCalculatorPtr baseJCframe(FrameCPtr frame, State state)
DeviceJacobian for a particular frame.
By default this method forwards to baseDJframes().
-
-