3.10.1.2.1.3. opengate.actors.base

3.10.1.2.1.3.1. Classes

ActorBase

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

3.10.1.2.1.3.2. Functions

_setter_hook_attached_to(self, attached_to)	Hook to be attached to property setter of user input 'attached_to' in all actors.
shortcut_for_single_output_actor(func)	Decorator for shortcut methods and properties that may be used only

3.10.1.2.1.3.3. Module Contents

opengate.actors.base._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.

opengate.actors.base.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.

class opengate.actors.base.ActorBase(*args, **kwargs)

Bases: 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.

attached_to: str

filters: list

filters_boolean_operator: str

priority: int

user_info_defaults

_existing_properties_to_interfaces

actor_engine = None

user_output

interfaces_to_user_output

__initcpp__()

Nothing to do in the base class.

__getstate__()

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

__setstate__(state)

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

to_dictionary()

from_dictionary(d)

get_data(name=None, **kwargs)

property output_filename

property write_to_disk

get_output_path(name=None, **kwargs)

property actor_manager

property attached_to_volume

close()

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

initialize()

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

_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.

_add_interface_to_user_output(interface_class, user_output_name, interface_name, **kwargs)

_create_interface_property(interface_class_name, interface_name)

__update_interface_properties__()

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

recover_user_output(actor)

store_output_data(output_name, run_index, *data)

write_output_to_disk_if_requested(output_name)

_assert_output_exists(output_name)

get_output_path_for_item(output_name, which, item)

get_output_path_string(**kwargs)

get_output_path_for_item_string(output_name, which, item)

StartSimulationAction()

Default virtual method for inheritance

EndSimulationAction()

Default virtual method for inheritance