Class SoftwareEvent

Namespace

AllenNeuralDynamics.AindBehaviorServices.DataTypes

Assembly

AllenNeuralDynamics.AindBehaviorServices.dll

A software event is a generic event that can be used to track any event that occurs in the software.

[Combinator]
[WorkflowElementCategory(ElementCategory.Source)]
public class SoftwareEvent

Inheritance

object

SoftwareEvent

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

SoftwareEvent()

public SoftwareEvent()

SoftwareEvent(SoftwareEvent)

protected SoftwareEvent(SoftwareEvent other)

Parameters

other SoftwareEvent

Properties

Data

The data of the event

[JsonProperty("data")]
public object Data { get; set; }

Property Value

object

DataType

The data type of the event

[JsonProperty("dataType")]
public DataType DataType { get; set; }

Property Value

DataType

DataTypeHint

The data type hint of the event

[JsonProperty("data_type_hint")]
public string DataTypeHint { get; set; }

Property Value

string

FrameIndex

The frame index of the event

[JsonProperty("frame_index")]
public int? FrameIndex { get; set; }

Property Value

int?

FrameTimestamp

The timestamp of the frame

[JsonProperty("frame_timestamp")]
public double? FrameTimestamp { get; set; }

Property Value

double?

Name

The name of the event

[JsonProperty("name", Required = Required.Always)]
public string Name { get; set; }

Property Value

string

Timestamp

The timestamp of the event

[JsonProperty("timestamp")]
public double? Timestamp { get; set; }

Property Value

double?

TimestampSource

The source of the timestamp

[JsonProperty("timestamp_source")]
public TimestampSource TimestampSource { get; set; }

Property Value

TimestampSource

Methods

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder stringBuilder)

Parameters

stringBuilder StringBuilder

Returns

bool

Process()

public IObservable<SoftwareEvent> Process()

Returns

IObservable<SoftwareEvent>

Process<TSource>(IObservable<TSource>)

public IObservable<SoftwareEvent> Process<TSource>(IObservable<TSource> source)

Parameters

source IObservable<TSource>

Returns

IObservable<SoftwareEvent>

Type Parameters

TSource

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.