#include <ossimJpipMessageHeader.h>

Inheritance diagram for ossimJpipMessageHeader:

Public Member Functions
	ossimJpipMessageHeader ()

void	reset ()

ossimString	toString () const

Public Member Functions inherited from ossimReferenced
	ossimReferenced ()

	ossimReferenced (const ossimReferenced &)

ossimReferenced &	operator= (const ossimReferenced &)

void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

int	referenceCount () const

Public Attributes
bool	m_isLastByte
	Bin-ID = [BinIdIndicator, completeDataBin, InClassIdentifier]. More...

ossim_int64	m_inClassIdentifier

ossim_int32	m_classIdentifier
	If present, provides a message class identifier. More...

ossim_int32	m_CSn
	If present, identifies the index (stating from 0) of the codestream to which the data-bin belongs. More...

ossim_int64	m_msgOffset
	Identifies the offset of the data in the message from the start of the data-bin. More...

ossim_int64	m_msgLength
	Identifies the total number of bytes in the body of the message. More...

ossim_int64	m_aux
	If present, it represents a non-negative integer value, formed by concatenating the least significant 7 bits of each byte in the VBAS in big-endian order. More...

bool	m_isEOR
	Indicates if this JPIP Message is an End of Response Message. More...

int	m_EORCode
	Definition in CADI.Common.Network.JPIP.EORCodes. More...

ossimString	m_EORReasonMessage
	It is and reason message associated with the `EORReasonCode`. More...

Additional Inherited Members
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Detailed Description

Definition at line 14 of file ossimJpipMessageHeader.h.

Constructor & Destructor Documentation

◆ ossimJpipMessageHeader()

ossimJpipMessageHeader::ossimJpipMessageHeader ( )

inline

Definition at line 17 of file ossimJpipMessageHeader.h.

     :m_isLastByte(true),
     m_inClassIdentifier(-1),
     m_classIdentifier(-1),
     m_CSn(-1),
     m_msgOffset(-1),
     m_msgLength(-1),
     m_aux(-1),
     m_isEOR(false),
     m_EORCode(-1),
     m_EORReasonMessage("")
     {
         
     }

Member Function Documentation

◆ reset()

void ossimJpipMessageHeader::reset ( void )

inline

Definition at line 31 of file ossimJpipMessageHeader.h.

Referenced by ossimJpipMessage::reset().

     {
         m_isLastByte        = true;
         m_inClassIdentifier = -1;
         m_classIdentifier   = -1;
         m_CSn               = -1;
         m_msgOffset         = -1;
         m_msgLength         = -1;
         m_aux               = -1;
         m_isEOR             = false;
         m_EORCode           = -1;
         m_EORReasonMessage  = "";
     }

◆ toString()

ossimString ossimJpipMessageHeader::toString ( ) const

inline

Definition at line 44 of file ossimJpipMessageHeader.h.

References ossimString::toString().

     {
         std::ostringstream out;
         
         out << "m_isLastByte: " << ossimString::toString(m_isLastByte) << "\n"
         << "m_inClassIdentifier: " << m_inClassIdentifier << "\n"
         << "m_classIdentifier: " << m_classIdentifier << "\n"
         << "m_CSn: " << m_CSn << "\n"
         << "m_msgOffset: " << m_msgOffset << "\n"
         << "m_msgLength: " << m_msgLength << "\n"
         << "m_aux: "       << m_aux << "\n"
         << "m_isEOR: "            << m_isEOR << "\n"
         << "m_EORCode: "          << m_EORCode << "\n"
         << "m_EORReasonMessage: " << m_EORReasonMessage << "\n";
         
         return ossimString(out.str());
     }   

Member Data Documentation

◆ m_aux

ossim_int64 ossimJpipMessageHeader::m_aux

If present, it represents a non-negative integer value, formed by concatenating the least significant 7 bits of each byte in the VBAS in big-endian order.

Its presence and meaning if present, is determined by the message class identifier found within the Bin-ID VBAS.

Definition at line 210 of file ossimJpipMessageHeader.h.

Referenced by ossimJpipMessageDecoder::readMessage().

◆ m_classIdentifier

ossim_int32 ossimJpipMessageHeader::m_classIdentifier

If present, provides a message class identifier.

The message class identifier is a non-negative integer, formed by concatenating the least significant 7 bits of each byte of the VBAS in big-endian order. If no present, the message class identifier is unchanged form that associated with the previous message. If the Class VBAS is not present and there is no previous message, the message class identifier is 0.

