Class Switch

Client implementation of an ASCOM Alpaca Switch device.

This class is meant to be use in a client application that need to control an ASCOM Alpaca Switch

Inheritance

System.Object

DeviceBase

Switch

Implements

Inherited Members

DeviceBase.DeviceNumber

DeviceBase.InvokeAction(String, String)

DeviceBase.InvokeActionAsync(String, String)

DeviceBase.SendCommandBlind(String, Boolean)

DeviceBase.SendCommandBlindAsync(String, Boolean)

DeviceBase.SendCommandBool(String, Boolean)

DeviceBase.SendCommandBoolAsync(String, Boolean)

DeviceBase.SendCommandString(String, Boolean)

DeviceBase.SendCommandStringAsync(String, Boolean)

DeviceBase.IsConnected()

DeviceBase.IsConnectedAsync()

DeviceBase.SetConnected(Boolean)

DeviceBase.SetConnectedAsync(Boolean)

DeviceBase.GetDescription()

DeviceBase.GetDescriptionAsync()

DeviceBase.GetDriverInfo()

DeviceBase.GetDriverInfoAsync()

DeviceBase.GetDriverVersion()

DeviceBase.GetDriverVersionAsync()

DeviceBase.GetInterfaceVersion()

DeviceBase.GetInterfaceVersionAsync()

DeviceBase.GetName()

DeviceBase.GetNameAsync()

DeviceBase.GetSupportedActions()

DeviceBase.GetSupportedActionsAsync()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: ES.Ascom.Alpaca.Client.Devices

Assembly: ES.Ascom.Alpaca.Client.dll

Syntax

public sealed class Switch : DeviceBase, ISwitch, IDevice, ISwitchAsync, IDeviceAsync

Constructors

| Improve this Doc View Source

Switch(DeviceConfiguration)

Initializes a new instance of the Switch class.

Declaration

public Switch(DeviceConfiguration configuration)

Parameters

Type	Name	Description
DeviceConfiguration	configuration	Device configuration

| Improve this Doc View Source

Switch(DeviceConfiguration, ILogger)

Initializes a new instance of the Switch class.

Declaration

public Switch(DeviceConfiguration configuration, ILogger logger)

Parameters

Type	Name	Description
DeviceConfiguration	configuration	Device configuration
ILogger	logger	Logger, can be useful for debugging

| Improve this Doc View Source

Switch(DeviceConfiguration, IClientTransactionIdGenerator)

Initializes a new instance of the Switch class.

Declaration

public Switch(DeviceConfiguration configuration, IClientTransactionIdGenerator clientTransactionIdGenerator)

Parameters

Type	Name	Description
DeviceConfiguration	configuration	Device configuration
IClientTransactionIdGenerator	clientTransactionIdGenerator	Client Transaction ID Generator

| Improve this Doc View Source

Switch(DeviceConfiguration, IClientTransactionIdGenerator, ILogger)

Initializes a new instance of the Switch class.

Declaration

public Switch(DeviceConfiguration configuration, IClientTransactionIdGenerator clientTransactionIdGenerator, ILogger logger)

Parameters

Type	Name	Description
DeviceConfiguration	configuration	Device configuration
IClientTransactionIdGenerator	clientTransactionIdGenerator	Client Transaction ID Generator
ILogger	logger	Logger, can be useful for debugging

Properties

| Improve this Doc View Source

DeviceType

Declaration

protected override DeviceType DeviceType { get; }

Property Value

Type	Description
DeviceType

Overrides

ES.Ascom.Alpaca.Client.Devices.DeviceBase.DeviceType

Methods

| Improve this Doc View Source

CanWrite(Int32)

Declaration

public bool CanWrite(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

CanWriteAsync(Int32)

Declaration

public Task<bool> CanWriteAsync(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

| Improve this Doc View Source

GetMaxSwitch()

Declaration

public int GetMaxSwitch()

Returns

Type	Description
System.Int32

| Improve this Doc View Source

GetMaxSwitchAsync()

Declaration

public Task<int> GetMaxSwitchAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

| Improve this Doc View Source

GetMaxSwitchValue(Int32)

Declaration

public double GetMaxSwitchValue(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetMaxSwitchValueAsync(Int32)

Declaration

public Task<double> GetMaxSwitchValueAsync(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.Threading.Tasks.Task<System.Double>

| Improve this Doc View Source

GetMinSwitchValue(Int32)

Declaration

public double GetMinSwitchValue(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetMinSwitchValueAsync(Int32)

Declaration

public Task<double> GetMinSwitchValueAsync(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.Threading.Tasks.Task<System.Double>

| Improve this Doc View Source

GetSwitch(Int32)

Declaration

public bool GetSwitch(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

GetSwitchAsync(Int32)

Declaration

public Task<bool> GetSwitchAsync(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

| Improve this Doc View Source

GetSwitchDescription(Int32)

Declaration

public string GetSwitchDescription(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.String

| Improve this Doc View Source

GetSwitchDescriptionAsync(Int32)

Declaration

public Task<string> GetSwitchDescriptionAsync(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

| Improve this Doc View Source

GetSwitchName(Int32)

Declaration

public string GetSwitchName(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.String

| Improve this Doc View Source

GetSwitchNameAsync(Int32)

Declaration

public Task<string> GetSwitchNameAsync(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

| Improve this Doc View Source

GetSwitchStep(Int32)

Declaration

public double GetSwitchStep(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetSwitchStepAsync(Int32)

Declaration

public Task<double> GetSwitchStepAsync(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.Threading.Tasks.Task<System.Double>

| Improve this Doc View Source

GetSwitchValue(Int32)

Declaration

public double GetSwitchValue(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetSwitchValueAsync(Int32)

Declaration

public Task<double> GetSwitchValueAsync(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.Threading.Tasks.Task<System.Double>

| Improve this Doc View Source

SetSwitch(Int32, Boolean)

Declaration

public void SetSwitch(int id, bool state)

Parameters

Type	Name	Description
System.Int32	id
System.Boolean	state

| Improve this Doc View Source

SetSwitchAsync(Int32, Boolean)

Declaration

public Task SetSwitchAsync(int id, bool state)

Parameters

Type	Name	Description
System.Int32	id
System.Boolean	state

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

SetSwitchName(Int32, String)

Declaration

public void SetSwitchName(int id, string name)

Parameters

Type	Name	Description
System.Int32	id
System.String	name

| Improve this Doc View Source

SetSwitchNameAsync(Int32, String)

Declaration

public Task SetSwitchNameAsync(int id, string name)

Parameters

Type	Name	Description
System.Int32	id
System.String	name

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

SetSwitchValue(Int32, Double)

Declaration

public void SetSwitchValue(int id, double value)

Parameters

Type	Name	Description
System.Int32	id
System.Double	value

| Improve this Doc View Source

SetSwitchValueAsync(Int32, Double)

Declaration

public Task SetSwitchValueAsync(int id, double value)

Parameters

Type	Name	Description
System.Int32	id
System.Double	value

Returns

Type	Description
System.Threading.Tasks.Task

Implements

ISwitch

IDevice

ISwitchAsync

IDeviceAsync