Class ToolStatusEvent

Event raised when a tool's status changes.

Inheritance
object
ToolStatusEvent
Implements
Inherited Members
Namespace: Glitch9.AIDevKit
Assembly: Glitch9.AIDevKit.dll
Syntax
public sealed class ToolStatusEvent : IEvent

Constructors

| Edit this page View Source

ToolStatusEvent(ToolType, GenerationStatus?)

Initializes a new instance of the ToolStatusEvent class with a generation status.

Declaration
public ToolStatusEvent(ToolType type, GenerationStatus? generationStatus)
Parameters
Type Name Description
ToolType type

The type of tool.
GenerationStatus? generationStatus

The generation-specific status.
| Edit this page View Source

ToolStatusEvent(ToolType, SearchStatus?)

Initializes a new instance of the ToolStatusEvent class with a search status.

Declaration
public ToolStatusEvent(ToolType type, SearchStatus? searchStatus)
Parameters
Type Name Description
ToolType type

The type of tool.
SearchStatus? searchStatus

The search-specific status.
| Edit this page View Source

ToolStatusEvent(ToolType, ToolStatus?)

Initializes a new instance of the ToolStatusEvent class with a general tool status.

Declaration
public ToolStatusEvent(ToolType type, ToolStatus? toolStatus)
Parameters
Type Name Description
ToolType type

The type of tool.
ToolStatus? toolStatus

The general tool status.

Properties

| Edit this page View Source

GenerationStatus

Gets the generation-specific status, if applicable.

Declaration
public GenerationStatus? GenerationStatus { get; }
Property Value
Type Description
GenerationStatus?
| Edit this page View Source

SearchStatus

Gets the search-specific status, if applicable.

Declaration
public SearchStatus? SearchStatus { get; }
Property Value
Type Description
SearchStatus?
| Edit this page View Source

ToolStatus

Gets the general tool status, if applicable.

Declaration
public ToolStatus? ToolStatus { get; }
Property Value
Type Description
ToolStatus?
| Edit this page View Source

Type

Gets the type of tool.

Declaration
public ToolType Type { get; }
Property Value
Type Description
ToolType

Methods

| Edit this page View Source

Create<T>(ToolType, T)

Creates a new ToolStatusEvent based on the type of status provided.

Declaration
public static ToolStatusEvent Create<T>(ToolType type, T status)
Parameters
Type Name Description
ToolType type

The type of tool.
T status

The status value.
Returns
Type Description
ToolStatusEvent

A new ToolStatusEvent instance.
Type Parameters
Name Description
T

The type of status (ToolStatus, SearchStatus, or GenerationStatus).
Exceptions
Type Condition
ArgumentException

Thrown when the status type is not supported.
| Edit this page View Source

IsFinal()

Determines whether the current status is a final state.

Declaration
public bool IsFinal()
Returns
Type Description
bool

true if the status is final; otherwise, false.
| Edit this page View Source

IsInProgress()

Declaration
public bool IsInProgress()
Returns
Type Description
bool
| Edit this page View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Implements

Extension Methods