ovm_objection

Creates a new objection instance.

Raises the number of objections for the source object by count, which defaults to 1.  The object is usually the this handle of the caller.  If object is not specified or null, the implicit top-level component, ovm_top, is chosen.

Rasing an objection causes the following.

• The source and total objection counts for object are increased by count.
• The objection’s raised virtual method is called, which calls the ovm_component::raised method for all of the components up the hierarchy.

Drops the number of objections for the source object by count, which defaults to 1.  The object is usually the this handle of the caller.  If object is not specified or null, the implicit top-level component, ovm_top, is chosen.

Dropping an objection causes the following.

• The source and total objection counts for object are decreased by count.  It is an error to drop the objection count for object below zero.
• The objection’s dropped virtual method is called, which calls the ovm_component::dropped method for all of the components up the hierarchy.
• If the total objection count has not reached zero for object, then the drop is propagated up the object hierarchy as with raise_objection.  Then, each object in the hierarchy will have updated their source counts--objections that they originated--and total counts--the total number of objections by them and all their descendants.

If the total objection count reaches zero, propagation up the hierarchy is deferred until a configurable drain-time has passed and the ovm_component::all_dropped callback for the current hierarchy level has returned.  The following process occurs for each instance up the hierarchy from the source caller:

A process is forked in a non-blocking fashion, allowing the drop call to return.  The forked process then does the following:

• If a drain time was set for the given object, the process waits for that amount of time.
• The objection’s all_dropped virtual method is called, which calls the ovm_component::all_dropped method (if object is a component).
• The process then waits for the all_dropped callback to complete.
• After the drain time has elapsed and all_dropped callback has completed, propagation of the dropped objection to the parent proceeds as described in raise_objection, except as described below.

If a new objection for this object or any of its descendents is raised during the drain time or during execution of the all_dropped callback at any point, the hierarchical chain described above is terminated and the dropped callback does not go up the hierarchy.  The raised objection will propagate up the hierarchy, but the number of raised propagated up is reduced by the number of drops that were pending waiting for the all_dropped/drain time completion.  Thus, if exactly one objection caused the count to go to zero, and during the drain exactly one new objection comes in, no raises or drops are propagted up the hierarchy,

As an optimization, if the object has no set drain-time and no registered callbacks, the forked process can be skipped and propagation proceeds immediately to the parent as described.

Sets the drain time on the given object to drain.

The drain time is the amount of time to wait once all objections have been dropped before calling the all_dropped callback and propagating the objection to the parent.

If a new objection for this object or any of its descendents is raised during the drain time or during execution of the all_dropped callbacks, the drain_time/all_dropped execution is terminated.

Objection callback that is called when a raise_objection has reached obj.  The default implementation calls ovm_component::raised.

Objection callback that is called when a drop_objection has reached obj.  The default implementation calls ovm_component::dropped.

Objection callback that is called when a drop_objection has reached obj, and the total count for obj goes to zero.  This callback is executed after the drain time associated with obj.  The default implementation calls ovm_component::all_dropped.

Returns the current number of objections raised by the given object.

Returns the current number of objections raised by the given object and all descendants.

Returns the current drain time set for the given object (default: 0 ns).

Displays objection information about the given object.  If object is not specified or null, the implicit top-level component, <ovm_top>, is chosen.  The show_header argument allows control of whether a header is output.

Checks that the given object is derived from either ovm_component or ovm_sequence_base.

This callback is called when the given object’s objection count reaches zero; if the object is the implicit top-level, <ovm_top> then it means there are no more objections raised for the ovm_test_done objection.  Thus, after calling ovm_objection::all_dropped, this method will call global_stop_request to stop the current task-based phase (e.g. run).

Calls ovm_objection::raise_objection after calling qualify.  If the object is not provided or is null, then the implicit top-level component, ovm_top, is chosen.

Calls ovm_objection::drop_objection after calling qualify.  If the object is not provided or is null, then the implicit top-level component, ovm_top, is chosen.