Case::Case Class Reference

Core class that holds all pertinent data about a case. More...

#include <case.h>

List of all members.

Public Member Functions
	Case ()
	Default constructor.
	~Case ()
	Destructor.
void	setOverview (const Overview &overview)
	Set the case overview.
Overview	getOverview () const
	Get the current case overview.
void	setOverrides (const Overrides &ov)
	Set the overrides for this case.
Overrides	getOverrides () const
	Get the case overrides.
void	setInitialBlockId (const ustring &id)
	Set the ID of the initial text block.
ustring	getInitialBlockId () const
	Get the initial text block ID.
void	addCharacter (const Character &character)
	Add a character to the internal map.
void	addBackground (const Background &bg)
	Add a background to the internal map.
void	addEvidence (const Evidence &evidence)
	Add a piece of evidence to the internal map.
void	addImage (const Image &image)
	Add an image to the internal map.
void	addLocation (const Location &loc)
	Add a location to the internal map.
void	addTestimony (const Testimony &testimony)
	Add a testimony to the internal map.
void	addBuffer (const ustring &id, const ustring &contents)
	Add a text buffer to the internal map.
Character *	getCharacter (const ustring &id)
	Get a character.
Background *	getBackground (const ustring &id)
	Get a background.
Evidence *	getEvidence (const ustring &id)
	Get a piece of evidence.
Image *	getImage (const ustring &id)
	Get an image.
Location *	getLocation (const ustring &id)
	Get a location.
Testimony *	getTestimony (const ustring &id)
	Get a testimony.
std::vector< Evidence * >	getEvidenceFromIds (const StringVector &vec)
	Get a vector of evidence based on vector of string IDs.
std::vector < Character * >	getCharactersFromIds (const StringVector &vec)
	Get a vector of characters based on vector of string IDs.
void	clear ()
	Clear the entire case information.
CharacterMap	getCharacters () const
	Get a full map of characters.
BackgroundMap	getBackgrounds () const
	Get a full map of backgrounds.
EvidenceMap	getEvidence () const
	Get a full map of evidence.
ImageMap	getImages () const
	Get a full map of images.
LocationMap	getLocations () const
	Get a full map of locations.
TestimonyMap	getTestimonies () const
	Get a full map of testimonies.
BufferMap	getBuffers () const
	Get a map of buffers.
Private Attributes
Overrides	m_Overrides
	Case overrides.
Overview	m_Overview
	General case data.
ustring	m_InitialBlockId
	Initial text block that will be displayed when the case starts.
CharacterMap	m_Characters
	Map of characters.
BackgroundMap	m_Backgrounds
	Map of backgrounds.
EvidenceMap	m_Evidence
	Map of evidence.
ImageMap	m_Images
	Map of images.
LocationMap	m_Locations
	Map of locations.
TestimonyMap	m_Testimonies
	Map of testimonies.
BufferMap	m_Buffers
	Map of buffers.

---

Detailed Description

Core class that holds all pertinent data about a case.

This class stores all of the individual bits and pieces of a case, such as testimonies, text blocks, images, characters, etc.

---

Member Function Documentation

void Case::Case::setOverview

(

const Overview &

overview

)

Set the case overview.

Parameters:

overview

An Overview struct

Overview Case::Case::getOverview

(

)

const [inline]

Get the current case overview.

Returns:

The Overview struct for this case

void Case::Case::setOverrides

(

const Overrides &

ov

)

[inline]

Set the overrides for this case.

Parameters:

ov

A filled Overrides struct

Overrides Case::Case::getOverrides

(

)

const [inline]

Get the case overrides.

Returns:

The set Overrides struct

void Case::Case::setInitialBlockId

(

const ustring &

id

)

[inline]

Set the ID of the initial text block.

Parameters:

id

ID of the text block

ustring Case::Case::getInitialBlockId

(

)

const [inline]

Get the initial text block ID.

Returns:

ID of the initial text block

void Case::Case::addCharacter

(

const Character &

character

)

Add a character to the internal map.

Parameters:

character

The character

void Case::Case::addBackground

(

const Background &

bg

)

Add a background to the internal map.

Parameters:

bg

The background

void Case::Case::addEvidence

(

const Evidence &

evidence

)

Add a piece of evidence to the internal map.

Parameters:

evidence

The evidence

void Case::Case::addImage

(

const Image &

image

)

Add an image to the internal map.

Parameters:

image

The image

void Case::Case::addLocation

(

const Location &

loc

)

Add a location to the internal map.

Parameters:

loc

The location

void Case::Case::addTestimony

(

const Testimony &

testimony

)

Add a testimony to the internal map.

Parameters:

testimony

The testimony

void Case::Case::addBuffer	(	const ustring &	id,
		const ustring &	contents
	)

Add a text buffer to the internal map.

Parameters:

	id	The ID of the block
	contents	The block contents

Character * Case::Case::getCharacter

(

const ustring &

id

)

Get a character.

Parameters:

id

The ID of the character

Returns:

Pointer to a Character object

Case::Background * Case::Case::getBackground

(

const ustring &

id

)

Get a background.

Parameters:

id

The ID of the background

Returns:

Pointer to a Case::Background object

Case::Evidence * Case::Case::getEvidence

(

const ustring &

id

)

Get a piece of evidence.

Parameters:

id

The ID of the evidence

Returns:

Pointer to a Case::Evidence object

Case::Image * Case::Case::getImage

(

const ustring &

id

)

Get an image.

Parameters:

id

The ID of the image

Returns:

Pointer to a Case::Image object

Case::Location * Case::Case::getLocation

(

const ustring &

id

)

Get a location.

Parameters:

id

The ID of the location

Returns:

Pointer to a Case::Location object

Case::Testimony * Case::Case::getTestimony

(

const ustring &

id

)

Get a testimony.

Parameters:

id

The ID of the testimony

Returns:

Pointer to a Case::Testimony object

std::vector< Case::Evidence * > Case::Case::getEvidenceFromIds

(

const StringVector &

vec

)

Get a vector of evidence based on vector of string IDs.

Parameters:

vec

The vector of IDs

Returns:

A vector of Case::Evidence pointers matching the IDs

std::vector< Character * > Case::Case::getCharactersFromIds

(

const StringVector &

vec

)

Get a vector of characters based on vector of string IDs.

Parameters:

vec

Vector of IDs

Returns:

A vector of Character pointers matching the IDs

CharacterMap Case::Case::getCharacters

(

)

const [inline]

Get a full map of characters.

Returns:

Map of all characters

BackgroundMap Case::Case::getBackgrounds

(

)

const [inline]

Get a full map of backgrounds.

Returns:

Map of all backgrounds

EvidenceMap Case::Case::getEvidence

(

)

const [inline]

Get a full map of evidence.

Returns:

Map of all evidence

ImageMap Case::Case::getImages

(

)

const [inline]

Get a full map of images.

Returns:

Map of all images

LocationMap Case::Case::getLocations

(

)

const [inline]

Get a full map of locations.

Returns:

Map of all locations

TestimonyMap Case::Case::getTestimonies

(

)

const [inline]

Get a full map of testimonies.

Returns:

Map of all testimonies

BufferMap Case::Case::getBuffers

(

)

const [inline]

Get a map of buffers.

Returns:

Map of all text buffers

---

The documentation for this class was generated from the following files:

• case.h
• case.cpp

---