OpenCores
URL https://opencores.org/ocsvn/nocmodel/nocmodel/trunk

Subversion Repositories nocmodel

[/] [nocmodel/] [trunk/] [doc/] [nocmodel.noc_tlm_base.html] - Blame information for rev 2

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 2 dargor
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3
<html><head><title>Python: class noc_tlm_base</title>
4
</head><body bgcolor="#f0f0f8">
5
<p>
6
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7
<tr bgcolor="#ffc8d8">
8
<td colspan=3 valign=bottom>&nbsp;<br>
9
<font color="#000000" face="helvetica, arial"><strong>nocmodel.noc_tlm_base</strong> = <a name="nocmodel.noc_tlm_base">class noc_tlm_base</a></font></td></tr>
10
 
11
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
12
<td colspan=2><tt>Base&nbsp;class&nbsp;for&nbsp;NoC&nbsp;TLM&nbsp;simulator.<br>
13
&nbsp;<br>
14
This&nbsp;class&nbsp;add&nbsp;methods&nbsp;to&nbsp;a&nbsp;NoC&nbsp;object,&nbsp;required&nbsp;for&nbsp;the&nbsp;TLM&nbsp;model.&nbsp;Each&nbsp;<br>
15
derived&nbsp;class&nbsp;must&nbsp;override&nbsp;the&nbsp;methods:<br>
16
&nbsp;<br>
17
*&nbsp;<a href="#nocmodel.noc_tlm_base-__init__">__init__</a>()&nbsp;:&nbsp;its&nbsp;constructor&nbsp;contains&nbsp;the&nbsp;object&nbsp;TLM&nbsp;model&nbsp;(data&nbsp;<br>
18
&nbsp;&nbsp;structures,&nbsp;generators,&nbsp;etc).<br>
19
*&nbsp;<a href="#nocmodel.noc_tlm_base-send">send</a>()&nbsp;<br>
20
*&nbsp;<a href="#nocmodel.noc_tlm_base-recv">recv</a>()<br>
21
&nbsp;<br>
22
Other&nbsp;methods&nbsp;are&nbsp;related&nbsp;to&nbsp;simulation&nbsp;configuration&nbsp;and&nbsp;logging&nbsp;support.<br>&nbsp;</tt></td></tr>
23
<tr><td>&nbsp;</td>
24
<td width="100%">Methods defined here:<br>
25
<dl><dt><a name="noc_tlm_base-__init__"><strong>__init__</strong></a>(self)</dt></dl>
26
 
27
<dl><dt><a name="noc_tlm_base-debug"><strong>debug</strong></a>(self, msg, *args, **kwargs)</dt><dd><tt>#&nbsp;logging&nbsp;methods&nbsp;(only&nbsp;use&nbsp;4&nbsp;levels)</tt></dd></dl>
28
 
29
<dl><dt><a name="noc_tlm_base-debugstate"><strong>debugstate</strong></a>(self)</dt><dd><tt>#&nbsp;special&nbsp;log</tt></dd></dl>
30
 
31
<dl><dt><a name="noc_tlm_base-error"><strong>error</strong></a>(self, msg, *args, **kwargs)</dt></dl>
32
 
33
<dl><dt><a name="noc_tlm_base-get_generators"><strong>get_generators</strong></a>(self)</dt></dl>
34
 
35
<dl><dt><a name="noc_tlm_base-info"><strong>info</strong></a>(self, msg, *args, **kwargs)</dt></dl>
36
 
