diff options
Diffstat (limited to 'docs/Zone/genmodel/com/arm/cmsis/zone/gen/data/FmZone.html')
-rw-r--r-- | docs/Zone/genmodel/com/arm/cmsis/zone/gen/data/FmZone.html | 417 |
1 files changed, 417 insertions, 0 deletions
diff --git a/docs/Zone/genmodel/com/arm/cmsis/zone/gen/data/FmZone.html b/docs/Zone/genmodel/com/arm/cmsis/zone/gen/data/FmZone.html new file mode 100644 index 0000000..e4a9da2 --- /dev/null +++ b/docs/Zone/genmodel/com/arm/cmsis/zone/gen/data/FmZone.html @@ -0,0 +1,417 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_131) on Thu Jul 06 18:02:39 CEST 2017 --> +<title>FmZone</title> +<meta name="date" content="2017-07-06"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="FmZone"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../com/arm/cmsis/zone/gen/data/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/FmZone.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../com/arm/cmsis/zone/gen/data/FmProcessor.html" title="class in com.arm.cmsis.zone.gen.data"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/arm/cmsis/zone/gen/data/FmZone.html" target="_top">Frames</a></li> +<li><a href="FmZone.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.arm.cmsis.zone.gen.data</div> +<h2 title="Class FmZone" class="title">Class FmZone</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.arm.cmsis.zone.gen.data.FmZone</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">FmZone</span> +extends java.lang.Object</pre> +<div class="block">Project Zone - Generator Data Model Root Element + + Implements the root element for the generator data model. + Gives access to the definition of a single project zone.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Jonatan Antoni</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../com/arm/cmsis/zone/gen/data/FmZone.html#FmZone-com.arm.cmsis.zone.data.ICpZone-">FmZone</a></span>(com.arm.cmsis.zone.data.ICpZone zone)</code> +<div class="block">Create a Zone generator data model element.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>java.util.Collection<<a href="../../../../../../com/arm/cmsis/zone/gen/data/FmBlock.html" title="class in com.arm.cmsis.zone.gen.data">FmBlock</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/arm/cmsis/zone/gen/data/FmZone.html#getBlocks--">getBlocks</a></span>()</code> +<div class="block">Get a collection with all blocks assigned to this zone.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../com/arm/cmsis/zone/gen/data/FmDevice.html" title="class in com.arm.cmsis.zone.gen.data">FmDevice</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/arm/cmsis/zone/gen/data/FmZone.html#getDevice--">getDevice</a></span>()</code> +<div class="block">Get the device this zone is linked to.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/arm/cmsis/zone/gen/data/FmZone.html#getName--">getName</a></span>()</code> +<div class="block">Get the zones name.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>java.util.Collection<<a href="../../../../../../com/arm/cmsis/zone/gen/data/FmProcess.html" title="class in com.arm.cmsis.zone.gen.data">FmProcess</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/arm/cmsis/zone/gen/data/FmZone.html#getProcesses--">getProcesses</a></span>()</code> +<div class="block">Get a collection of all processes defined in this zone.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../com/arm/cmsis/zone/gen/data/FmProcessor.html" title="class in com.arm.cmsis.zone.gen.data">FmProcessor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/arm/cmsis/zone/gen/data/FmZone.html#getProcessor--">getProcessor</a></span>()</code> +<div class="block">Get the processor this zone is linked to.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>java.util.Collection<<a href="../../../../../../com/arm/cmsis/zone/gen/data/FmBlock.html" title="class in com.arm.cmsis.zone.gen.data">FmBlock</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/arm/cmsis/zone/gen/data/FmZone.html#getVisibleBlocks--">getVisibleBlocks</a></span>()</code> +<div class="block">Get a collection with all leaf blocks visible to this zone.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>java.util.Collection<<a href="../../../../../../com/arm/cmsis/zone/gen/data/FmBlock.html" title="class in com.arm.cmsis.zone.gen.data">FmBlock</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/arm/cmsis/zone/gen/data/FmZone.html#getVisibleResources--">getVisibleResources</a></span>()</code> +<div class="block">Get a collection with all resources visible to this zone.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="FmZone-com.arm.cmsis.zone.data.ICpZone-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FmZone</h4> +<pre>public FmZone(com.arm.cmsis.zone.data.ICpZone zone)</pre> +<div class="block">Create a Zone generator data model element.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>zone</code> - The storage data model element to wrap.</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<div class="block">Get the zones name.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Zone name</dd> +</dl> +</li> +</ul> +<a name="getBlocks--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlocks</h4> +<pre>public java.util.Collection<<a href="../../../../../../com/arm/cmsis/zone/gen/data/FmBlock.html" title="class in com.arm.cmsis.zone.gen.data">FmBlock</a>> getBlocks()</pre> +<div class="block">Get a collection with all blocks assigned to this zone.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Collection of assigned blocks.</dd> +</dl> +</li> +</ul> +<a name="getVisibleBlocks--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVisibleBlocks</h4> +<pre>public java.util.Collection<<a href="../../../../../../com/arm/cmsis/zone/gen/data/FmBlock.html" title="class in com.arm.cmsis.zone.gen.data">FmBlock</a>> getVisibleBlocks()</pre> +<div class="block">Get a collection with all leaf blocks visible to this zone. + + A block is considered to be visible if it is mapped at least once + into the logical address space of the zones linked processor.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Collection of visible blocks.</dd> +</dl> +</li> +</ul> +<a name="getVisibleResources--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVisibleResources</h4> +<pre>public java.util.Collection<<a href="../../../../../../com/arm/cmsis/zone/gen/data/FmBlock.html" title="class in com.arm.cmsis.zone.gen.data">FmBlock</a>> getVisibleResources()</pre> +<div class="block">Get a collection with all resources visible to this zone. + + A resource is considered to be visible if it is mapped at least once + into the logical address space of the zones linked processor.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Collection of visible resources.</dd> +</dl> +</li> +</ul> +<a name="getDevice--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDevice</h4> +<pre>public <a href="../../../../../../com/arm/cmsis/zone/gen/data/FmDevice.html" title="class in com.arm.cmsis.zone.gen.data">FmDevice</a> getDevice()</pre> +<div class="block">Get the device this zone is linked to.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Linked device.</dd> +</dl> +</li> +</ul> +<a name="getProcessor--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProcessor</h4> +<pre>public <a href="../../../../../../com/arm/cmsis/zone/gen/data/FmProcessor.html" title="class in com.arm.cmsis.zone.gen.data">FmProcessor</a> getProcessor()</pre> +<div class="block">Get the processor this zone is linked to.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Linked processor.</dd> +</dl> +</li> +</ul> +<a name="getProcesses--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getProcesses</h4> +<pre>public java.util.Collection<<a href="../../../../../../com/arm/cmsis/zone/gen/data/FmProcess.html" title="class in com.arm.cmsis.zone.gen.data">FmProcess</a>> getProcesses()</pre> +<div class="block">Get a collection of all processes defined in this zone.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Collection of processes.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../com/arm/cmsis/zone/gen/data/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/FmZone.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../com/arm/cmsis/zone/gen/data/FmProcessor.html" title="class in com.arm.cmsis.zone.gen.data"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/arm/cmsis/zone/gen/data/FmZone.html" target="_top">Frames</a></li> +<li><a href="FmZone.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |