File: VotingBooth.h

package info (click to toggle)
bzflag 2.0.13.20080902-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 27,564 kB
  • ctags: 34,716
  • sloc: cpp: 139,842; ansic: 14,510; sh: 10,715; makefile: 2,454; perl: 477; php: 428; python: 345; objc: 243; xml: 24
file content (120 lines) | stat: -rw-r--r-- 3,156 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
/* bzflag
 * Copyright (c) 1993 - 2008 Tim Riker
 *
 * This package is free software;  you can redistribute it and/or
 * modify it under the terms of the license found in the file
 * named LICENSE that should have accompanied this file.
 *
 * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 */

#ifndef __VOTINGBOOTH_H__
#define __VOTINGBOOTH_H__

#include "common.h"

/* system interface headers */
#include <ctype.h>
#include <map>
#include <vector>
#include <string>
#include <algorithm>


/** VotingBooth is a means to create and track a vote.  A single booth
 * will track and allow voting on a poll.
 *
 * By default, false and true (i.e. no and yes) are the respective first
 * two default results of any poll if unspecified.
 */
class VotingBooth
{
private:

  static const short int RETRACTED_VOTE;
  typedef std::map<std::string, short int> VoterResponseMap;

  /** question that is voted upon (optionally provided)
   */
  std::string _question;

  /** vector of potential poll response choices
   */
  std::vector<std::string> _choice;

  /** collection of the voters and their response responses (index into the
   * choice vector)
   */
  VoterResponseMap _vote;

protected:

 public:

  VotingBooth(std::string question = "");
  VotingBooth(const VotingBooth& booth);
  ~VotingBooth(void);

  /** add a response to vote upon.  vote responses are the choices that
   * may be voted upon (e.g. "yes", "no", "maybe", etc).
   */
  bool addResponse(const std::string response);

  /** return truthfully if a particular person has already voted
    */
  bool hasVoted(const std::string voterName) const;

  /** a given user id/name responds and votes to a particular poll
   * response.  returns truthfully whether the vote was placed.
   */
  bool vote(const std::string voterName, const std::string response);

  /** allow a vote to be retracted, returns truefully whether a retraction
   * was possible.
   */
  bool retractVote(const std::string voterName);

  /** return how many votes have been placed for a particular response.
   */
  unsigned long int getVoteCount(const std::string response) const;

  /** return total number of votes received
   */
  unsigned long int getTotalVotes(void) const;

  /** returns the number of voters that have participated
   */
  inline unsigned long int getVoterCount(void) const {
    return (unsigned long int)_vote.size();
  }

  /** returns the number of responses available
   */
  inline unsigned long int getResponseCount(void) const {
    return (unsigned long int)_choice.size();
  }

  /** returns a string identifier for this poll
   */
  inline const std::string getPollName(void) const {
    return _question;
  }

};

/* convenience func that sets up and returns a default boolean poll */
VotingBooth *YesNoVotingBooth(std::string question = "");

#else
class VotingBooth;
#endif

// Local Variables: ***
// mode:C++ ***
// tab-width: 8 ***
// c-basic-offset: 2 ***
// indent-tabs-mode: t ***
// End: ***
// ex: shiftwidth=2 tabstop=8