Class StimStop

Namespace

Harp.OutputExpander

Assembly

Harp.OutputExpander.dll

Represents a register that stops the target Stim protocol.

public class StimStop

Inheritance

object

StimStop

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Fields

Address

Represents the address of the StimStop register. This field is constant.

public const int Address = 75

Field Value

int

RegisterLength

Represents the length of the StimStop register. This field is constant.

public const int RegisterLength = 1

Field Value

int

RegisterType

Represents the payload type of the StimStop register. This field is constant.

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, StimChannels)

Returns a Harp message for the StimStop register.

public static HarpMessage FromPayload(MessageType messageType, StimChannels value)

Parameters

messageType MessageType

The type of the Harp message.

value StimChannels

The value to be stored in the message payload.

Returns

HarpMessage

A HarpMessage object for the StimStop register with the specified message type and payload.

FromPayload(double, MessageType, StimChannels)

Returns a timestamped Harp message for the StimStop register.

public static HarpMessage FromPayload(double timestamp, MessageType messageType, StimChannels value)

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value StimChannels

The value to be stored in the message payload.

Returns

HarpMessage

A HarpMessage object for the StimStop register with the specified message type, timestamp, and payload.

GetPayload(HarpMessage)

Returns the payload data for StimStop register messages.

public static StimChannels GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

StimChannels

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for StimStop register messages.

public static Timestamped<StimChannels> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<StimChannels>

A value representing the timestamped message payload.