# Nsdk_Vps_Frame Source: https://www.nianticspatial.com/docs/api/swift/NSDK.struct-Nsdk_Vps_Frame/ Nsdk_Vps_Frame --- ## Declaration nonisolated struct Nsdk_Vps_Frame --- ## Constructors ### Constructor init() #### Summary Creates a new message with all of its fields initialized to their default values. --- ### Overload 1 init(jsonString: String, options: JSONDecodingOptions = JSONDecodingOptions()) throws #### Summary Creates a new message by decoding the given string containing a serialized message in JSON format. #### Throws SwiftProtobufError or JSONDecodingError if decoding fails. --- ### Overload 2 init(jsonUTF8Bytes: Bytes, options: JSONDecodingOptions = JSONDecodingOptions()) throws where Bytes : SwiftProtobufContiguousBytes #### Summary Creates a new message by decoding the given SwiftProtobufContiguousBytes containing a serialized message in JSON format, interpreting the data as UTF-8 encoded text. #### Throws SwiftProtobufError or JSONDecodingError if decoding fails. --- ### Overload 3 init(jsonUTF8Data: Data, options: JSONDecodingOptions = JSONDecodingOptions()) throws #### Summary Creates a new message by decoding the given Data containing a serialized message in JSON format, interpreting the data as UTF-8 encoded text. #### Throws SwiftProtobufError or JSONDecodingError if decoding fails. --- ### Overload 4 init(textFormatString: String, extensions: (any ExtensionMap)? = nil) throws #### Summary Creates a new message by decoding the given string containing a serialized message in Protocol Buffer text format. #### Throws SwiftProtobufError on failure. --- ### Overload 5 init(jsonString: String, extensions: (any ExtensionMap)? = nil, options: JSONDecodingOptions = JSONDecodingOptions()) throws #### Summary Creates a new message by decoding the given string containing a serialized message in JSON format. #### Throws SwiftProtobufError or JSONDecodingError if decoding fails. --- ### Overload 6 init(jsonUTF8Bytes: Bytes, extensions: (any ExtensionMap)? = nil, options: JSONDecodingOptions = JSONDecodingOptions()) throws where Bytes : SwiftProtobufContiguousBytes #### Summary Creates a new message by decoding the given SwiftProtobufContiguousBytes containing a serialized message in JSON format, interpreting the data as UTF-8 encoded text. #### Throws SwiftProtobufError or JSONDecodingError if decoding fails. --- ### Overload 7 init(jsonUTF8Data: Data, extensions: (any ExtensionMap)? = nil, options: JSONDecodingOptions = JSONDecodingOptions()) throws #### Summary Creates a new message by decoding the given Data containing a serialized message in JSON format, interpreting the data as UTF-8 encoded text. #### Throws SwiftProtobufError or JSONDecodingError if decoding fails. --- ### Overload 8 init(textFormatString: String, options: TextFormatDecodingOptions = TextFormatDecodingOptions(), extensions: (any ExtensionMap)? = nil) throws #### Summary Creates a new message by decoding the given string containing a serialized message in Protocol Buffer text format. #### Throws TextFormatDecodingError on failure. --- ### Overload 9 init(unpackingAny: Google_Protobuf_Any, extensions: (any ExtensionMap)? = nil, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws #### Summary Initialize this message from the provided google.protobuf.Any well-known type. This corresponds to the unpack method in the Google C++ API. If the Any object was decoded from Protobuf Binary or JSON format, then the enclosed field data was stored and is not fully decoded until you unpack the Any object into a message. As such, this method will typically need to perform a full deserialization of the enclosed data and can fail for any reason that deserialization can fail. See Google_Protobuf_Any.unpackTo() for more discussion. #### Throws an instance of AnyUnpackError, JSONDecodingError, or BinaryDecodingError on failure. --- ### Overload 10 init(contiguousBytes bytes: Bytes, extensions: (any ExtensionMap)? = nil, partial: Bool = false, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws where Bytes : ContiguousBytes #### Summary Creates a new message by decoding the given Foundation/ContiguousBytes value containing a serialized message in Protocol Buffer binary format. #### Throws SwiftProtobufError if decoding fails. --- ### Overload 11 init(serializedBytes bytes: Bytes, extensions: (any ExtensionMap)? = nil, partial: Bool = false, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws where Bytes : SwiftProtobufContiguousBytes #### Summary Creates a new message by decoding the given SwiftProtobufContiguousBytes value containing a serialized message in Protocol Buffer binary format. #### Throws BinaryDecodingError if decoding fails. --- ### Overload 12 init(serializedBytes bytes: RawSpan, extensions: (any ExtensionMap)? = nil, partial: Bool = false, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws #### Summary Creates a new message by decoding the bytes provided by a RawSpan containing a serialized message in Protocol Buffer binary format. #### Throws BinaryDecodingError if decoding fails. --- ### Overload 13 init(serializedBytes bytes: Bytes, extensions: (any ExtensionMap)? = nil, partial: Bool = false, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws where Bytes : ContiguousBytes #### Summary Creates a new message by decoding the given Foundation/ContiguousBytes value containing a serialized message in Protocol Buffer binary format. #### Throws SwiftProtobufError if decoding fails. --- ### Overload 14 init(serializedData data: Data, extensions: (any ExtensionMap)? = nil, partial: Bool = false, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws #### Summary Creates a new message by decoding the given Data value containing a serialized message in Protocol Buffer binary format. #### Throws BinaryDecodingError if decoding fails. --- ## Properties | Name | Type | Summary | | --- | --- | --- | | var debugDescription | String | A description generated by recursively visiting all fields in the message,including messages. | | var frameID | UInt64 | - | | var frameTimestampMs | UInt64 | - | | var gpsAltitude | Float | - | | var gpsHeading | Float | - | | var gpsHeadingAccuracy | Float | - | | var gpsHorizontalAccuracy | Float | - | | var gpsLatitude | Float | - | | var gpsLongitude | Float | - | | var gpsVerticalAccuracy | Float | - | | var height | Float | - | | var intrinsics | [Float] | - | | var isInitialized | Bool | Generated proto2 messages that contain required fields, nested messagesthat contain required fields, and/or extensions will provide their ownimplementation of this property that tests that all required fields areset. Users of the generated code SHOULD NOT override this property. | | var orientation | Nsdk_Vps_Orientation | - | | var pose | [Float] | - | | static let protoMessageName | String | The fully-scoped name of the message from the original .proto file,including any relevant package name. | | var timestampMs | UInt64 | - | | var trackingState | Nsdk_Vps_TrackingState | - | | var unknownFields | UnknownStorage | Some formats include enough information to transport fields that werenot known at generation time. When encountered, they are stored here. | | var width | Float | - | --- ## Methods | Name | Type | Summary | | --- | --- | --- | | static array | [Self] | Creates a new array of messages by decoding the given string containing aserialized array of messages in JSON format. | | mutating decodeMessage(decoder | void | Decode all of the fields from the given decoder.This is a simple loop that repeatedly gets the next field numberfrom `decoder.nextFieldNumber()` and then uses the number returnedand the type information from the original .proto file to decidewhat type of data should be decoded for that field. The correspondingmethod on the decoder is then called to get the field value.This is the core method used by the deserialization machinery. It is`public` to enable users to implement their own encoding formats byconforming to `Decoder`; it should not be called otherwise.Note that this is not specific to binary encodng; formats that usetextual identifiers translate those to field numbers and also gothrough this to decode messages. | | hash | void | A hash based on the message's full contents. | | isEqualTo | Bool | Helper to compare `Message`s when not having a specific type to usenormal `Equatable`. `Equatable` is provided with specific generatedtypes. | | static isPathValid | Bool | Checks whether the given path is valid for Message type. | | jsonString | String | Returns a string containing the JSON serialization of the message.Unlike binary encoding, presence of required fields is not enforced whenserializing to JSON. | | jsonUTF8Bytes(options | Bytes | Returns a `SwiftProtobufContiguousBytes` containing the UTF-8 JSON serialization of the message.Unlike binary encoding, presence of required fields is not enforced whenserializing to JSON. | | jsonUTF8Data | Data | Returns a Data containing the UTF-8 JSON serialization of the message.Unlike binary encoding, presence of required fields is not enforced whenserializing to JSON. | | mutating merge(serializedBytes bytes | void | Updates the message by decoding the given `SwiftProtobufContiguousBytes` valuecontaining a serialized message in Protocol Buffer binary format into thereceiver. | | serializedBytes(partial | Bytes | Returns a `SwiftProtobufContiguousBytes` instance containing the Protocol Buffer binaryformat serialization of the message. | | serializedData | Data | Returns a `Data` instance containing the Protocol Buffer binaryformat serialization of the message. | | textFormatString | String | Returns a string containing the Protocol Buffer text format serializationof the message.Unlike binary encoding, presence of required fields is not enforced whenserializing to text format. | | traverse(visitor | void | Traverses the fields of the message, calling the appropriate methodsof the passed `Visitor` object.This is used internally by:* Protobuf binary serialization* JSON serialization (with some twists to account for specialty JSON)* Protobuf Text serialization* `Hashable` computationConceptually, serializers create visitor objects that arethen passed recursively to every message and field via generated`traverse` methods. The details get a little involved due tothe need to allow particular messages to override particularbehaviors for specific encodings, but the general idea is quite simple. | | @discardableResult mutating trim | Bool | Removes from 'message' any field that is not represented in the givenFieldMask. If the FieldMask is empty, does nothing. | | static with | Self | Creates an instance of the message type on which this method is called,executes the given block passing the message in as its sole `inout`argument, and then returns the message.This method acts essentially as a "builder" in that the initialization ofthe message is captured within the block, allowing the returned value tobe set in an immutable variable. For example, let msg = MyMessage.with { $0.myField = "foo" } msg.myOtherField = 5 // error: msg is immutable | --- ## Operators | Name | Type | Summary | | --- | --- | --- | | static func != | Bool | Returns a Boolean value indicating whether two values are not equal.Inequality is the inverse of equality. For any values `a` and `b`, `a != b`implies that `a == b` is `false`.This is the default implementation of the not-equal-to operator (`!=`)for any type that conforms to `Equatable`. | | static func == | Bool | Returns a Boolean value indicating whether two values are equal.Equality is the inverse of inequality. For any values `a` and `b`,`a == b` implies that `a != b` is `false`. | | static func == | Bool | Returns a Boolean value indicating whether two values are equal.Equality is the inverse of inequality. For any values `a` and `b`,`a == b` implies that `a != b` is `false`. | --- ## Relationships conforms to: Swift.Sendable conforms to: Swift.SendableMetatype conforms to: SwiftProtobuf.Message conforms to: Swift.CustomDebugStringConvertible conforms to: Swift.Hashable conforms to: Swift.Equatable conforms to: Swift.Copyable