Class ControllerModelPtr

  • public class ControllerModelPtr
    extends java.lang.Object
    Ptr stores a pointer and optionally takes ownership of the value.
    • 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

      • delete

        public void delete()
      • isShared

        public boolean isShared()
        check if this Ptr has shared ownership or none
        true if Ptr has shared ownership, false if it has no ownership.
      • isNull

        public boolean isNull()
        checks if the pointer is null
        Returns true if the pointer is null
      • setName

        public void setName​(java.lang.String name)
        sets the name of this controllermodel
        name - [in] name of this controllermodel
      • setDescription

        public void setDescription​(java.lang.String description)
        sets the description of this controllermodel
        description - [in] description of this controllermodel
      • getName

        public java.lang.String getName()
        returns the name of this controllermodel
        name of controllermodel
      • getDescription

        public java.lang.String getDescription()
        returns a description of this controllermodel
        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

        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
        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.
        the state structure.
      • isRegistered

        public boolean isRegistered()
        Check if object has registered its state.
        true if registered, false otherwise.