Using Maps in ODB

A map in ODB is a list of simulation entities which has been collected according to some selection criteria specified in an ODB map command. Map lists provide information about each selected entity, such as its ID and topological “location” (hence the term “map”). The two most common selection criteria are:

  • selection of a specific entity, in which case the resulting list consists of the single specified entity (this type of selection is used to simply determine the location of the identified entity)
  • selection of all entities of a particular type

The output of a typical map command appears below:

Figure 21: Map Command Output

ODB> objmap burxch

Obj ID   Obj Name                        Obj Type         Parent ID
---------------------------------------------------------------------------
25       top.lan0.e0.bus_rx[0]           bus rx channel           24
43       top.lan0.e1.bux_rx[0]           bus rx channel           42
61       top.lan0.e2.bus_rx[0]           bus rx channel           60
79       top.lan0.e3.bus_rx[0]           bus rx channel           78
97       top.lan0.e4.bux_rx[0]           bus rx channel           96

Maps are useful for determining the IDs of entities to which other ODB commands will be applied. Maps of dynamic entities (such as packets and processes) are a convenient way to get an overview of a simulation’s state. The ODB map commands are listed below.

Table 15: Map Commands

"evprint" Displays a list of pending events that match a specified selection criteria. The list consists of an ODB event banner for each event.
"objassoc" Displays a list of all associations of a specified object that match a specified selection criteria (associations are objects which are connected to the specified object). The list includes a line for each association, displaying its object ID and full name.
"objmap" Displays a list of all objects that match a specified selection criteria. The list includes a line for each object, displaying its object ID, full name, type, and parent’s object ID.
"ovismap" Displays a list of OVIS objects that match a specified selection criteria.
"pkmap" Displays a list of all packets that match a specified selection criteria. The list includes a line for each packet, displaying its packet ID, packet tree ID, and owner name.
"pktimemap" Displays a chronological list of packets from the specified time frame.
"promap" Displays a list of all processes that match a specified selection criteria. The list includes a line for each process, displaying its process ID, associated model, tag, and owner object ID.
"ptmap" Displays a list of all packets that belong to the specified packet tree. The list includes a line for each packet, displaying its packet ID, packet tree ID, and owner name.