net.sf.jrtps.message

Class SubMessageHeader

java.lang.Object

net.sf.jrtps.message.SubMessageHeader

public class SubMessageHeader
extends Object

A Header of the SubMessage. see 8.3.3.2 Submessage structure

Author:

mcr70

Constructor Summary

Constructors

Constructor and Description
SubMessageHeader(int kind) Constructs this SubMessageHeader with given kind and DEFAULT_ENDIANESS_FLAG.
SubMessageHeader(int kind, int flags) Constructs this SubMessageHeader with given kind and flags.

Method Summary

Modifier and Type	Method and Description
boolean	endiannessFlag() Get the endianness for SubMessage.
byte	getSubMessageKind() Get the kind of SubMessage
int	getSubMessageLength() Get the length of the sub message.
String	toString()
void	writeTo(RTPSByteBuffer bb) Writes this SubMessageHeader into RTPSByteBuffer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SubMessageHeader

public SubMessageHeader(int kind)

Constructs this SubMessageHeader with given kind and DEFAULT_ENDIANESS_FLAG. Length of the SubMessage is set to 0. Length will be calculated during marshalling of the Message.

Parameters:

kind - Kind of SubMessage

SubMessageHeader

public SubMessageHeader(int kind,
                        int flags)

Constructs this SubMessageHeader with given kind and flags. Length of the SubMessage is set to 0. Length will be calculated during marshalling of the Message.

Parameters:

kind - Kind of SubMessage

flags - flags of this SubMessageHeader

Method Detail

writeTo

public void writeTo(RTPSByteBuffer bb)

Writes this SubMessageHeader into RTPSByteBuffer

Parameters:

bb - RTPSByteBuffer to write to

endiannessFlag

public boolean endiannessFlag()

Get the endianness for SubMessage. If endianness flag is set, little-endian is used by SubMessage, otherwise big-endian is used.

Returns:

true, if endianness flag is set

getSubMessageLength

public int getSubMessageLength()

Get the length of the sub message.

Returns:

length of the sub message

getSubMessageKind

public byte getSubMessageKind()

Get the kind of SubMessage

Returns:

kind

toString

public String toString()

Overrides:

toString in class Object