SuctionCupCPtr (RobWork Java API Documentation)

java.lang.Object
- org.robwork.sdurwsim.SuctionCupCPtr

```
public class SuctionCupCPtr
extends java.lang.Object
```
Ptr stores a pointer and optionally takes ownership of the value.

Constructor Summary

Constructors
Constructor	Description
`SuctionCupCPtr()`	Default constructor yielding a NULL-pointer.
`SuctionCupCPtr(long cPtr, boolean cMemoryOwn)`
`SuctionCupCPtr(SuctionCup 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
`SuctionCup`	`__ref__()`	Dereferencing operator.
`void`	`delete()`
`SuctionCup`	`deref()`	The pointer stored in the object.
`boolean`	`equals(SuctionCup p)`
`static long`	`getCPtr(SuctionCupCPtr obj)`
`SuctionCup`	`getDeref()`	Member access operator.
`boolean`	`isNull()`	checks if the pointer is null
`boolean`	`isShared()`	check if this Ptr has shared ownership or none ownership

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SuctionCupCPtr
```
public SuctionCupCPtr(long cPtr,
                      boolean cMemoryOwn)
```
  - SuctionCupCPtr
```
public SuctionCupCPtr()
```
    Default constructor yielding a NULL-pointer.
  - SuctionCupCPtr
```
public SuctionCupCPtr(SuctionCup ptr)
```
    Do not take ownership of ptr.
    
    ptr can be null.
    
    The constructor is implicit on purpose.
- Method Detail
  - getCPtr
```
public static long getCPtr(SuctionCupCPtr obj)
```
  - delete
```
public void delete()
```
  - deref
```
public SuctionCup deref()
```
    The pointer stored in the object.
  - __ref__
```
public SuctionCup __ref__()
```
    Dereferencing operator.
  - getDeref
```
public SuctionCup getDeref()
```
    Member access operator.
  - equals
```
public boolean equals(SuctionCup 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