37
<dl><dt><a name="noc_tlm_base-recv"><strong>recv</strong></a>(self, src, dest, data, addattrs<font color="#909090">=None</font>)</dt><dd><tt>RECV&nbsp;method:&nbsp;this&nbsp;method&nbsp;MUST&nbsp;be&nbsp;called&nbsp;only&nbsp;by&nbsp;the&nbsp;send<br>
38
method&nbsp;of&nbsp;the&nbsp;object&nbsp;who&nbsp;started&nbsp;the&nbsp;transaction.<br>
39
&nbsp;<br>
40
Arguments:<br>
41
*&nbsp;src:&nbsp;source&nbsp;object&nbsp;(or&nbsp;router&nbsp;address)&nbsp;that&nbsp;call&nbsp;this&nbsp;method,&nbsp;i.e.&nbsp;the<br>
42
&nbsp;&nbsp;object&nbsp;that&nbsp;starts&nbsp;the&nbsp;transaction.<br>
43
*&nbsp;dest:&nbsp;destination&nbsp;object&nbsp;(or&nbsp;router&nbsp;address)&nbsp;that&nbsp;receive&nbsp;the&nbsp;data&nbsp;in<br>
44
&nbsp;&nbsp;the&nbsp;transaction.&nbsp;This&nbsp;method&nbsp;will&nbsp;call&nbsp;dest'&nbsp;recv&nbsp;method.<br>
45
*&nbsp;data:&nbsp;data&nbsp;to&nbsp;be&nbsp;sent.&nbsp;Can&nbsp;be&nbsp;anything,&nbsp;but&nbsp;normally&nbsp;is&nbsp;an&nbsp;object&nbsp;of<br>
46
&nbsp;&nbsp;type&nbsp;packet.<br>
47
*&nbsp;addattrs:&nbsp;optional&nbsp;dictionary&nbsp;with&nbsp;additional&nbsp;arguments<br>
48
&nbsp;<br>
49
@return&nbsp;Must&nbsp;return&nbsp;a&nbsp;number:&nbsp;0&nbsp;for&nbsp;everything&nbsp;OK,&nbsp;!=&nbsp;0&nbsp;to&nbsp;show&nbsp;an&nbsp;error<br>
50
&nbsp;&nbsp;&nbsp;&nbsp;relevant&nbsp;to&nbsp;the&nbsp;caller,&nbsp;an&nbsp;exception&nbsp;in&nbsp;case&nbsp;of&nbsp;attribute&nbsp;error</tt></dd></dl>
51
 
52
<dl><dt><a name="noc_tlm_base-send"><strong>send</strong></a>(self, src, dest, data, addattrs<font color="#909090">=None</font>)</dt><dd><tt>SEND&nbsp;method:&nbsp;this&nbsp;method&nbsp;MUST&nbsp;be&nbsp;called&nbsp;only&nbsp;by&nbsp;the&nbsp;local<br>
53
object&nbsp;who&nbsp;wants&nbsp;to&nbsp;start&nbsp;a&nbsp;transaction.<br>
54
&nbsp;<br>
55
This&nbsp;function&nbsp;will&nbsp;call&nbsp;the&nbsp;recv&nbsp;method&nbsp;in&nbsp;the&nbsp;right&nbsp;object.<br>
56
&nbsp;<br>
57
Arguments:<br>
58
*&nbsp;src:&nbsp;source&nbsp;object&nbsp;(or&nbsp;router&nbsp;address)&nbsp;that&nbsp;call&nbsp;this&nbsp;method,&nbsp;i.e.&nbsp;the<br>
59
&nbsp;&nbsp;object&nbsp;that&nbsp;starts&nbsp;the&nbsp;transaction.<br>
60
*&nbsp;dest:&nbsp;destination&nbsp;object&nbsp;(or&nbsp;router&nbsp;address)&nbsp;that&nbsp;receive&nbsp;the&nbsp;data&nbsp;in<br>
61
&nbsp;&nbsp;the&nbsp;transaction.&nbsp;This&nbsp;method&nbsp;will&nbsp;call&nbsp;dest'&nbsp;recv&nbsp;method.<br>
62
*&nbsp;data:&nbsp;data&nbsp;to&nbsp;be&nbsp;sent.&nbsp;Can&nbsp;be&nbsp;anything,&nbsp;but&nbsp;normally&nbsp;is&nbsp;an&nbsp;object&nbsp;of<br>
63
&nbsp;&nbsp;type&nbsp;packet.<br>
64
*&nbsp;addattrs:&nbsp;optional&nbsp;dictionary&nbsp;with&nbsp;additional&nbsp;arguments<br>
65
&nbsp;<br>
66
Return:&nbsp;Must&nbsp;return&nbsp;a&nbsp;number:&nbsp;0&nbsp;for&nbsp;everything&nbsp;OK,&nbsp;!=&nbsp;0&nbsp;to&nbsp;show&nbsp;an&nbsp;error<br>
67
&nbsp;&nbsp;&nbsp;&nbsp;relevant&nbsp;to&nbsp;the&nbsp;caller,&nbsp;an&nbsp;exception&nbsp;in&nbsp;case&nbsp;of&nbsp;attribute&nbsp;error</tt></dd></dl>
68
 
69
<dl><dt><a name="noc_tlm_base-warning"><strong>warning</strong></a>(self, msg, *args, **kwargs)</dt></dl>
70
 
71
</td></tr></table>
72
</body></html>

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.