Package org.robwork.sdurw_models
Class ControllerModelPtr
- java.lang.Object
-
- org.robwork.sdurw_models.ControllerModelPtr
-
public class ControllerModelPtr extends java.lang.Object
Ptr stores a pointer and optionally takes ownership of the value.
-
-
Constructor Summary
Constructors Constructor Description ControllerModelPtr()
Default constructor yielding a NULL-pointer.ControllerModelPtr(long cPtr, boolean cMemoryOwn)
ControllerModelPtr(ControllerModel 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 ControllerModel
__ref__()
Dereferencing operator.void
attachTo(FramePtr frame)
Sets the frame to which the controllermodel should be attached
ControllerModelCPtr
cptr()
void
delete()
ControllerModel
deref()
The pointer stored in the object.boolean
equals(ControllerModel p)
static long
getCPtr(ControllerModelPtr obj)
ControllerModel
getDeref()
Member access operator.java.lang.String
getDescription()
returns a description of this controllermodelFrame
getFrame()
The frame to which the controllermodel is attached.
The frame can be NULL.java.lang.String
getName()
returns the name of this controllermodelPropertyMap
getPropertyMap()
gets the propertymap of this controllermodelStateStructurePtr
getStateStructure()
Get the state structure.boolean
isNull()
checks if the pointer is nullboolean
isRegistered()
Check if object has registered its state.boolean
isShared()
check if this Ptr has shared ownership or none
ownershipvoid
registerIn(State state)
initialize this stateless data to a specific statevoid
registerIn(StateStructurePtr state)
register this stateless object in a statestructure.void
setDescription(java.lang.String description)
sets the description of this controllermodelvoid
setName(java.lang.String name)
sets the name of this controllermodelvoid
unregister()
unregisters all state data of this stateless object
-
-
-
Constructor Detail
-
ControllerModelPtr
public ControllerModelPtr(long cPtr, boolean cMemoryOwn)
-
ControllerModelPtr
public ControllerModelPtr()
Default constructor yielding a NULL-pointer.
-
ControllerModelPtr
public ControllerModelPtr(ControllerModel ptr)
Do not take ownership of ptr.
ptr can be null.
The constructor is implicit on purpose.
-
-
Method Detail
-
getCPtr
public static long getCPtr(ControllerModelPtr obj)
-
delete
public void delete()
-
deref
public ControllerModel deref()
The pointer stored in the object.
-
__ref__
public ControllerModel __ref__()
Dereferencing operator.
-
getDeref
public ControllerModel getDeref()
Member access operator.
-
equals
public boolean equals(ControllerModel 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 ControllerModelCPtr cptr()
-
setName
public void setName(java.lang.String name)
sets the name of this controllermodel- Parameters:
name
- [in] name of this controllermodel
-
setDescription
public void setDescription(java.lang.String description)
sets the description of this controllermodel- Parameters:
description
- [in] description of this controllermodel
-
getName
public java.lang.String getName()
returns the name of this controllermodel- Returns:
- name of controllermodel
-
getDescription
public java.lang.String getDescription()
returns a description of this controllermodel- Returns:
- reference to this controllermodels description
-
getFrame
public Frame getFrame()
The frame to which the controllermodel is attached.
The frame can be NULL.
-
attachTo
public void attachTo(FramePtr frame)
Sets the frame to which the controllermodel should be attached
- Parameters:
frame
- The frame, which can be NULL
-
getPropertyMap
public PropertyMap getPropertyMap()
gets the propertymap of this controllermodel
-
registerIn
public void registerIn(State state)
initialize this stateless data to a specific state- Parameters:
state
- [in] the state in which to register the data.
Note: the data will be registered in the state structure of the state
and any copies or other instances of the state will therefore also
contain the added states.
-
registerIn
public void registerIn(StateStructurePtr state)
register this stateless object in a statestructure.
-
unregister
public void unregister()
unregisters all state data of this stateless object
-
getStateStructure
public StateStructurePtr getStateStructure()
Get the state structure.- Returns:
- the state structure.
-
isRegistered
public boolean isRegistered()
Check if object has registered its state.- Returns:
- true if registered, false otherwise.
-
-