Module simics::api::base::conf_object

source ·
Expand description

Bindings for configuration objects

Enums§

Functions§

  • _attribute_error 🔒
    When used inside an attribute set_attr/get_attr method, indicates why it failed to set or retrieve the attribute. This function only serves to give an informative message to the user. The object or attribute names need not be mentioned in the msg argument; Simics will supply this automatically.
  • _copy_class 🔒
    This function creates a copy of the class src_class named name. Additional attributes and interfaces can be registered on the newly created class.
  • _create_class 🔒
    This function creates a new class that can be instantiated by calling the SIM_create_object function. It is a replacement for SIM_register_class and should be used in all new code.
  • _extend_class 🔒
    The function extends the class cls with attributes, interfaces, port objects and port interfaces defined by the extension class ext.
  • _extension_data 🔒
    Returns the private data pointer of an object associated with the extension class ext_cls. The returned pointer is the value returned by the init_object method called for the extension class ext_cls.
  • _get_class_data 🔒
    Obtain the class data that was set using set_class_data. This can be called at any time during the object initialisation process.
  • _get_class_interface 🔒
    Get an interface of a class
  • _get_class_name 🔒
    Get the name of a class. The name is copied, which differs from the C API.
  • _get_interface 🔒
    Get an interface on an object
  • _marked_for_deletion 🔒
    Indicates if the given object is being deleted. This information can be useful by other objects that want to clean up their references.
  • _object_data 🔒
    Returns the private data pointer of an object. This pointer is available to the class for storing instance-specific state. It is initialised to the return value of the init (from class_info_t) method that is called during object creation. For classes created using the legacy [register_class], the same functionality is provided by the init_object method .
  • _object_descendant 🔒
    Retrieve an object’s descendant with a name, if one exists.
  • _object_id 🔒
    Returns the unique identifier for an object. The identifier is a string that is guaranteed to be unique and will never change, even if the object moves to another hierarchical location.
  • _object_is_configured 🔒
    object_is_configured indicates whether obj is configured.
  • _object_iterator 🔒
    Obtain an iterator over the child objects at all depths of a given object
  • _object_iterator_next 🔒
    Consume and return the next item of an object iterator, if one exists
  • _object_name 🔒
    Returns the name of an object. This name identifies the object uniquely, but may change if the object is moved to another hierarchical location.
  • _object_parent 🔒
    Retrieve the parent object if there is one, or None otherwise.
  • _register_attribute 🔒
    Register a pseudo-untyped attribute of the instances of a class.
  • _register_class_alias 🔒
    Register an alias alias for the existing class class_name. Using aliases allows the read-configuration command to read configuration files that define objects of type alias, while the write-configuration command always uses class_name.
  • _register_class_attribute 🔒
    Register a pseudo-untyped attribute on a class itself.
  • _register_interface 🔒
    Register that cls implements interface I. The interface itself should be supplied in the iface argument.
  • _register_typed_attribute 🔒
    Add the attribute name to the set of attributes of the class cls. This attribute will appear on all instances of the class.
  • _register_typed_class_attribute 🔒
    Register a typed attribute of a class. This attribute will appear on the class object itself and is the same for all instances of the class.
  • _require_object 🔒
    If obj has not yet been set as configured, then that object’s finalize method (post_init in DML) is run; otherwise, nothing happens. After completion of that method, obj will be set as configured.
  • _set_class_data 🔒
    Set extra data for the specified class. This is particularly useful if the same class methods are used for multiple distinct classes, for instance for generated classes. The class data can be fetched at any time during the object initialisation, using get_class_data.
  • _set_object_configured 🔒
    set_object_configured sets the object as configured.
  • _shallow_object_iterator 🔒
    Obtain an iterator over the child objects at depth 1 of a given object
  • attribute_error
    When used inside an attribute set_attr/get_attr method, indicates why it failed to set or retrieve the attribute. This function only serves to give an informative message to the user. The object or attribute names need not be mentioned in the msg argument; Simics will supply this automatically.
  • copy_class
    This function creates a copy of the class src_class named name. Additional attributes and interfaces can be registered on the newly created class.
  • create_class
    This function creates a new class that can be instantiated by calling the SIM_create_object function. It is a replacement for SIM_register_class and should be used in all new code.
  • extend_class
    The function extends the class cls with attributes, interfaces, port objects and port interfaces defined by the extension class ext.
  • extension_data
    Returns the private data pointer of an object associated with the extension class ext_cls. The returned pointer is the value returned by the init_object method called for the extension class ext_cls.
  • get_attr_handler 🔒
  • get_class_attr_handler 🔒
  • get_class_data
    Obtain the class data that was set using set_class_data. This can be called at any time during the object initialisation process.
  • get_class_interface
    Get an interface of a class
  • get_class_name
    Get the name of a class. The name is copied, which differs from the C API.
  • get_interface
    Get an interface on an object
  • get_typed_attr_handler 🔒
  • get_typed_class_attr_handler 🔒
  • marked_for_deletion
    Indicates if the given object is being deleted. This information can be useful by other objects that want to clean up their references.
  • object_data
    Returns the private data pointer of an object. This pointer is available to the class for storing instance-specific state. It is initialised to the return value of the init (from class_info_t) method that is called during object creation. For classes created using the legacy [register_class], the same functionality is provided by the init_object method .
  • object_descendant
    Retrieve an object’s descendant with a name, if one exists.
  • object_id
    Returns the unique identifier for an object. The identifier is a string that is guaranteed to be unique and will never change, even if the object moves to another hierarchical location.
  • object_is_configured
    object_is_configured indicates whether obj is configured.
  • object_iterator
    Obtain an iterator over the child objects at all depths of a given object
  • object_iterator_next
    Consume and return the next item of an object iterator, if one exists
  • object_name
    Returns the name of an object. This name identifies the object uniquely, but may change if the object is moved to another hierarchical location.
  • object_parent
    Retrieve the parent object if there is one, or None otherwise.
  • register_attribute
    Register a pseudo-untyped attribute of the instances of a class.
  • register_class_alias
    Register an alias alias for the existing class class_name. Using aliases allows the read-configuration command to read configuration files that define objects of type alias, while the write-configuration command always uses class_name.
  • register_class_attribute
    Register a pseudo-untyped attribute on a class itself.
  • register_interface
    Register that cls implements interface I. The interface itself should be supplied in the iface argument.
  • register_typed_attribute
    Add the attribute name to the set of attributes of the class cls. This attribute will appear on all instances of the class.
  • register_typed_class_attribute
    Register a typed attribute of a class. This attribute will appear on the class object itself and is the same for all instances of the class.
  • require_object
    If obj has not yet been set as configured, then that object’s finalize method (post_init in DML) is run; otherwise, nothing happens. After completion of that method, obj will be set as configured.
  • set_attr_handler 🔒
  • set_class_attr_handler 🔒
  • set_class_data
    Set extra data for the specified class. This is particularly useful if the same class methods are used for multiple distinct classes, for instance for generated classes. The class data can be fetched at any time during the object initialisation, using get_class_data.
  • set_object_configured
    set_object_configured sets the object as configured.
  • set_typed_attr_handler 🔒
  • set_typed_class_attr_handler 🔒
  • shallow_object_iterator
    Obtain an iterator over the child objects at depth 1 of a given object

Type Aliases§