sdk-sensor-collection/com.combain.sdk_sensor_collection.pipeline

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.CLASS])

annotation class SLPipe(val pipeId: String, val resultClass: KClass<out SLPipeResult>)

Annotation provides unique identifier of the pipe and class reference to result (cannot easily be determined mid runtime). Should annotate all pipes running within SLPipeline.

SLPipeBase

abstract class SLPipeBase(analytics: SLAnalytics?, var enabled: Boolean = true)

Abstract base class describing a step in the slam data collection procedure. Can be subclassed to define custom steps to add into the process.

SLPipeContext

data class SLPipeContext(val androidContext: Context, val results: List<SLPipeResult>?, val modeManager: SLModeManager)

Data class detailing the current pipeline run.

SLPipeline

class SLPipeline(androidContext: Context, steps: List<SLPipelineStep>, config: SLPipelineConfig, analytics: SLAnalytics?, modeManager: SLModeManager)

Manages the creation and running of the pipeline.

SLPipelineConfig

interface SLPipelineConfig

SLPipelineConfigGeneral

class SLPipelineConfigGeneral(val resultsCallback: (List<SLPipeResult>) -> Unit = {}, val scanStateCallback: (Boolean) -> Unit = {}, val nextScanTimeCallback: (Long?) -> Unit = {}, val modeCallback: (SLMode) -> Unit = {}) : SLPipelineConfig

SLPipelineStep

data class SLPipelineStep(val name: String, val pipes: List<SLPipeBase>)

One step in the pipeline.

SLPipeResult

abstract class SLPipeResult(success: Boolean, resultId: String)

Base class for all types of results returned from a SLPipe implementation.

SLPipeSpec

sealed class SLPipeSpec

Different ways of providing specifications for pipes meant for the pipe line.