WsfL16::Messages::J2_4::Initial Class Reference
#include <Message2_4.hpp>
Inheritance diagram for WsfL16::Messages::J2_4::Initial:
Collaboration diagram for WsfL16::Messages::J2_4::Initial:
Public Types | |
| typedef BooleanField | FieldType1 |
| typedef BooleanField | FieldType2 |
| typedef BooleanField | FieldType3 |
| typedef BooleanField | FieldType4 |
| typedef BooleanField | FieldType5 |
| typedef BooleanField | FieldType6 |
| typedef SpareField< 2 > | FieldType7 |
| typedef BooleanField | FieldType8 |
| typedef InverseBooleanField | FieldType9 |
| typedef NetworkParticipationStatusField | FieldType10 |
| typedef TimeQualityField | FieldType11 |
| typedef QualityField | FieldType12 |
| typedef SpareField< 7 > | FieldType13 |
| typedef DepthField | FieldType14 |
| typedef DepthCategoryField | FieldType15 |
| typedef IntegerFieldNS< 8, NoStatementZero > | FieldType16 |
| typedef IntegerField< 4 > | FieldType17 |
| typedef SpareField< 5 > | FieldType18 |
| Public Types inherited from WsfL16::Messages::Base | |
| enum | WordType { cINITIAL , cCONTINUATION , cEXTENSION , cUNDEFINED } |
Public Member Functions | |
| DEFINE_INITIAL (2, 4) | |
| DEFINE_MEMBERS18 (IsExerciseTrackUnit, IsPositionInContinuation, IsForceTell, IsEmergencyStatus, IsC2Unit, IsSimulated, Spare, IsActiveRelay, IsReplyStatusNetwork, NetParticipation, TimeQuality, PositionQualityFt, Spare2, Depth, DepthCategory, MissionCorrelator, DepthQuality, Spare3) | |
| DEFINE_CONTINUATIONS4 (1, 2, 3, 4) | |
| DEFINE_EXTENSIONS1 () | |
| 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 BooleanField WsfL16::Messages::J2_4::Initial::FieldType1 |
◆ FieldType10
| typedef NetworkParticipationStatusField WsfL16::Messages::J2_4::Initial::FieldType10 |
◆ FieldType11
| typedef TimeQualityField WsfL16::Messages::J2_4::Initial::FieldType11 |
◆ FieldType12
| typedef QualityField WsfL16::Messages::J2_4::Initial::FieldType12 |
◆ FieldType13
| typedef SpareField<7> WsfL16::Messages::J2_4::Initial::FieldType13 |
◆ FieldType14
| typedef DepthField WsfL16::Messages::J2_4::Initial::FieldType14 |
◆ FieldType15
| typedef DepthCategoryField WsfL16::Messages::J2_4::Initial::FieldType15 |
◆ FieldType16
| typedef IntegerFieldNS<8, NoStatementZero> WsfL16::Messages::J2_4::Initial::FieldType16 |
◆ FieldType17
| typedef IntegerField<4> WsfL16::Messages::J2_4::Initial::FieldType17 |
◆ FieldType18
| typedef SpareField<5> WsfL16::Messages::J2_4::Initial::FieldType18 |
◆ FieldType2
| typedef BooleanField WsfL16::Messages::J2_4::Initial::FieldType2 |
◆ FieldType3
| typedef BooleanField WsfL16::Messages::J2_4::Initial::FieldType3 |
◆ FieldType4
| typedef BooleanField WsfL16::Messages::J2_4::Initial::FieldType4 |
◆ FieldType5
| typedef BooleanField WsfL16::Messages::J2_4::Initial::FieldType5 |
◆ FieldType6
| typedef BooleanField WsfL16::Messages::J2_4::Initial::FieldType6 |
◆ FieldType7
| typedef SpareField<2> WsfL16::Messages::J2_4::Initial::FieldType7 |
◆ FieldType8
| typedef BooleanField WsfL16::Messages::J2_4::Initial::FieldType8 |
◆ FieldType9
| typedef InverseBooleanField WsfL16::Messages::J2_4::Initial::FieldType9 |
Member Function Documentation
◆ DEFINE_CONTINUATIONS4()
| WsfL16::Messages::J2_4::Initial::DEFINE_CONTINUATIONS4 | ( | 1 | , |
| 2 | , | ||
| 3 | , | ||
| 4 | ) |
◆ DEFINE_EXTENSIONS1()
| WsfL16::Messages::J2_4::Initial::DEFINE_EXTENSIONS1 | ( | ) |
◆ DEFINE_INITIAL()
| WsfL16::Messages::J2_4::Initial::DEFINE_INITIAL | ( | 2 | , |
| 4 | ) |
◆ DEFINE_MEMBERS18()
| WsfL16::Messages::J2_4::Initial::DEFINE_MEMBERS18 | ( | IsExerciseTrackUnit | , |
| IsPositionInContinuation | , | ||
| IsForceTell | , | ||
| IsEmergencyStatus | , | ||
| IsC2Unit | , | ||
| IsSimulated | , | ||
| Spare | , | ||
| IsActiveRelay | , | ||
| IsReplyStatusNetwork | , | ||
| NetParticipation | , | ||
| TimeQuality | , | ||
| PositionQualityFt | , | ||
| Spare2 | , | ||
| Depth | , | ||
| DepthCategory | , | ||
| MissionCorrelator | , | ||
| DepthQuality | , | ||
| Spare3 | ) |
The documentation for this class was generated from the following file: