KangarooStatus Class

Kangaroo Library for .NET

Stores the response to a status request.

Inheritance Hierarchy

SystemObject
DimensionEngineering.KangarooKangarooStatus

Namespace: DimensionEngineering.Kangaroo
Assembly: DimensionEngineering.Kangaroo (in DimensionEngineering.Kangaroo.dll) Version: 1.0.5.0 (1.0.5.0)

Syntax

C++

Copy

public class KangarooStatus

Public Class KangarooStatus

public ref class KangarooStatus

type KangarooStatus =  class end

The KangarooStatus type exposes the following members.

Constructors

	Name	Description
	KangarooStatus	Constructs a new KangarooStatus by parsing a status response.

Top

Properties

	Name	Description
	Channel	Gets the channel name.
	EchoCode	Gets the echo code associated with this response.
	Error	If the response is an error, gets the error. Otherwise, None is returned.
	Flags	Gets the status flags associated with this response.
	IsBusy	Gets whether a recently-requested command is still executing. For example, P(Int32, Int32, KangarooMoveFlags) is busy while the channel is getting into position, and Home is busy while the channel is homing. Its opposite is .
	IsDone	Gets whether a recently-requested command has completed execution. For example, P(Int32, Int32, KangarooMoveFlags) is done when the channel is in position. Its opposite is .
	IsError	Returns true if the response is an error. Its opposite is .
	IsOK	Returns true if the response is not an error and Value is the requested value. Its opposite is .
	IsValid	Returns true if the KangarooStatus is valid.
	SequenceCode	Gets the sequence code from the most recent command.
	TimedOut	Gets whether a timeout has occurred.
	Type	Gets the type of the request.
	Value	Gets the value associated with this response.

Top

Reference

DimensionEngineering.Kangaroo Namespace