Notation used in Ruby API documentation
Module: db
Description: A generic log entry
This class is used for example by the device extractor (see NetlistDeviceExtractor) to keep errors or warnings that occurred during extraction of the devices.
Other classes also make use of this object to store errors, warnings or information. The log entry object features a severity (warning, error, info), a message, an optional category name and description (good for filtering if needed) and an optional DPolygon object for indicating some location or error marker. The original class used to be "NetlistDeviceExtractorError" which had been introduced in version 0.26. It was generalized and renamed in version 0.28.13 as it was basically not useful as a separate class.
| new LogEntryData ptr | new | Creates a new object of this class |
| [const] | LogEntryData ptr | _const_cast | Returns a non-const reference to self. | |
| void | _create | Ensures the C++ object is created | ||
| void | _destroy | Explicitly destroys the object | ||
| [const] | bool | _destroyed? | Returns a value indicating whether the object was already destroyed | |
| [const] | bool | _is_const_object? | Returns a value indicating whether the reference is a const reference | |
| void | _manage | Marks the object as managed by the script side. | ||
| void | _unmanage | Marks the object as no longer owned by the script side. | ||
| void | assign | (const LogEntryData other) | Assigns another object to self | |
| [const] | string | category_description | Gets the category description. | |
| void | category_description= | (string description) | Sets the category description. | |
| [const] | string | category_name | Gets the category name. | |
| void | category_name= | (string name) | Sets the category name. | |
| [const] | string | cell_name | Gets the cell name. | |
| void | cell_name= | (string cell_name) | Sets the cell name. | |
| [const] | new LogEntryData ptr | dup | Creates a copy of self | |
| [const] | DPolygon | geometry | Gets the geometry. | |
| void | geometry= | (const DPolygon polygon) | Sets the geometry. | |
| [const] | string | message | Gets the message text. | |
| void | message= | (string message) | Sets the message text. | |
| [const] | Severity | severity | Gets the severity attribute. | |
| void | severity= | (Severity severity) | Sets the severity attribute. | |
| [const] | string | to_s | (bool with_geometry = true) | Gets the string representation of this error or warning. |
| [static,const] | Severity | Error | Specifies error severity (preferred action is stop) | |
| [static,const] | Severity | Info | Specifies info severity (print if requested, otherwise silent) | |
| [static,const] | Severity | NoSeverity | Specifies no particular severity (default) | |
| [static,const] | Severity | Warning | Specifies warning severity (log with high priority, but do not stop) |
| void | create | Use of this method is deprecated. Use _create instead | ||
| void | destroy | Use of this method is deprecated. Use _destroy instead | ||
| [const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
| [const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
Error | Signature: [static,const] Severity Error Description: Specifies error severity (preferred action is stop) Python specific notes: |
Info | Signature: [static,const] Severity Info Description: Specifies info severity (print if requested, otherwise silent) Python specific notes: |
NoSeverity | Signature: [static,const] Severity NoSeverity Description: Specifies no particular severity (default) Python specific notes: |
Warning | Signature: [static,const] Severity Warning Description: Specifies warning severity (log with high priority, but do not stop) Python specific notes: |
_const_cast | Signature: [const] LogEntryData ptr _const_cast Description: Returns a non-const reference to self. Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects. This method has been introduced in version 0.29.6. |
_create | Signature: void _create Description: Ensures the C++ object is created Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. |
_destroy | Signature: void _destroy Description: Explicitly destroys the object Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. |
_destroyed? | Signature: [const] bool _destroyed? Description: Returns a value indicating whether the object was already destroyed This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself. |
_is_const_object? | Signature: [const] bool _is_const_object? Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self. |
_manage | Signature: void _manage Description: Marks the object as managed by the script side. After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required. Usually it's not required to call this method. It has been introduced in version 0.24. |
_unmanage | Signature: void _unmanage Description: Marks the object as no longer owned by the script side. Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur. Usually it's not required to call this method. It has been introduced in version 0.24. |
assign | Signature: void assign (const LogEntryData other) Description: Assigns another object to self |
category_description | Signature: [const] string category_description Description: Gets the category description. See category_name= for details about categories. Python specific notes: |
category_description= | Signature: void category_description= (string description) Description: Sets the category description. See category_name= for details about categories. Python specific notes: |
category_name | Signature: [const] string category_name Description: Gets the category name. See category_name= for more details. Python specific notes: |
category_name= | Signature: void category_name= (string name) Description: Sets the category name. The category name is optional. If given, it specifies a formal category name. Errors with the same category name are shown in that category. If in addition a category description is specified (see category_description), this description will be displayed as the title. Python specific notes: |
cell_name | Signature: [const] string cell_name Description: Gets the cell name. See cell_name= for details about this attribute. Python specific notes: |
cell_name= | Signature: void cell_name= (string cell_name) Description: Sets the cell name. The cell (or circuit) name specifies the cell or circuit the log entry is related to. If the log entry is an error or warning generated during device extraction, the cell name is the circuit the device should have appeared in. Python specific notes: |
create | Signature: void create Description: Ensures the C++ object is created Use of this method is deprecated. Use _create instead Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. |
destroy | Signature: void destroy Description: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. |
destroyed? | Signature: [const] bool destroyed? Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself. |
dup | Signature: [const] new LogEntryData ptr dup Description: Creates a copy of self Python specific notes: |
geometry | Signature: [const] DPolygon geometry Description: Gets the geometry. See geometry= for more details. Python specific notes: |
geometry= | Signature: void geometry= (const DPolygon polygon) Description: Sets the geometry. The geometry is optional. If given, a marker may be shown when selecting this error. Python specific notes: |
is_const_object? | Signature: [const] bool is_const_object? Description: Returns a value indicating whether the reference is a const reference Use of this method is deprecated. Use _is_const_object? instead This method returns true, if self is a const reference. In that case, only const methods may be called on self. |
message | Signature: [const] string message Description: Gets the message text. Python specific notes: |
message= | Signature: void message= (string message) Description: Sets the message text. Python specific notes: |
new | Signature: [static] new LogEntryData ptr new Description: Creates a new object of this class Python specific notes: |
severity | Signature: [const] Severity severity Description: Gets the severity attribute. Python specific notes: |
severity= | Signature: void severity= (Severity severity) Description: Sets the severity attribute. Python specific notes: |
to_s | Signature: [const] string to_s (bool with_geometry = true) Description: Gets the string representation of this error or warning. This method has been introduced in version 0.28.13. Python specific notes: |