UnknownStatistic class: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 12: | Line 12: | ||
<h2>The | <h2>The UnknownStatistic methods</h2> | ||
{{Template:List of | {{Template:List of UnknownStatistic methods}} | ||
The methods in the class are described in the subsections that follow. In addition: | The methods in the class are described in the subsections that follow. In addition: | ||
| Line 19: | Line 19: | ||
<li>[[Notation conventions for methods|"Notation conventions for methods"]] has information | <li>[[Notation conventions for methods|"Notation conventions for methods"]] has information | ||
about the conventions followed. | about the conventions followed. | ||
<li>[[ | <li>[[UnknownStatistic methods syntax|"UnknownStatistic methods syntax"]] is a single page that contains the syntax diagrams of all the methods in the class. | ||
</ul> | </ul> | ||
<h2> | <h2>Name property</h2> | ||
{{Template:UnknownStatistic:Name subtitle}} | |||
This <var>[[Classes and Objects#readWrite|ReadOnly]]</var> property returns a string that contains the name of the statistic that is not recognized by the calling method. | |||
<h4>Syntax</h4> | |||
{{Template:UnknownStatistic:Name syntax}} | |||
<h4>Syntax terms</h4> | |||
<table class="syntaxTable"> | |||
<tr><th>%string</th> | |||
<td>This string variable is to contain the name of the unrecognized statistic. | |||
</td></tr> | |||
<tr><th>unknownStatistic</th> | |||
<td>An <var>[[UnknownStatistic_class|UnknownStatistic]]</var> object variable. | |||
</td></tr></table> | |||
<h2>New constructor</h2> | |||
{{Template:UnknownStatistic:New subtitle}} | |||
This constructor generates an instance of an <var>[[UnknownStatistic_class|UnknownStatistic]]</var> exception. As shown below, the required argument of the <var>New</var> method is a specific string value that is ''not'' the name of a valid or appropriate <var class="product">Model 204</var> user statistic for the method that is being called. | |||
<h4>Syntax</h4> | |||
{{Template:UnknownStatistic:New syntax}} | |||
<h4>Syntax terms</h4> | |||
<table class="syntaxTable"> | |||
<tr><th>%unknownStatistic</th> | |||
<td>An <var>[[UnknownStatistic_class|UnknownStatistic]]</var> object variable. | |||
</td></tr> | |||
<tr><th><var>%(UnknownStatistic)</var></th><td>The class name in parentheses denotes a shared method.</td></tr> | |||
<tr><th><var>Name</var></th> | |||
<td>This [[Methods#Named parameters|name required]] parameter specifies the string value (<var class="term">string</var>) that is the name of the statistic for which you are providing the exception. | |||
</td></tr></table> | |||
[[Category:System exception classes]] | [[Category:System exception classes]] | ||
Revision as of 19:45, 10 May 2011
The UnknownStatistic exception class describes an exception associated with finding a string identifier that is not a valid or not an appropriate Model 204 statistic name.
To produce an UnknownStatistic exception for yourself, you typically use a User Language Throw statement with the New UnknownStatistic constructor. For example, the following statement throws an UnknownStatistic exception for the value ABCD:
throw %(unknownStatistic):new(Name='abcd')
In addition to the New constructor that creates an object instance, the class includes a Name property that returns the invalid statistic name.
The UnknownStatistic class is available as of Sirius Mods version 7.3.
The UnknownStatistic methods
The following are the available UnknownStatistic class methods.
| Method | Description |
|---|---|
| Name | Name of statistic not recognized by the method |
| New | Create a new UnknownStatistic object |
The methods in the class are described in the subsections that follow. In addition:
- "Notation conventions for methods" has information about the conventions followed.
- "UnknownStatistic methods syntax" is a single page that contains the syntax diagrams of all the methods in the class.
Name property
Name of statistic not recognized by the method (UnknownStatistic class)
This ReadOnly property returns a string that contains the name of the statistic that is not recognized by the calling method.
Syntax
%string = unknownStatistic:Name
Syntax terms
| %string | This string variable is to contain the name of the unrecognized statistic. |
|---|---|
| unknownStatistic | An UnknownStatistic object variable. |
New constructor
Create a new UnknownStatistic object (UnknownStatistic class)
This constructor generates an instance of an UnknownStatistic exception. As shown below, the required argument of the New method is a specific string value that is not the name of a valid or appropriate Model 204 user statistic for the method that is being called.
Syntax
%unknownStatistic = [%(UnknownStatistic):]New( Name= string)
Syntax terms
| %unknownStatistic | An UnknownStatistic object variable. |
|---|---|
| %(UnknownStatistic) | The class name in parentheses denotes a shared method. |
| Name | This name required parameter specifies the string value (string) that is the name of the statistic for which you are providing the exception. |