opengate.actors.base
====================

.. py:module:: opengate.actors.base


Classes
-------

.. autoapisummary::

   opengate.actors.base.ActorBase


Functions
---------

.. autoapisummary::

   opengate.actors.base._setter_hook_attached_to
   opengate.actors.base.shortcut_for_single_output_actor


Module Contents
---------------

.. py:function:: _setter_hook_attached_to(self, attached_to)

   Hook to be attached to property setter of user input 'attached_to' in all actors.
   Allows the user input 'attached_to_volume' to be volume object or a volume name.


.. py:function:: shortcut_for_single_output_actor(func)

   Decorator for shortcut methods and properties that may be used only
   with actors that handle a single user output.


.. py:class:: ActorBase(*args, **kwargs)

   Bases: :py:obj:`opengate.base.GateObject`


   This is the base class used for all objects that handle user input in GATE.

   The class is assumed to be processed by process_cls(), either explicitly
   or via the metaclass MetaUserInfo, before any instances of the class are created.
   Some class attributes, e.g. inherited_user_info_defaults, are created as part of this processing.


   .. py:attribute:: attached_to
      :type:  str


   .. py:attribute:: filters
      :type:  list


   .. py:attribute:: filters_boolean_operator
      :type:  str


   .. py:attribute:: priority
      :type:  int


   .. py:attribute:: user_info_defaults


   .. py:attribute:: _existing_properties_to_interfaces


   .. py:attribute:: actor_engine
      :value: None



   .. py:attribute:: user_output


   .. py:attribute:: interfaces_to_user_output


   .. py:method:: __initcpp__()

      Nothing to do in the base class.



   .. py:method:: __getstate__()

      Method needed for pickling. May be overridden in inheriting classes.



   .. py:method:: __setstate__(state)

      Method needed for pickling. May be overridden in inheriting classes.



   .. py:method:: to_dictionary()


   .. py:method:: from_dictionary(d)


   .. py:method:: get_data(name=None, **kwargs)


   .. py:property:: output_filename


   .. py:property:: write_to_disk


   .. py:method:: get_output_path(name=None, **kwargs)


   .. py:property:: actor_manager


   .. py:property:: attached_to_volume


   .. py:method:: close()

      Dummy implementation for inherited classes which do not implement this method.



   .. py:method:: initialize()

      This base class method initializes common settings and should be called in all inheriting classes.



   .. py:method:: _add_user_output(actor_output_class, name, can_be_deactivated=False, automatically_generate_interface=True, **kwargs)

      Method to be called internally (not by user) in the specific actor class implementations.



   .. py:method:: _add_interface_to_user_output(interface_class, user_output_name, interface_name, **kwargs)


   .. py:method:: _create_interface_property(interface_class_name, interface_name)


   .. py:method:: __update_interface_properties__()

      Special method to be called when unpickling an object
      to make sure the dynamic properties linking to the interfaces are recreated.



   .. py:method:: recover_user_output(actor)


   .. py:method:: store_output_data(output_name, run_index, *data)


   .. py:method:: write_output_to_disk_if_requested(output_name)


   .. py:method:: _assert_output_exists(output_name)


   .. py:method:: get_output_path_for_item(output_name, which, item)


   .. py:method:: get_output_path_string(**kwargs)


   .. py:method:: get_output_path_for_item_string(output_name, which, item)


   .. py:method:: StartSimulationAction()

      Default virtual method for inheritance



   .. py:method:: EndSimulationAction()

      Default virtual method for inheritance