IncorrectDaemonState class: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 21: | Line 21: | ||
<li>[[IncorrectDaemonState methods syntax|"IncorrectDaemonState methods syntax"]] is a single page that contains the syntax diagrams of all the methods in the class. | <li>[[IncorrectDaemonState methods syntax|"IncorrectDaemonState methods syntax"]] is a single page that contains the syntax diagrams of all the methods in the class. | ||
</ul> | </ul> | ||
<h2>State property</h2> | |||
{{Template:IncorrectDaemonState:State subtitle}} | |||
This <var>[[Classes and Objects#readWrite|ReadOnly]]</var> property returns a <var>[[DaemonState]]</var> enumeration value that indicates the state of the daemon thread at the time the exception was thrown. This value might be useful in determining what caused the exception. | |||
<h3>Syntax</h3> | |||
{{Template:IncorrectDaemonState:State syntax}} | |||
<h4>Syntax terms</h4> | |||
<table class="syntaxTable"> | |||
<tr><th>%sl</th> | |||
<td>This <var>DaemonState</var> enumeration contains the daemon thread's state at the time the exception was thrown. | |||
</td></tr> | |||
<tr><th>%incorrectDaemonState</th> | |||
<td>A reference to an instance of a <var>[[IncorrectDaemonState_class|IncorrectDaemonState]]</var> enumeration. | |||
</td></tr></table> | |||
<h2>New constructor</h2> | <h2>New constructor</h2> | ||
Revision as of 20:20, 15 May 2012
The IncorrectDaemonState exception class indicates that the state of the daemon thread was not correct for a method.
To produce an exception for yourself, you typically use a User Language Throw statement calling the MaxDaemExceeded New constructor:
throw %(maxDaemExceeded):new
The only method of the IncorrectDaemonState exception class is the New constructor. The class has no properties.
This class is available as of Sirius Mods Version 8.1.
The IncorrectDaemonState methods
The following are the available IncorrectDaemonState class methods.
| Method | Description |
|---|---|
| New | Create a new IncorrectDaemonState object |
| State | State of daemon at time of exception |
The methods in the class are described in the subsections that follow. In addition:
- "Notation conventions for methods" has information about the conventions followed.
- "IncorrectDaemonState methods syntax" is a single page that contains the syntax diagrams of all the methods in the class.
State property
State of daemon at time of exception (IncorrectDaemonState class)
[Introduced in Sirius Mods 8.1]
This ReadOnly property returns a DaemonState enumeration value that indicates the state of the daemon thread at the time the exception was thrown. This value might be useful in determining what caused the exception.
Syntax
%daemonState = incorrectDaemonState:State
Syntax terms
| %sl | This DaemonState enumeration contains the daemon thread's state at the time the exception was thrown. |
|---|---|
| %incorrectDaemonState | A reference to an instance of a IncorrectDaemonState enumeration. |
New constructor
Create a new IncorrectDaemonState object (IncorrectDaemonState class)
[Introduced in Sirius Mods 8.1]
This method generates an instance of an IncorrectDaemonState exception. The New method format is as follows:
Syntax
%incorrectDaemonState = [%(IncorrectDaemonState):]New[( [State= daemonState])]
Syntax terms
| %incorrectDaemonState | A reference to an instance of an IncorrectDaemonState object. |
|---|---|
| %(IncorrectDaemonState) | The class name in parentheses denotes a Constructor. See "Usage notes", below, for more information about invoking an IncorrectDaemonState Constructor. |
Usage notes
- As described in "Using New or other Constructors", New can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is Null:
%maxdaem = new %incorrectDaemonState = %(IncorrectDaemonState):new %incorrectDaemonState = %incorrectDaemonState:new