Package org.robwork.sdurw_trajectory
Class TrajectoryIterator_dPtr
- java.lang.Object
-
- org.robwork.sdurw_trajectory.TrajectoryIterator_dPtr
-
public class TrajectoryIterator_dPtr extends java.lang.ObjectPtr stores a pointer and optionally takes ownership of the value.
-
-
Constructor Summary
Constructors Constructor Description TrajectoryIterator_dPtr()Default constructor yielding a NULL-pointer.TrajectoryIterator_dPtr(long cPtr, boolean cMemoryOwn)TrajectoryIterator_dPtr(TrajectoryIterator_d 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 TrajectoryIterator_d__ref__()Dereferencing operator.voidaddAssign(double dt)This function can be used to increase the iterator position.
The position can be increased no longer than the length of the
complete trajectory.
TrajectoryIterator_dCPtrcptr()doubleddx()Extracts a point of the double derivative of the trajectory at the
current position in the trajectory
voiddec()Method for decreasing the position of the iterator a fixed amount
The decrement is equal to the dt specified in the constructor.voiddec(double dt)Method for decreasing the position of the iterator a fixed amount
voiddelete()TrajectoryIterator_dderef()The pointer stored in the object.doubledx()Extracts a point of the derivative of the trajectory
at the current position in the trajectory
booleanequals(TrajectoryIterator_d p)static longgetCPtr(TrajectoryIterator_dPtr obj)TrajectoryIterator_dgetDeref()Member access operator.doublegetTime()Returns the current position (time) of the iteratorvoidinc()Method for increasing the position of the iterator a fixed amount
The increment is equal to the dt specified in the constructor.voidinc(double dt)Method for increasing the position of the iterator by dt
booleanisBegin()Test if the beginning of the trajectory is reached.
booleanisEnd()Test if the end of the trajectory is reached.
booleanisNull()checks if the pointer is nullbooleanisShared()check if this Ptr has shared ownership or none
ownershipTrajectoryIterator_dnext()Operator overloading ++ for increasing the position of the iterator.
Usage: ++iterator
The increment is equal to the dt specified in the constructor.voidnext(int arg0)Operator overloading ++ for increasing the position of the iterator.
Usage: iterator++
The increment is equal to the dt specified in the constructor.doublepoint()Extracts a point at the current position in the trajectory.
TrajectoryIterator_dprev()Operator overloading -- for decreasing the position of the iterator.
Usage: --iterator;
The decrement is equal to the dt specified in the constructor.voidprev(int arg0)Operator overloading -- for decreasing the position of the iterator.
Usage: iterator--;
The decrement is equal to the dt specified in the constructor.voidsubtractAssign(double dt)This function can be used to decrease the iterator position.
The position can be decreased no longer than to time equals 0.
doublex()Extracts a point at the current position in the trajectory.
-
-
-
Constructor Detail
-
TrajectoryIterator_dPtr
public TrajectoryIterator_dPtr(long cPtr, boolean cMemoryOwn)
-
TrajectoryIterator_dPtr
public TrajectoryIterator_dPtr()
Default constructor yielding a NULL-pointer.
-
TrajectoryIterator_dPtr
public TrajectoryIterator_dPtr(TrajectoryIterator_d ptr)
Do not take ownership of ptr.
ptr can be null.
The constructor is implicit on purpose.
-
-
Method Detail
-
getCPtr
public static long getCPtr(TrajectoryIterator_dPtr obj)
-
delete
public void delete()
-
deref
public TrajectoryIterator_d deref()
The pointer stored in the object.
-
__ref__
public TrajectoryIterator_d __ref__()
Dereferencing operator.
-
getDeref
public TrajectoryIterator_d getDeref()
Member access operator.
-
equals
public boolean equals(TrajectoryIterator_d 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
-
cptr
public TrajectoryIterator_dCPtr cptr()
-
getTime
public double getTime()
Returns the current position (time) of the iterator- Returns:
- The current time.
-
inc
public void inc()
Method for increasing the position of the iterator a fixed amount
The increment is equal to the dt specified in the constructor.
-
inc
public void inc(double dt)
Method for increasing the position of the iterator by dt
- Parameters:
dt- [in] Amount to increase. A positive value is expected.
-
dec
public void dec()
Method for decreasing the position of the iterator a fixed amount
The decrement is equal to the dt specified in the constructor.
-
dec
public void dec(double dt)
Method for decreasing the position of the iterator a fixed amount
- Parameters:
dt- [in] Amount to decrease. A positive value is expected
-
subtractAssign
public void subtractAssign(double dt)
This function can be used to decrease the iterator position.
The position can be decreased no longer than to time equals 0.
- Parameters:
dt- [in] a double that describes how much to decrease the
iterator position
-
addAssign
public void addAssign(double dt)
This function can be used to increase the iterator position.
The position can be increased no longer than the length of the
complete trajectory.
- Parameters:
dt- [in] a double that describes how much to increase the
iterator position
-
next
public TrajectoryIterator_d next()
Operator overloading ++ for increasing the position of the iterator.
Usage: ++iterator
The increment is equal to the dt specified in the constructor.- Returns:
- Reference to the TrajectoryIterator
-
next
public void next(int arg0)
Operator overloading ++ for increasing the position of the iterator.
Usage: iterator++
The increment is equal to the dt specified in the constructor.
-
prev
public TrajectoryIterator_d prev()
Operator overloading -- for decreasing the position of the iterator.
Usage: --iterator;
The decrement is equal to the dt specified in the constructor.- Returns:
- Reference to the TrajectoryIterator
-
prev
public void prev(int arg0)
Operator overloading -- for decreasing the position of the iterator.
Usage: iterator--;
The decrement is equal to the dt specified in the constructor.
-
isEnd
public boolean isEnd()
Test if the end of the trajectory is reached.
- Returns:
- true if the iterator has reached the end of the trajectory false
otherwise.
-
isBegin
public boolean isBegin()
Test if the beginning of the trajectory is reached.
- Returns:
- true if the iterator has reached the beginning of the trajectory
false otherwise.
-
point
public double point()
Extracts a point at the current position in the trajectory.
- Returns:
- the point at the current position in the trajectory.
-
x
public double x()
Extracts a point at the current position in the trajectory.
- Returns:
- the point at the current position in the trajectory.
-
dx
public double dx()
Extracts a point of the derivative of the trajectory
at the current position in the trajectory
- Returns:
- the derived point at the current position in the trajectory.
-
ddx
public double ddx()
Extracts a point of the double derivative of the trajectory at the
current position in the trajectory
- Returns:
- the double derived point at the current position in the trajectory.
-
-