Class ScriptProbe

The Script Probe allows Sensus to deliver custom surveys to the user in response to either a schedule or the data coming off other probes. For example, one could configure a survey to display at particular times or randomly within particular time blocks. One could also configure a survey to display when a Datum from another probe meets particular criteria.

Inheritance

System.Object

Probe

ScriptProbe

Implements

System.ComponentModel.INotifyPropertyChanged

IProbe

Inherited Members

Probe.GetAll()

Probe.add_MostRecentDatumChanged(Probe.MostRecentDatumChangedDelegateAsync)

Probe.remove_MostRecentDatumChanged(Probe.MostRecentDatumChangedDelegateAsync)

Probe.StartAsync()

Probe.StoreDatumAsync(Datum, Nullable<CancellationToken>)

Probe.ProcessDataAsync(CancellationToken)

Probe.GetParticipation()

Probe.StopAsync()

Probe.RestartAsync()

Probe.GetChart()

Probe.Enabled

Probe.OriginallyEnabled

Probe.State

Probe.MostRecentStoreTimestamp

Probe.Protocol

Probe.StoreData

Probe.AllowDisableOnStartUp

Probe.StartStopTimes

Probe.SuccessfulHealthTestTimes

Probe.MaxChartDataCount

Probe.Caption

Probe.SubCaption

Probe.MostRecentDatumChanged

Probe.PropertyChanged

Namespace: Sensus.Probes.User.Scripts

Assembly: SensusAndroid.dll

Syntax

public class ScriptProbe : Probe, INotifyPropertyChanged, IProbe

Constructors

ScriptProbe()

Declaration

public ScriptProbe()

Properties

Agent

Gets or sets the agent that controls survey delivery. See here for more information.

Declaration

public IScriptProbeAgent Agent { get; set; }

Property Value

Type	Description
IScriptProbeAgent	The agent.

AgentAssemblyBytes

Bytes of the assembly in which the Agent is contained.

Declaration

public byte[] AgentAssemblyBytes { get; set; }

Property Value

Type	Description
System.Byte[]	The agent assembly bytes.

AgentId

Id of the Agent to use.

Declaration

public string AgentId { get; set; }

Property Value

Type	Description
System.String	The agent identifier.

AgentPolicy

Gets or sets the agent policy.

Declaration

public JObject AgentPolicy { get; set; }

Property Value

Type	Description
Newtonsoft.Json.Linq.JObject	The agent policy JSON.

CollectionDescription

Declaration

public override string CollectionDescription { get; }

Property Value

Type	Description
System.String

Overrides

Probe.CollectionDescription

DataRateSampleSize

Declaration

protected override long DataRateSampleSize { get; }

Property Value

Type	Description
System.Int64

Overrides

Probe.DataRateSampleSize

DatumType

Declaration

public override sealed Type DatumType { get; }

Property Value

Type	Description
System.Type

Overrides

Probe.DatumType

DisplayName

Declaration

public override sealed string DisplayName { get; }

Property Value

Type	Description
System.String

Overrides

Probe.DisplayName

MaxDataStoresPerSecond

Declaration

public override Nullable<double> MaxDataStoresPerSecond { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

Overrides

Probe.MaxDataStoresPerSecond

RawParticipation

Declaration

protected override double RawParticipation { get; }

Property Value

Type	Description
System.Double

Overrides

Probe.RawParticipation

ScriptRunners

Declaration

public ObservableCollection<ScriptRunner> ScriptRunners { get; }

Property Value

Type	Description
System.Collections.ObjectModel.ObservableCollection<ScriptRunner>

Methods

GetAgent(Byte[], String)

Declaration

public static IScriptProbeAgent GetAgent(byte[] assemblyBytes, string agentId)

Parameters

Type	Name	Description
System.Byte[]	assemblyBytes
System.String	agentId

Returns

Type	Description
IScriptProbeAgent

GetAgents(Byte[])

Declaration

public static List<IScriptProbeAgent> GetAgents(byte[] assemblyBytes)

Parameters

Type	Name	Description
System.Byte[]	assemblyBytes

Returns

Type	Description
System.Collections.Generic.List<IScriptProbeAgent>

GetChartDataPointFromDatum(Datum)

Declaration

protected override ChartDataPoint GetChartDataPointFromDatum(Datum datum)

Parameters

Type	Name	Description
Datum	datum

Returns

Type	Description
Syncfusion.SfChart.XForms.ChartDataPoint

Overrides

Probe.GetChartDataPointFromDatum(Datum)

GetChartPrimaryAxis()

Declaration

protected override ChartAxis GetChartPrimaryAxis()

Returns

Type	Description
Syncfusion.SfChart.XForms.ChartAxis

Overrides

Probe.GetChartPrimaryAxis()

GetChartSecondaryAxis()

Declaration

protected override RangeAxisBase GetChartSecondaryAxis()

Returns

Type	Description
Syncfusion.SfChart.XForms.RangeAxisBase

Overrides

Probe.GetChartSecondaryAxis()

GetChartSeries()

Declaration

protected override ChartSeries GetChartSeries()

Returns

Type	Description
Syncfusion.SfChart.XForms.ChartSeries

Overrides

Probe.GetChartSeries()

InitializeAsync()

Declaration

protected override Task InitializeAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Probe.InitializeAsync()

ProtectedStartAsync()

Declaration

protected override Task ProtectedStartAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Probe.ProtectedStartAsync()

ProtectedStopAsync()

Declaration

protected override Task ProtectedStopAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Probe.ProtectedStopAsync()

ResetAsync()

Declaration

public override Task ResetAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Probe.ResetAsync()

TestHealthAsync(List<AnalyticsTrackedEvent>)

Declaration

public override Task<HealthTestResult> TestHealthAsync(List<AnalyticsTrackedEvent> events)

Parameters

Type	Name	Description
System.Collections.Generic.List<AnalyticsTrackedEvent>	events

Returns

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

Overrides

Probe.TestHealthAsync(List<AnalyticsTrackedEvent>)

Implements

System.ComponentModel.INotifyPropertyChanged

IProbe