NAME

Games::Solitaire::Verify::Card - a class wrapper for an individual Solitaire card.

VERSION

Version 0.0101

SYNOPSIS

    use Games::Solitaire::Verify::Card;

    # Initialise a Queen-of-Hearts
    my $queen_of_hearts = Games::Solitaire::Verify::Card->new(
        {
            string => "QH",
            id => 4,
            data => { %DATA },
        },
    );

FUNCTIONS

$class->get_suits_seq()

Returns the expected sequence of the suits - "H", "S", "C", "D".

$class->calc_rank($rank_string)

Calculates the numerical rank of the string passed as argument.

Example:

    my $ten = Games::Solitaire::Verify::Card->calc_rank("T")
    # Prints 10.
    print "$ten\n";

$class->calc_rank_with_0($rank_string)

Same as calc_rank only supporting "0" as the zero'th card.

$card->data()

Arbitrary data that is associated with the card. Can hold any scalar.

$card->id()

A simple identifier that identifies the card. Should be a string.

$card->rank()

Returns the rank of the card as an integer. Ace is 1, 2-10 are 2-10; J is 11, Q is 12 and K is 13.

$card->suit()

Returns "H", "C", "D" or "S" depending on the suit.

$card->color()

Returns "red" or "black" depending on the rank of the card.

$card->color_for_suit($suit)

Get the color of the suit $suit (which may be different than the card's suit).

$card->to_string()

Converts the card to a string representation.

$class->rank_to_string($rank_idx)

Converts the rank to a string.

AUTHOR

Shlomi Fish, <shlomif at iglu.org.il>

BUGS

Please report any bugs or feature requests to bug-games-solitaire-verifysolution-move at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Games-Solitaire-Verify. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Games::Solitaire::Verify::Card

You can also look for information at:

RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Games-Solitaire-Verify
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Games-Solitaire-Verify
CPAN Ratings
http://cpanratings.perl.org/d/Games-Solitaire-Verify
Search CPAN
http://search.cpan.org/dist/Games-Solitaire-Verify

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

This program is released under the following license: MIT/X11 ( http://www.opensource.org/licenses/mit-license.php ).