WsfL16::Messages::J13_4::Initial Class Reference
#include <Message13_4.hpp>
Inheritance diagram for WsfL16::Messages::J13_4::Initial:
Collaboration diagram for WsfL16::Messages::J13_4::Initial:
Public Types | |
| typedef SpareField< 4 > | FieldType1 |
| typedef TrackNumberField | FieldType2 |
| typedef IntegerField< 12 > | FieldType3 |
| typedef SpareField< 22 > | FieldType4 |
| Public Types inherited from WsfL16::Messages::Base | |
| enum | WordType { cINITIAL , cCONTINUATION , cEXTENSION , cUNDEFINED } |
Public Member Functions | |
| DEFINE_INITIAL (13, 4) | |
| DEFINE_MEMBERS4 (Spare, TrackNumberReference, SubsurfaceSpecificType, Spare2) | |
| DEFINE_CONTINUATIONS1 (1) | |
| DEFINE_EXTENSIONS0 () | |
| Public Member Functions inherited from WsfL16::Messages::InitialBase | |
| virtual InitialBase * | Clone () const =0 |
| ~InitialBase () override=default | |
| InitialBase (const InitialBase &aSrc) | |
| const InitialBase & | operator= (const InitialBase &aRhs)=delete |
| WordType | GetWordType () const override |
| Returns the base type of the word. | |
| size_t | GetMessageLength () const |
| Returns the number of extra words in the message. | |
| virtual void | GetLabel (int &aLabel, int &aSubLabel) const =0 |
| bool | IsLabelEqual (int aLabel, int aSublabel) const |
| int | GetLabel () const |
| int | GetSubLabel () const |
| Base * | GetSubWord (int index) const |
| Returns the sub-word with the given index number. | |
| ContinuationBase * | GetContinuation (int aIndex) |
| const ContinuationBase * | GetContinuation (int aIndex) const |
| size_t | GetContinuationCount () const |
| ContinuationBase * | FindContinuation (int aContinuation) const |
| size_t | GetExtensionCount () const |
| ExtensionBase * | GetExtension (int aIndex) const |
| ContinuationBase * | AddContinuationWord (int aWordNumber) |
| ExtensionBase * | AddExtensionWord (int aWordNumber) |
| void | InsertContinuationWord (std::unique_ptr< ContinuationBase >) |
| Inserts a new Continuation word into this word. | |
| void | InsertExtensionWord (std::unique_ptr< ExtensionBase >) |
| Inserts a new Extension word into this word. | |
| const Header & | GetHeader () const |
| Header & | GetHeader () |
| void | WriteMessage (MessageBitOutput &aMW, bool aWriteHeader=true) const |
| virtual std::unique_ptr< ContinuationBase > | CreateContinuationWord (int label)=0 |
| Adds a Continuation word with the given label to this message. | |
| virtual std::unique_ptr< ExtensionBase > | CreateExtensionWord (int aExtensionBaseNumber)=0 |
| Adds an Extension word with the given ExtensionBase number to this message. | |
| std::string | GetClassName () const override |
| Returns the human-readable class name for the Initial word. | |
| void | PrintMessage (ut::log::MessageStream &aStream) const |
| Public Member Functions inherited from WsfL16::Messages::Base | |
| Base (char *aData) | |
| Base () | |
| virtual | ~Base () |
| virtual int | GetUID () const =0 |
| Returns the unique identifier of a message word type. | |
| virtual void | TransferI (MessageBitInput &aMR)=0 |
| Reads the message from a MessageBitInput. | |
| virtual void | TransferO (MessageBitOutput &aMW)=0 |
| Reads the message from a MessageBitOutput. | |
| virtual void | CreateAccessor (MessageAccessorFiller &aMP)=0 |
| Used once to provide generic access to messages and fields. | |
| virtual const char * | GetFieldName (int i)=0 |
| Returns the name of the field with a given index. | |
| void | PrintWord (ut::log::MessageStream &aStream) const |
Additional Inherited Members | |
| Protected Member Functions inherited from WsfL16::Messages::InitialBase | |
| InitialBase ()=default | |
| bool | Initialize (const char *aData) |
| Initialize the message by reading from the data buffer. | |
| Protected Attributes inherited from WsfL16::Messages::InitialBase | |
| std::vector< std::unique_ptr< ContinuationBase > > | mContinuationWords |
| std::vector< std::unique_ptr< ExtensionBase > > | mExtensionWords |
| Header | mHeader |
Member Typedef Documentation
◆ FieldType1
| typedef SpareField<4> WsfL16::Messages::J13_4::Initial::FieldType1 |
◆ FieldType2
| typedef TrackNumberField WsfL16::Messages::J13_4::Initial::FieldType2 |
◆ FieldType3
| typedef IntegerField<12> WsfL16::Messages::J13_4::Initial::FieldType3 |
◆ FieldType4
| typedef SpareField<22> WsfL16::Messages::J13_4::Initial::FieldType4 |
Member Function Documentation
◆ DEFINE_CONTINUATIONS1()
| WsfL16::Messages::J13_4::Initial::DEFINE_CONTINUATIONS1 | ( | 1 | ) |
◆ DEFINE_EXTENSIONS0()
| WsfL16::Messages::J13_4::Initial::DEFINE_EXTENSIONS0 | ( | ) |
◆ DEFINE_INITIAL()
| WsfL16::Messages::J13_4::Initial::DEFINE_INITIAL | ( | 13 | , |
| 4 | ) |
◆ DEFINE_MEMBERS4()
| WsfL16::Messages::J13_4::Initial::DEFINE_MEMBERS4 | ( | Spare | , |
| TrackNumberReference | , | ||
| SubsurfaceSpecificType | , | ||
| Spare2 | ) |
The documentation for this class was generated from the following file: