Class CustomEventCapture

An event that acts as a key value pair with an associated timestamp.

Inheritance
System.Object
Capture<CustomEvent>
CustomEventCapture
Implements
Inherited Members
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: Recolude.Core
Assembly: Recolude.Core.dll
Syntax
[Serializable]
public class CustomEventCapture : Capture<CustomEvent>, ICapture

Constructors

CustomEventCapture(Single, CustomEvent)

Declaration
public CustomEventCapture(float time, CustomEvent eventData)
Parameters
Type Name Description
System.Single time
CustomEvent eventData

CustomEventCapture(Single, String, Dictionary<String, String>)

Create a new custom event capture.

Declaration
public CustomEventCapture(float time, string name, Dictionary<string, string> contentData)
Parameters
Type Name Description
System.Single time

The time the event occured in the recording.
System.String name

The name of the event.
System.Collections.Generic.Dictionary<System.String, System.String> contentData

CustomEventCapture(Single, String, String)

Create a new custom event capture. Initializes a dictionary with a single entry that is "value" => contents

Declaration
public CustomEventCapture(float time, string name, string contents)
Parameters
Type Name Description
System.Single time

The time the event occured in the recording.
System.String name

The name of the event.
System.String contents

The details of the event that occured.

Properties

Contents

The details of the event

Declaration
public Metadata Contents { get; }
Property Value
Type Description
Metadata

Name

The name of the event

Declaration
public string Name { get; }
Property Value
Type Description
System.String

Methods

SetTime(Single)

Creates a new CustomEventCapture with the same name and details but with a modified time, leaving the original event unchanged.

Declaration
public override ICapture SetTime(float newTime)
Parameters
Type Name Description
System.Single newTime

The new time the event occured in the recording.
Returns
Type Description
ICapture

A entirely new capture that occured with the time passed in.
Overrides
Recolude.Core.Capture<Recolude.Core.CustomEvent>.SetTime(System.Single)

ToCSV()

Builds a string that represents a single row in a csv file that contains this object's data.

Declaration
public override string ToCSV()
Returns
Type Description
System.String

A row of csv data as a string.
Overrides
Recolude.Core.Capture<Recolude.Core.CustomEvent>.ToCSV()

ToJSON()

Builds a JSON string that represents the CustomEventCapture object.

Declaration
public override string ToJSON()
Returns
Type Description
System.String

A JSON string.
Overrides
Recolude.Core.Capture<Recolude.Core.CustomEvent>.ToJSON()

Implements

Extension Methods