IoSource Class Reference

Class registration.


                    
                    
                    objectType

Undocumented

Declaration

Swift

override open class var objectType: String { get }

Attributes.

valueType
The semantic, application-specific data type of values to be represented by the IO source, such as Temperature, Notification, Task, etc. In order to be associated with an IO actor their value types must match.

The property value must be a non-empty string. You should choose canonical names for value types to avoid naming collisions. For example, by following the naming convention for Java packages, such as com.mydomain.myapp.Temperature.

Note that this value type is different from the underlying data format used by the IO source to publish IO data values. For example, an IO source for a temperature sensor could emit values as numbers or as a Value1D object with specific properties.
Declaration
Swift

public var valueType: String
updateStrategy
The backpressure strategy for publishing IO values (optional).

If not specified, the value defaults to IoSourceBackpressureStrategy.Default.
Declaration
Swift

public var updateStrategy: IoSourceBackpressureStrategy?

Initializers.


                    
                    
                    init(valueType:updateStrategy:useRawIoValues:updateRate:externalRoute:name:objectType:objectId:)

Default initializer for an IoSource object.

Declaration

Swift

public init(valueType: String,

     updateStrategy: IoSourceBackpressureStrategy? = nil,

     useRawIoValues: Bool? = false,

     updateRate: Int? = nil,

     externalRoute: String? = nil,

     name: String = "IoSourceObject",

     objectType: String = IoSource.objectType,

     objectId: CoatyUUID = .init())

Codable methods.


                    
                    
                    init(from:)

Undocumented

Declaration

Swift

public required init(from decoder: Decoder) throws


                    
                    
                    encode(to:)

Undocumented

Declaration

Swift

open override func encode(to encoder: Encoder) throws