Files
sailing-analytics/java/com.tractrac.clientmodule/javadoc/com/tractrac/clientmodule/CompetitorClass.html
T

279 lines
11 KiB
HTML

<!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 (version 1.7.0_25) on Wed Dec 18 16:38:59 UTC 2013 -->
<title>CompetitorClass</title>
<meta name="date" content="2013-12-18">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CompetitorClass";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CompetitorClass.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/tractrac/clientmodule/Competitor.html" title="class in com.tractrac.clientmodule"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/tractrac/clientmodule/ControlPoint.html" title="class in com.tractrac.clientmodule"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/tractrac/clientmodule/CompetitorClass.html" target="_top">Frames</a></li>
<li><a href="CompetitorClass.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.tractrac.clientmodule</div>
<h2 title="Class CompetitorClass" class="title">Class CompetitorClass</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../com/tractrac/clientmodule/details/Attachments.html" title="class in com.tractrac.clientmodule.details">com.tractrac.clientmodule.details.Attachments</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../com/tractrac/clientmodule/details/IdBase.html" title="class in com.tractrac.clientmodule.details">com.tractrac.clientmodule.details.IdBase</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../com/tractrac/clientmodule/details/IdBaseNamed.html" title="class in com.tractrac.clientmodule.details">com.tractrac.clientmodule.details.IdBaseNamed</a></li>
<li>
<ul class="inheritance">
<li>com.tractrac.clientmodule.CompetitorClass</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">CompetitorClass</span>
extends <a href="../../../com/tractrac/clientmodule/details/IdBaseNamed.html" title="class in com.tractrac.clientmodule.details">IdBaseNamed</a></pre>
<div class="block">Encapsulates data related to a Competitor Class in a TracTrac Event.
<p>All Competitors of an Event are typically divided into groups or classes. An instance of a
Competitor Class can be used to represent data related to such a group/class.
<p>An instance of this class has a unique id and a name. Custom data may be attached to each
Competitor Class instance.
<p>Use <a href="../../../com/tractrac/clientmodule/Event.html#addCompetitorClass(java.util.UUID, java.lang.String)"><code>Event.addCompetitorClass(java.util.UUID, java.lang.String)</code></a>
to create a new Competitor Class.</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>2.0</dd>
<dt><span class="strong">Author:</span></dt>
<dd>TracTrac</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/tractrac/clientmodule/Event.html" title="class in com.tractrac.clientmodule"><code>Event</code></a>,
<a href="../../../com/tractrac/clientmodule/Competitor.html" title="class in com.tractrac.clientmodule"><code>Competitor</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../com/tractrac/clientmodule/details/AttKey.html" title="class in com.tractrac.clientmodule.details">AttKey</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/tractrac/clientmodule/CompetitorClass.html#newAttKey()">newAttKey</a></strong>()</code>
<div class="block">Creates a new (static) key to be used to set/get custom data related to competitor classes.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.tractrac.clientmodule.details.IdBaseNamed">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.tractrac.clientmodule.details.<a href="../../../com/tractrac/clientmodule/details/IdBaseNamed.html" title="class in com.tractrac.clientmodule.details">IdBaseNamed</a></h3>
<code><a href="../../../com/tractrac/clientmodule/details/IdBaseNamed.html#getName()">getName</a>, <a href="../../../com/tractrac/clientmodule/details/IdBaseNamed.html#toString()">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.tractrac.clientmodule.details.IdBase">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.tractrac.clientmodule.details.<a href="../../../com/tractrac/clientmodule/details/IdBase.html" title="class in com.tractrac.clientmodule.details">IdBase</a></h3>
<code><a href="../../../com/tractrac/clientmodule/details/IdBase.html#equals(java.lang.Object)">equals</a>, <a href="../../../com/tractrac/clientmodule/details/IdBase.html#getId()">getId</a>, <a href="../../../com/tractrac/clientmodule/details/IdBase.html#hashCode()">hashCode</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.tractrac.clientmodule.details.Attachments">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.tractrac.clientmodule.details.<a href="../../../com/tractrac/clientmodule/details/Attachments.html" title="class in com.tractrac.clientmodule.details">Attachments</a></h3>
<code><a href="../../../com/tractrac/clientmodule/details/Attachments.html#getAttachment(com.tractrac.clientmodule.details.AttKey)">getAttachment</a>, <a href="../../../com/tractrac/clientmodule/details/Attachments.html#setAttachment(com.tractrac.clientmodule.details.AttKey, java.lang.Object)">setAttachment</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="newAttKey()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>newAttKey</h4>
<pre>public static&nbsp;<a href="../../../com/tractrac/clientmodule/details/AttKey.html" title="class in com.tractrac.clientmodule.details">AttKey</a>&nbsp;newAttKey()</pre>
<div class="block">Creates a new (static) key to be used to set/get custom data related to competitor classes.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a new key.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CompetitorClass.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/tractrac/clientmodule/Competitor.html" title="class in com.tractrac.clientmodule"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/tractrac/clientmodule/ControlPoint.html" title="class in com.tractrac.clientmodule"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/tractrac/clientmodule/CompetitorClass.html" target="_top">Frames</a></li>
<li><a href="CompetitorClass.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>