NetMauMau  0.24.0
Client API
Public Types | Public Member Functions | List of all members
NetMauMau::Common::ICard Interface Referenceabstract

#include <icard.h>

Detailed Description

Describes a playing card.

Utilities describes various functions to handle with ICard instances.

Public Types

enum  RANK {
  SEVEN = 7, EIGHT = 8, NINE = 9, TEN = 10,
  JACK, QUEEN, KING, ACE,
  RANK_ILLEGAL
}
 The rank of the card. More...
 
enum  SUIT {
  DIAMONDS, HEARTS, SPADES, CLUBS,
  SUIT_ILLEGAL
}
 The suit of the card. More...
 

Public Member Functions

virtual const std::string & description (bool ansi=false) const =0
 Returns the textual description of the card. More...
 
virtual std::size_t getPoints () const =0
 Gets the points of the card. More...
 
virtual RANK getRank () const =0
 Gets the rank of the card. More...
 
virtual SUIT getSuit () const =0
 Gets the suit of the card. More...
 

Related Functions

(Note that these are not member functions.)

Global compare and relational operators
bool operator== (const NetMauMau::Common::ICard &card, NetMauMau::Common::ICard::RANK rank)
 Compares a card against a rank. More...
 
bool operator!= (const NetMauMau::Common::ICard &card, NetMauMau::Common::ICard::RANK rank)
 Compares a card against a rank. More...
 
bool operator== (const NetMauMau::Common::ICard &card, NetMauMau::Common::ICard::SUIT suit)
 Compares a card against a suit. More...
 
bool operator!= (const NetMauMau::Common::ICard &card, NetMauMau::Common::ICard::SUIT suit)
 Compares a card against a suit. More...
 
bool operator== (const NetMauMau::Common::ICard &lhs, const NetMauMau::Common::ICard &rhs)
 Compares cards. More...
 
bool operator!= (const NetMauMau::Common::ICard &lhs, const NetMauMau::Common::ICard &rhs)
 Compares cards. More...
 
bool operator< (const NetMauMau::Common::ICard &lhs, const NetMauMau::Common::ICard &rhs)
 Compares cards. More...
 
bool operator> (const NetMauMau::Common::ICard &lhs, const NetMauMau::Common::ICard &rhs)
 Compares cards. More...
 
bool operator== (const NetMauMau::Common::ICard *card, NetMauMau::Common::ICard::RANK rank)
 Compares a card against a rank. More...
 
bool operator!= (const NetMauMau::Common::ICard *card, NetMauMau::Common::ICard::RANK rank)
 Compares a card against a rank. More...
 
bool operator== (const NetMauMau::Common::ICard *card, NetMauMau::Common::ICard::SUIT suit)
 Compares a card against a suit. More...
 
bool operator!= (const NetMauMau::Common::ICard *card, NetMauMau::Common::ICard::SUIT suit)
 Compares a card against a suit. More...
 

Member Enumeration Documentation

The rank of the card.

Enumerator
SEVEN 

7

EIGHT 

8

NINE 

9

TEN 

10

JACK 

Jack.

QUEEN 

Queen.

KING 

King.

ACE 

Ace.

RANK_ILLEGAL 

used to send a surely not accepted card

The suit of the card.

Enumerator
DIAMONDS 

HEARTS 

SPADES 

CLUBS 

SUIT_ILLEGAL 

used to send a surely not accepted card

Member Function Documentation

virtual const std::string& NetMauMau::Common::ICard::description ( bool  ansi = false) const
pure virtual

Returns the textual description of the card.

See also
NetMauMau::Common::parseCardDesc
Parameters
ansitrue if ANSI color code should be used, false otherwise
Returns
the textual description of the card
virtual std::size_t NetMauMau::Common::ICard::getPoints ( ) const
pure virtual

Gets the points of the card.

See also
Common::getCardPoints
Returns
the points of the card
virtual RANK NetMauMau::Common::ICard::getRank ( ) const
pure virtual

Gets the rank of the card.

Returns
the rank of the card

Referenced by operator!=(), operator<(), operator==(), and operator>().

virtual SUIT NetMauMau::Common::ICard::getSuit ( ) const
pure virtual

Gets the suit of the card.

Returns
the suit of the card

Referenced by operator!=(), operator<(), operator==(), and operator>().