Brian M. Ames
and 1 contributors

NAME

Rinchi::CIGIPP::AnimationStopNotification - Perl extension for the Common Image Generator Interface - Animation Stop Notification data packet. data packet. =head1 SYNOPSIS

  use Rinchi::CIGIPP::AnimationStopNotification;
  my $stop_ntc = Rinchi::CIGIPP::AnimationStopNotification->new();

  $packet_type = $stop_ntc->packet_type();
  $packet_size = $stop_ntc->packet_size();
  $entity_ident = $stop_ntc->entity_ident(44464);

DESCRIPTION

The Animation Stop Notification packet is used to indicate to the Host when an animation has played to the end of its animation sequence.

EXPORT

None by default.

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

new $stop_ntc = Rinchi::CIGIPP::AnimationStopNotification->new()

Constructor for Rinchi::AnimationStopNotification.

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

Data Packet Identifier.

This attribute identifies this data packet as the Animation Stop Notification packet. The value of this attribute must be 115.

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

Data Packet Size.

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

sub entity_ident([$newValue])
 $value = $stop_ntc->entity_ident($newValue);

Entity ID.

This attribute indicates the entity ID of the animation that has stopped.

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

Returns the packed data packet.

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

'=item' outside of any '=over'

Around line 233:

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