Notation used in Ruby API documentation
Module: db
Description: A class implementing the comparison of device parameters.
Class hierarchy: GenericDeviceParameterCompare » EqualDeviceParameters
Reimplement this class to provide a custom device parameter compare scheme. Attach this object to a device class with DeviceClass#equal_parameters= to make the device class use this comparer.
This class is intended for special cases. In most scenarios it is easier to use EqualDeviceParameters instead of implementing a custom comparer class.
This class has been added in version 0.26. The 'equal' method has been dropped in 0.27.1 as it can be expressed as !less(a,b) && !less(b,a).
| void | _assign | (const GenericDeviceParameterCompare other) | Assigns another object to self | |
| [const] | GenericDeviceParameterCompare 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] | new GenericDeviceParameterCompare ptr | _dup | Creates a copy of self | |
| [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. | ||
| [virtual,const] | bool | less | (const Device device_a, const Device device_b) | Compares the parameters of two devices for a begin less than b. Returns true, if the parameters of device a are considered less than those of device b.The 'less' implementation needs to ensure strict weak ordering. Specifically, less(a,b) == false and less(b,a) implies that a is equal to b and less(a,b) == true implies that less(b,a) is false and vice versa. If not, an internal error will be encountered on netlist compare. |
_assign | Signature: void _assign (const GenericDeviceParameterCompare other) Description: Assigns another object to self |
_const_cast | Signature: [const] GenericDeviceParameterCompare 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. |
_dup | Signature: [const] new GenericDeviceParameterCompare ptr _dup Description: Creates a copy of self |
_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. |
less | Signature: [virtual,const] bool less (const Device device_a, const Device device_b) Description: Compares the parameters of two devices for a begin less than b. Returns true, if the parameters of device a are considered less than those of device b.The 'less' implementation needs to ensure strict weak ordering. Specifically, less(a,b) == false and less(b,a) implies that a is equal to b and less(a,b) == true implies that less(b,a) is false and vice versa. If not, an internal error will be encountered on netlist compare. |