Brian M. Ames
and 1 contributors

NAME

Rinchi::CIGIPP::MaritimeSurfaceConditionsResponse - Perl extension for the Common Image Generator Interface - Maritime Surface Conditions Response data packet. data packet. =head1 SYNOPSIS

  use Rinchi::CIGIPP::MaritimeSurfaceConditionsResponse;
  my $msc_resp = Rinchi::CIGIPP::MaritimeSurfaceConditionsResponse->new();

  $packet_type = $msc_resp->packet_type();
  $packet_size = $msc_resp->packet_size();
  $request_ident = $msc_resp->request_ident(122);
  $sea_surface_height = $msc_resp->sea_surface_height(9.874);
  $surface_water_temperature = $msc_resp->surface_water_temperature(82.083);
  $surface_clarity = $msc_resp->surface_clarity(8.774);

DESCRIPTION

The Maritime Surface Conditions Response packet is sent in response to an Environmental Conditions Request packet whose Request Type attribute specifies Maritime Surface Conditions. The packet describes the sea surface state at the requested geodetic latitude and longitude.

EXPORT

None by default.

#==============================================================================

new $msc_resp = Rinchi::CIGIPP::MaritimeSurfaceConditionsResponse->new()

Constructor for Rinchi::MaritimeSurfaceConditionsResponse.

sub packet_type()
 $value = $msc_resp->packet_type();

Data Packet Identifier.

This attribute identifies this data packet as the Maritime Surface Conditions Response packet. The value of this attribute must be 111.

sub packet_size()
 $value = $msc_resp->packet_size();

Data Packet Size.

This attribute indicates the number of bytes in this data packet. The value of this attribute must be 16.

sub request_ident([$newValue])
 $value = $msc_resp->request_ident($newValue);

Request ID.

This attribute identifies the environmental conditions request to which this response packet corresponds.

sub sea_surface_height([$newValue])
 $value = $msc_resp->sea_surface_height($newValue);

Sea Surface Height.

This attribute indicates the height of the sea surface at equilibrium (i.e., without waves).

Note that the instantaneous elevation of the water including wave displacement may be determined from a Height Of Terrain request.

sub surface_water_temperature([$newValue])
 $value = $msc_resp->surface_water_temperature($newValue);

Surface Water Temperature

This attribute indicates the water temperature at the sea surface.

sub surface_clarity([$newValue])
 $value = $msc_resp->surface_clarity($newValue);

Surface Clarity.

This attribute indicates the clarity of the water at its surface. A value of 100% indicates pristine water, while a value of 0% indicates extremely turbid water.

sub pack()
 $value = $msc_resp->pack();

Returns the packed data packet.

sub unpack()
 $value = $msc_resp->unpack();

Unpacks the packed data packet.

sub byte_swap()
 $obj_name->byte_swap();

Byte swaps the packed data packet.

SEE ALSO

Refer the the Common Image Generator Interface ICD which may be had at this URL: http://cigi.sourceforge.net/specification.php

AUTHOR

Brian M. Ames, <bmames@apk.net>

COPYRIGHT AND LICENSE

Copyright (C) 2009 by Brian M. Ames

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.6 or, at your option, any later version of Perl 5 you may have available.

2 POD Errors

The following errors were encountered while parsing the POD:

Around line 69:

'=item' outside of any '=over'

Around line 313:

You forgot a '=back' before '=head1'