Brian M. Ames
and 1 contributors

NAME

Rinchi::CIGIPP::HAT_HOTResponse - Perl extension for the Common Image Generator Interface - HAT/HOTResponse data packet. data packet. =head1 SYNOPSIS

  use Rinchi::CIGIPP::HAT_HOTResponse;
  my $hgt_resp = Rinchi::CIGIPP::HAT_HOTResponse->new();

  $packet_type = $hgt_resp->packet_type();
  $packet_size = $hgt_resp->packet_size();
  $response_ident = $hgt_resp->response_ident(47273);
  $host_frame_number_lsn = $hgt_resp->host_frame_number_lsn(13);
  $response_type = $hgt_resp->response_type(Rinchi::CIGIPP->HeightAboveTerrain);
  $valid = $hgt_resp->valid(Rinchi::CIGIPP->Invalid);
  $height = $hgt_resp->height(51.413);

DESCRIPTION

The HAT/HOT Response packet is sent by the IG in response to a HAT/HOT Request packet whose Request Type attribute was set to HAT (0) or HOT (1). This packet provides either the Height Above Terrain (HAT) or Height Of Terrain (HOT) for the test point. This packet does not contain the material code or surface normal of the terrain.

If the Update Period attribute of the originating HAT/HOT Request packet was set to a value greater than zero, then the Host Frame Number LSN attribute of each corresponding HAT/HOT Response packet must contain the least significant nybble of the Host Frame Number value last received by the IG before the HAT or HOT value is calculated. The Host may correlate this LSN to an eyepoint position or may use the value to determine latency.

The IG can only return the HAT or HOT for a point that is within the bounds of the current database. If the HAT or HOT cannot be returned, the Valid attribute will be set to Invalid (0).

EXPORT

None by default.

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

new $hgt_resp = Rinchi::CIGIPP::HAT_HOTResponse->new()

Constructor for Rinchi::HAT_HOTResponse.

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

Data Packet Identifier.

This attribute identifies this data packet as the HAT/HOT Response packet. The value of this attribute must be 102.

sub packet_size()
 $value = $hgt_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 response_ident([$newValue])
 $value = $hgt_resp->response_ident($newValue);

HAT/HOT ID.

This attribute identifies the HAT/HOT response. This value corresponds to the value of the HAT/HOT ID attribute in the associated HAT/HOT Request packet.

sub host_frame_number_lsn([$newValue])
 $value = $hgt_resp->host_frame_number_lsn($newValue);

Host Frame Number LSN.

This attribute contains the least significant nybble of the Host Frame Number attribute of the last IG Control packet received before the HAT or HOT is calculated.

This attribute is ignored if the Update Period attribute of the corresponding HAT/HOT Request packet was set to zero (0).

sub response_type([$newValue])
 $value = $hgt_resp->response_type($newValue);

Response Type.

This attribute indicates whether the Height attribute represents Height Above Terrain or Height Of Terrain.

    HeightAboveTerrain   0
    HeightOfTerrain      1
sub valid([$newValue])
 $value = $hgt_resp->valid($newValue);

Valid.

This attribute indicates whether the remaining attributes in this packet contain valid numbers. A value of zero (0) indicates that the test point was beyond the database bounds.

    Invalid   0
    Valid     1
sub height([$newValue])
 $value = $hgt_resp->height($newValue);

Height.

This attribute contains the requested height. If Request Type is set to HAT (0), this value represents the Height Above Terrain. If Request Type is set to HOT (1), this value represents the Height Of Terrain.

This attribute is valid only if the Valid attribute is set to one (1).

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

Returns the packed data packet.

sub unpack()
 $value = $hgt_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 82:

'=item' outside of any '=over'

Around line 377:

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