[source]

Class uvm_pkg::uvm_link_base

uvm_pkg :: uvm_void
- uvm_pkg :: uvm_object
  
  uvm_pkg :: uvm_link_base

Inheritance Diagram of uvm_link_base

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

CLASS

uvm_link_base

The uvm_link_base class presents a simple API for defining a link between any two objects.

Using extensions of this class, a uvm_tr_database can determine the type of links being passed, without relying on "magic" string names.

For example: |

 virtual function void do_establish_link(uvm_link_base link);
   uvm_parent_child_link pc_link;
   uvm_cause_effect_link ce_link;

   if ($cast(pc_link, link)) begin
      // Record the parent-child relationship
   end
   else if ($cast(ce_link, link)) begin
      // Record the cause-effect relationship
   end
   else begin
      // Unsupported relationship!
   end
 endfunction : do_establish_link

Constructors

new(string name = "unnamed-uvm_link_base")

Function

new

Constructor

Parameters

name

Instance name

Parameters:: name (string)

Functions

set_lhs(uvm_object lhs)

Function

set_lhs

Sets the left-hand-side of the link

Triggers the do_set_lhs callback.

Parameters:: lhs (uvm_object)

get_lhs()

Function

get_lhs

Gets the left-hand-side of the link

Triggers the do_get_lhs callback

Return type:: uvm_object

set_rhs(uvm_object rhs)

Function

set_rhs

Sets the right-hand-side of the link

Triggers the do_set_rhs callback.

Parameters:: rhs (uvm_object)

get_rhs()

Function

get_rhs

Gets the right-hand-side of the link

Triggers the do_get_rhs callback

Return type:: uvm_object

set(uvm_object lhs, uvm_object rhs)

Function

set

Convenience method for setting both sides in one call.

Triggers both the do_set_rhs and do_set_lhs callbacks.

Parameters:

lhs (uvm_object)
rhs (uvm_object)

do_set_lhs(uvm_object lhs)

Function

do_set_lhs

Callback for setting the left-hand-side

Parameters:: lhs (uvm_object)

do_get_lhs()

Function

do_get_lhs

Callback for retrieving the left-hand-side

Return type:: uvm_object

do_set_rhs(uvm_object rhs)

Function

do_set_rhs

Callback for setting the right-hand-side

Parameters:: rhs (uvm_object)

do_get_rhs()

Function

do_get_rhs

Callback for retrieving the right-hand-side

Return type:: uvm_object