MIP_SDK
- v2.0.0-162-g1b89fe7
+ v2.0.0-163-g188dd2d
MicroStrain Communications Library for embedded systems
| addField(const FieldType &field, uint8_t fieldDescriptor=INVALID_FIELD_DESCRIPTOR) | mip::PacketView | inline |
| begin() const | mip::PacketView | inline |
| copyPacketTo(uint8_t *buffer, size_t maxLength) | mip::PacketView | inline |
| copyPacketTo(microstrain::Span< uint8_t > buffer) | mip::PacketView | inline |
| createField(uint8_t fieldDescriptor, uint8_t length) | mip::PacketView | inline |
| createField(uint8_t fieldDescriptor) | mip::PacketView | inline |
| createFromField(uint8_t *buffer, size_t bufferSize, const FieldType &field, uint8_t fieldDescriptor=INVALID_FIELD_DESCRIPTOR) | mip::PacketView | inlinestatic |
| PacketView(microstrain::Span< uint8_t > buffer, uint8_t descriptorSet) | mip::PacketView | inline |
| PacketView(microstrain::Span< const uint8_t > buffer) | mip::PacketView | inline |
| PAYLOAD_LENGTH_MAX | mip::PacketView | static |
| payloadSpan() const | mip::PacketView | inline |
| totalSpan() const | mip::PacketView | inline |
diff --git a/latest/classmip_1_1PacketView.html b/latest/classmip_1_1PacketView.html index 472f9cd8fe..35c8996aa5 100644 --- a/latest/classmip_1_1PacketView.html +++ b/latest/classmip_1_1PacketView.html @@ -23,7 +23,7 @@
MIP_SDK
- v2.0.0-162-g1b89fe7
+ v2.0.0-163-g188dd2d
MicroStrain Communications Library for embedded systems
Static Public Member Functions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+
|
+ +inline | +
+
+
+Copies this packet to an external buffer (span version).
+This packet must be sane (see isSane()). Undefined behavior otherwise due to lookup of totalLength().
+- Parameters
-
+
+
+buffer Data is copied to this buffer.
+
- Returns
- true if successful. +
- +false if maxLength is too short.
◆ copyPacketTo() [2/2]
+ +
+
@@ -719,6 +818,60 @@
+
+
+
+
|
+ +inline | +
+
+
Copies this packet to an external buffer.
+This packet must be sane (see isSane()). Undefined behavior otherwise due to lookup of totalLength().
+- Parameters
-
+
+
+buffer Data is copied into this location. maxLength Maximum number of bytes to copy.
+
- Returns
- true if successful. +
- +false if maxLength is too short.
+
+
+
+◆ payloadSpan()
+
+
+
+
+
+
+
+
+ microstrain::Span<const uint8_t> mip::PacketView::payloadSpan
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
+Gets a span over just the payload.
+
+
+
+
+◆ totalSpan()
+
+
+
+
+
+
+
+
+ microstrain::Span<const uint8_t> mip::PacketView::totalSpan
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
+Gets a span over the whole packet.
+
Member Data Documentation
diff --git a/latest/classmip_1_1PacketView_1_1AllocatedField-members.html b/latest/classmip_1_1PacketView_1_1AllocatedField-members.html
index 7295b15ed6..14c1c52c04 100644
--- a/latest/classmip_1_1PacketView_1_1AllocatedField-members.html
+++ b/latest/classmip_1_1PacketView_1_1AllocatedField-members.html
@@ -23,7 +23,7 @@
MIP_SDK
- v2.0.0-162-g1b89fe7
+ v2.0.0-163-g188dd2d
MicroStrain Communications Library for embedded systems
@@ -76,24 +76,25 @@
This is the complete list of members for mip::PacketView::AllocatedField, including all inherited members.
diff --git a/latest/classmip_1_1PacketView_1_1AllocatedField.html b/latest/classmip_1_1PacketView_1_1AllocatedField.html
index ec83d2d2c0..3ed8af4b63 100644
--- a/latest/classmip_1_1PacketView_1_1AllocatedField.html
+++ b/latest/classmip_1_1PacketView_1_1AllocatedField.html
@@ -23,7 +23,7 @@
MIP_SDK
- v2.0.0-162-g1b89fe7
+ v2.0.0-163-g188dd2d
MicroStrain Communications Library for embedded systems
@@ -96,6 +96,8 @@
bool commit () void cancel () 
Public Member Functions inherited from microstrain::Serializer< E >template<typename... Ts> bool insert (const Ts &... values) Member Function Documentation
+
+◆ cancel()
+
+
+
+
+
+
+
+
+ void mip::PacketView::AllocatedField::cancel
+ (
+ )
+
+
+
+
+inline
+
+
+
+
+
+
◆ commit()
diff --git a/latest/classmip_1_1PacketView_1_1FieldIterator-members.html b/latest/classmip_1_1PacketView_1_1FieldIterator-members.html
index 853f40f24b..8ba1e4f735 100644
--- a/latest/classmip_1_1PacketView_1_1FieldIterator-members.html
+++ b/latest/classmip_1_1PacketView_1_1FieldIterator-members.html
@@ -23,7 +23,7 @@
MIP_SDK
- v2.0.0-162-g1b89fe7
+ v2.0.0-163-g188dd2d
MicroStrain Communications Library for embedded systems
diff --git a/latest/classmip_1_1PacketView_1_1FieldIterator.html b/latest/classmip_1_1PacketView_1_1FieldIterator.html
index 6fc5c090ca..1e693842bd 100644
--- a/latest/classmip_1_1PacketView_1_1FieldIterator.html
+++ b/latest/classmip_1_1PacketView_1_1FieldIterator.html
@@ -23,7 +23,7 @@
MIP_SDK
- v2.0.0-162-g1b89fe7
+ v2.0.0-163-g188dd2d
MicroStrain Communications Library for embedded systems
diff --git a/latest/classmip_1_1Parser-members.html b/latest/classmip_1_1Parser-members.html
index 8b41812b41..df015ad11e 100644
--- a/latest/classmip_1_1Parser-members.html
+++ b/latest/classmip_1_1Parser-members.html
@@ -23,7 +23,7 @@
MIP_SDK
- v2.0.0-162-g1b89fe7
+ v2.0.0-163-g188dd2d
MicroStrain Communications Library for embedded systems
diff --git a/latest/classmip_1_1Parser.html b/latest/classmip_1_1Parser.html
index eec4d8dcf0..ec262ff164 100644
--- a/latest/classmip_1_1Parser.html
+++ b/latest/classmip_1_1Parser.html
@@ -23,7 +23,7 @@
MIP_SDK
- v2.0.0-162-g1b89fe7
+ v2.0.0-163-g188dd2d
MicroStrain Communications Library for embedded systems
diff --git a/latest/classmip_1_1SizedPacketBuf-members.html b/latest/classmip_1_1SizedPacketBuf-members.html
index c1b874782b..7639044e16 100644
--- a/latest/classmip_1_1SizedPacketBuf-members.html
+++ b/latest/classmip_1_1SizedPacketBuf-members.html
@@ -23,7 +23,7 @@
MIP_SDK
- v2.0.0-162-g1b89fe7
+ v2.0.0-163-g188dd2d
MicroStrain Communications Library for embedded systems
@@ -78,9 +78,11 @@
addField(const FieldType &field, uint8_t fieldDescriptor=INVALID_FIELD_DESCRIPTOR) mip::PacketView inline begin() const mip::PacketView inline buffer() mip::SizedPacketBuf< BufferSize > inline copyFrom(const uint8_t *data, size_t length) mip::SizedPacketBuf< BufferSize > inline copyFrom(const PacketView &packet) mip::SizedPacketBuf< BufferSize > inline copyTo(uint8_t *buffer, size_t maxLength) mip::SizedPacketBuf< BufferSize > inline bufferSpan() mip::SizedPacketBuf< BufferSize > inline copyFrom(const uint8_t *data, size_t length) mip::SizedPacketBuf< BufferSize > inline copyFrom(const PacketView &packet) mip::SizedPacketBuf< BufferSize > inline copyPacketTo(uint8_t *buffer, size_t maxLength) mip::PacketView inline copyPacketTo(microstrain::Span< uint8_t > buffer) mip::PacketView inline createField(uint8_t fieldDescriptor, uint8_t length) mip::PacketView inline createField(uint8_t fieldDescriptor) mip::PacketView inline createFromField(uint8_t *buffer, size_t bufferSize, const FieldType &field, uint8_t fieldDescriptor=INVALID_FIELD_DESCRIPTOR) mip::PacketView inlinestatic PacketView(microstrain::Span< uint8_t > buffer, uint8_t descriptorSet) mip::PacketView inline PacketView(microstrain::Span< const uint8_t > buffer) mip::PacketView inline PAYLOAD_LENGTH_MAX mip::PacketView static ref() mip::SizedPacketBuf< BufferSize > inline ref() const mip::SizedPacketBuf< BufferSize > inline SizedPacketBuf(uint8_t descriptorSet=INVALID_DESCRIPTOR_SET) mip::SizedPacketBuf< BufferSize > inline SizedPacketBuf(const uint8_t *data, size_t length) mip::SizedPacketBuf< BufferSize > inlineexplicit SizedPacketBuf(const PacketView &packet) mip::SizedPacketBuf< BufferSize > inlineexplicit payloadSpan() const mip::PacketView inline ref() mip::SizedPacketBuf< BufferSize > inline ref() const mip::SizedPacketBuf< BufferSize > inline SizedPacketBuf(uint8_t descriptorSet=INVALID_DESCRIPTOR_SET) mip::SizedPacketBuf< BufferSize > inline SizedPacketBuf(const uint8_t *data, size_t length) mip::SizedPacketBuf< BufferSize > inlineexplicit SizedPacketBuf(const PacketView &packet) mip::SizedPacketBuf< BufferSize > inlineexplicit SizedPacketBuf(microstrain::Span< const uint8_t > data) mip::SizedPacketBuf< BufferSize > inlineexplicit SizedPacketBuf(const SizedPacketBuf &other) mip::SizedPacketBuf< BufferSize > inline SizedPacketBuf(const SizedPacketBuf< OtherSize > &other) mip::SizedPacketBuf< BufferSize > inlineexplicit SizedPacketBuf(const FieldType &field, uint8_t fieldDescriptor=INVALID_FIELD_DESCRIPTOR, typename std::enable_if< std::is_class< FieldType >::value, void >::type *=nullptr) mip::SizedPacketBuf< BufferSize > inline totalSpan() const mip::PacketView inline
+
+
+
+
|
+ +inline | +
+
+
+Gets a span over just the payload.
+ +
+
+
+
+
|
+ +inline | +
+
+
Gets a span over the whole packet.
+MIP_SDK
- v2.0.0-162-g1b89fe7
+ v2.0.0-163-g188dd2d
MicroStrain Communications Library for embedded systems
This is the complete list of members for mip::PacketView::AllocatedField, including all inherited members.
diff --git a/latest/classmip_1_1PacketView_1_1AllocatedField.html b/latest/classmip_1_1PacketView_1_1AllocatedField.html index ec83d2d2c0..3ed8af4b63 100644 --- a/latest/classmip_1_1PacketView_1_1AllocatedField.html +++ b/latest/classmip_1_1PacketView_1_1AllocatedField.html @@ -23,7 +23,7 @@
MIP_SDK
- v2.0.0-162-g1b89fe7
+ v2.0.0-163-g188dd2d
MicroStrain Communications Library for embedded systems
Public Member Functions inherited from microstrain::Serializer< E >Member Function Documentation
+ +◆ cancel()
+ +
+
+
+
+
+
|
+ +inline | +
+
+
+◆ commit()
diff --git a/latest/classmip_1_1PacketView_1_1FieldIterator-members.html b/latest/classmip_1_1PacketView_1_1FieldIterator-members.html index 853f40f24b..8ba1e4f735 100644 --- a/latest/classmip_1_1PacketView_1_1FieldIterator-members.html +++ b/latest/classmip_1_1PacketView_1_1FieldIterator-members.html @@ -23,7 +23,7 @@MIP_SDK
- v2.0.0-162-g1b89fe7
+ v2.0.0-163-g188dd2d
MicroStrain Communications Library for embedded systems
MIP_SDK
- v2.0.0-162-g1b89fe7
+ v2.0.0-163-g188dd2d
MicroStrain Communications Library for embedded systems
MIP_SDK
- v2.0.0-162-g1b89fe7
+ v2.0.0-163-g188dd2d
MicroStrain Communications Library for embedded systems
MIP_SDK
- v2.0.0-162-g1b89fe7
+ v2.0.0-163-g188dd2d
MicroStrain Communications Library for embedded systems
MIP_SDK
- v2.0.0-162-g1b89fe7
+ v2.0.0-163-g188dd2d
MicroStrain Communications Library for embedded systems
diff --git a/latest/classmip_1_1SizedPacketBuf.html b/latest/classmip_1_1SizedPacketBuf.html index 4268fac8e1..a02be59e2c 100644 --- a/latest/classmip_1_1SizedPacketBuf.html +++ b/latest/classmip_1_1SizedPacketBuf.html @@ -23,7 +23,7 @@
MIP_SDK
- v2.0.0-162-g1b89fe7
+ v2.0.0-163-g188dd2d
MicroStrain Communications Library for embedded systems
Public Member Functions inherited from mip::PacketViewAdditional Inherited Members | ||||||||
+
|
+ +inlineexplicit | +
+
+
Construct from a span.
+◆ SizedPacketBuf() [4/6]
+◆ SizedPacketBuf() [5/7]
@@ -323,7 +368,7 @@
-
-◆ SizedPacketBuf() [5/6]
+◆ SizedPacketBuf() [6/7]
@@ -355,7 +400,7 @@
-◆ SizedPacketBuf() [6/6]
+◆ SizedPacketBuf() [7/7]
@@ -445,8 +490,8 @@
-◆ copyFrom() [1/2]
+
+◆ bufferSpan()
@@ -457,10 +502,9 @@
- void mip::SizedPacketBuf< BufferSize >::copyFrom
+ microstrain::Span<uint8_t, BufferSize> mip::SizedPacketBuf< BufferSize >::bufferSpan
(
- const PacketView &
- packet )
+ )
@@ -471,18 +515,12 @@
-Copies an existing packet. The packet is assumed to be valid (undefined behavior otherwise).
-- Parameters
-
-
- packet A "sane" (isSane()) mip packet.
-
-
+Returns a Span covering the entire buffer.
-
-◆ copyFrom() [2/2]
+
+◆ copyFrom() [1/2]
@@ -495,19 +533,9 @@ void mip::SizedPacketBuf< BufferSize >::copyFrom
(
- const uint8_t *
- data,
-
-
- size_t
- length
-
-
+ const PacketView &
+ packet )
)
-
@@ -355,7 +400,7 @@
-
-◆ SizedPacketBuf() [6/6]
+◆ SizedPacketBuf() [7/7]
@@ -445,8 +490,8 @@
-◆ copyFrom() [1/2]
+
+◆ bufferSpan()
@@ -457,10 +502,9 @@
- void mip::SizedPacketBuf< BufferSize >::copyFrom
+ microstrain::Span<uint8_t, BufferSize> mip::SizedPacketBuf< BufferSize >::bufferSpan
(
- const PacketView &
- packet )
+ )
@@ -471,18 +515,12 @@
-Copies an existing packet. The packet is assumed to be valid (undefined behavior otherwise).
-- Parameters
-
-
- packet A "sane" (isSane()) mip packet.
-
-
+Returns a Span covering the entire buffer.
-
-◆ copyFrom() [2/2]
+
+◆ copyFrom() [1/2]
@@ -495,19 +533,9 @@ void mip::SizedPacketBuf< BufferSize >::copyFrom
(
- const uint8_t *
- data,
-
-
- size_t
- length
-
-
+ const PacketView &
+ packet )
)
-
@@ -445,8 +490,8 @@
-
-◆ copyFrom() [1/2]
+
+◆ bufferSpan()
@@ -457,10 +502,9 @@
- void mip::SizedPacketBuf< BufferSize >::copyFrom
+ microstrain::Span<uint8_t, BufferSize> mip::SizedPacketBuf< BufferSize >::bufferSpan
(
- const PacketView &
- packet )
+ )
@@ -471,18 +515,12 @@
-Copies an existing packet. The packet is assumed to be valid (undefined behavior otherwise).
-- Parameters
-
-
- packet A "sane" (isSane()) mip packet.
-
-
+Returns a Span covering the entire buffer.
-
-◆ copyFrom() [2/2]
+
+◆ copyFrom() [1/2]
@@ -495,19 +533,9 @@ void mip::SizedPacketBuf< BufferSize >::copyFrom
(
- const uint8_t *
- data,
-
-
- size_t
- length
-
-
+ const PacketView &
+ packet )
)
-
@@ -457,10 +502,9 @@
- void mip::SizedPacketBuf< BufferSize >::copyFrom
+ microstrain::Span<uint8_t, BufferSize> mip::SizedPacketBuf< BufferSize >::bufferSpan
(
- const PacketView &
- packet )
+ )
@@ -471,18 +515,12 @@
-Copies an existing packet. The packet is assumed to be valid (undefined behavior otherwise).
-- Parameters
-
-
- packet A "sane" (isSane()) mip packet.
-
-
+Returns a Span covering the entire buffer.
Copies an existing packet. The packet is assumed to be valid (undefined behavior otherwise).
-- Parameters
-
-
-
-packet A "sane" (isSane()) mip packet.
-
Returns a Span covering the entire buffer.
@@ -495,19 +533,9 @@ void mip::SizedPacketBuf< BufferSize >::copyFrom
void mip::SizedPacketBuf< BufferSize >::copyFrom
(
- const uint8_t *
- data,
-
-
- size_t
- length
-
-
+ const PacketView &
+ packet )
)
-
-Copies the data from the pointer to this buffer. The data is not inspected.
+Copies an existing packet. The packet is assumed to be valid (undefined behavior otherwise).
- Parameters
-
- data Pointer to the start of the packet. length Total length of the packet. packet A "sane" (isSane()) mip packet.
-
-◆ copyTo()
+
+◆ copyFrom() [2/2]
@@ -540,16 +567,16 @@
| data | Pointer to the start of the packet. |
| length | Total length of the packet. |
| packet | A "sane" (isSane()) mip packet. |
@@ -540,16 +567,16 @@