ESA JPIP server  0.1
jpip::WOIComposer Class Reference

By means of this class it is possible to find out the which packets of an image are associated to a WOI. More...

#include <woi_composer.h>

Collaboration diagram for jpip::WOIComposer:

Public Member Functions

 WOIComposer ()
 Initializes the object. More...
 
 WOIComposer (const WOIComposer &composer)
 Copy constructor. More...
 
 WOIComposer (CodingParameters::Ptr coding_parameters)
 Initializes the object. More...
 
void Reset (const WOI &woi, CodingParameters::Ptr coding_parameters)
 Resets the packets navigation and starts a new one. More...
 
WOIComposeroperator= (const WOIComposer &composer)
 Copy assignment. More...
 
Packet GetCurrentPacket () const
 Returns the current packet. More...
 
bool GetNextPacket (Packet *packet=NULL)
 Moves to the next packet of the WOI. More...
 
virtual ~WOIComposer ()
 

Private Attributes

Point pxy1
 Upper-left corner of the WOI. More...
 
Point pxy2
 Bottom-right corner of the WOI. More...
 
bool more_packets
 Flag to control the last packet. More...
 
int max_resolution
 Maximum resolution. More...
 
Size min_precinct_xy
 Minimum precinct. More...
 
Size max_precinct_xy
 Maximum precinct. More...
 
Packet current_packet
 Current packet. More...
 
CodingParameters::Ptr coding_parameters
 Pointer to the associated coding parameters. More...
 

Detailed Description

By means of this class it is possible to find out the which packets of an image are associated to a WOI.

Given a WOI and the coding parameters of an image, the code of this class allows to navigate, following the LRCP order, through all the associated packets.

See also
WOI
CodingParameters

Constructor & Destructor Documentation

jpip::WOIComposer::WOIComposer ( )
inline

Initializes the object.

No packets are available.

jpip::WOIComposer::WOIComposer ( const WOIComposer composer)
inline

Copy constructor.

jpip::WOIComposer::WOIComposer ( CodingParameters::Ptr  coding_parameters)
inline

Initializes the object.

No packets are available.

Parameters
coding_parametersPointer to the coding parameters.
virtual jpip::WOIComposer::~WOIComposer ( )
inlinevirtual

Member Function Documentation

Packet jpip::WOIComposer::GetCurrentPacket ( ) const
inline

Returns the current packet.

Here is the caller graph for this function:

bool jpip::WOIComposer::GetNextPacket ( Packet packet = NULL)
inline

Moves to the next packet of the WOI.

Parameters
packetPointer to store the current packet (not the next one).
Returns
true if successful.

Here is the caller graph for this function:

WOIComposer& jpip::WOIComposer::operator= ( const WOIComposer composer)
inline

Copy assignment.

void jpip::WOIComposer::Reset ( const WOI woi,
CodingParameters::Ptr  coding_parameters 
)
inline

Resets the packets navigation and starts a new one.

Sets the current packet to the first packet of the WOI, assuming a LRCP order.

Parameters
woiNew WOI to use.
coding_parametersCoding parameters to use.

Here is the caller graph for this function:

Member Data Documentation

CodingParameters::Ptr jpip::WOIComposer::coding_parameters
private

Pointer to the associated coding parameters.

Packet jpip::WOIComposer::current_packet
private

Current packet.

Size jpip::WOIComposer::max_precinct_xy
private

Maximum precinct.

int jpip::WOIComposer::max_resolution
private

Maximum resolution.

Size jpip::WOIComposer::min_precinct_xy
private

Minimum precinct.

bool jpip::WOIComposer::more_packets
private

Flag to control the last packet.

Point jpip::WOIComposer::pxy1
private

Upper-left corner of the WOI.

Point jpip::WOIComposer::pxy2
private

Bottom-right corner of the WOI.


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