Class identifier	Message class	Data-bin class	Stream type
0	Precinct data-bin message	Precinct data-bin	JPP-stream only
1	Extended precinct data-bin message	Precinct data-bin	JPP-stream only
2	Tile header data-bin message	Tile header data-bin	JPP-stream only
4	Tile data-bin message	Tile data-bin	JPT-stream only
5	Extended precinct data-bin message	Tile data-bin	JPT-stream only
6	Main header data-bin message	Main heaer data-bin	JPP- and JPT-stream
8	Metadata-bin message	Metadata-bin	JPP and JPT-stream

Allowed values, see CADI.Common.Network.JPIP.ClassIdentifiers.

Definition at line 176 of file ossimJpipMessageHeader.h.

Referenced by ossimJpipMessageDecoder::readMessage().

◆ m_CSn

ossim_int32 ossimJpipMessageHeader::m_CSn

If present, identifies the index (stating from 0) of the codestream to which the data-bin belongs.

The codestream index is formed by concatenating the leas significant 7 bits of each byte of the VBAS in big-endian order. If the CSn VBAS is no present, the codestream index is unchanged from the previous message. If CSn VBAS is no present and there is no previous message, the codestream index is 0.

Definition at line 186 of file ossimJpipMessageHeader.h.

Referenced by ossimJpipMessageDecoder::readMessage().

◆ m_EORCode

int ossimJpipMessageHeader::m_EORCode

Definition in CADI.Common.Network.JPIP.EORCodes.

Further information, see ISO/IEC 15444-9 sect. D.3

Definition at line 222 of file ossimJpipMessageHeader.h.

Referenced by ossimJpipMessageDecoder::readEORMessage().

◆ m_EORReasonMessage

ossimString ossimJpipMessageHeader::m_EORReasonMessage

It is and reason message associated with the EORReasonCode.

It is an optional attribute.

Definition at line 229 of file ossimJpipMessageHeader.h.

◆ m_inClassIdentifier

ossim_int64 ossimJpipMessageHeader::m_inClassIdentifier

Definition at line 112 of file ossimJpipMessageHeader.h.

Referenced by ossimJpipMessageDecoder::readMessage().

◆ m_isEOR

bool ossimJpipMessageHeader::m_isEOR

Indicates if this JPIP Message is an End of Response Message.

Definition at line 215 of file ossimJpipMessageHeader.h.

Referenced by ossimJpipMessageDecoder::readEORMessage().

◆ m_isLastByte

bool ossimJpipMessageHeader::m_isLastByte

Bin-ID = [BinIdIndicator, completeDataBin, InClassIdentifier].

Bin-ID format:

<samp> MSB LSB 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0

|a|b b|c|d d d d| |a|d d d d d d d| |a|d d d d d d d| .....

</samp>

Bits 6 and 5 of the first, BinIDIndicator, byte indicate whether the Class and CSn VBASs are present in the message header. Next table defines the bit values and its meaning

Indicator	Meaning
0	Prohibited
1	No Class or CSn VBAS is present in message header
2	Class VBAS is present but CSn is no present in message header
3	Class and CSn VBAS are both present in the message header

Bit 4, completeDataBin, of the first byte of the Bin-ID indicates whether or not this message contains the last byte in the asociated data-bin: '0' means it is not the last byte in the data-bin; '1' inidates tat it is the last byte in the data-bin.

The remaining 4 bits of the first byte and the 7 low order bits of any remaining bytes in the Bin-ID VBAS form an "in-class identifier".

Definition at line 111 of file ossimJpipMessageHeader.h.

Referenced by ossimJpipMessageDecoder::readMessage().

◆ m_msgLength

ossim_int64 ossimJpipMessageHeader::m_msgLength

Identifies the total number of bytes in the body of the message.

It is a non-negative integer value, formed by concatenating the least significant 7 bits of each byte in the VBAS in big-endian order.

Definition at line 200 of file ossimJpipMessageHeader.h.

Referenced by ossimJpipMessageDecoder::readEORMessage(), and ossimJpipMessageDecoder::readMessage().

◆ m_msgOffset

ossim_int64 ossimJpipMessageHeader::m_msgOffset

Identifies the offset of the data in the message from the start of the data-bin.

It is a non-negative integer value, formed by concatenating the least significant 7 bits of each byte in the VBAS in big-endian order.

Definition at line 193 of file ossimJpipMessageHeader.h.

Referenced by ossimJpipMessageDecoder::readMessage().

The documentation for this class was generated from the following file:

ossimJpipMessageHeader.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimJpipMessageHeader()

Member Function Documentation

◆ reset()

◆ toString()

Member Data Documentation

◆ m_aux

◆ m_classIdentifier

◆ m_CSn

◆ m_EORCode

◆ m_EORReasonMessage

◆ m_inClassIdentifier

◆ m_isEOR

◆ m_isLastByte

◆ m_msgLength

◆ m_msgOffset