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.
void	set_overview (const Overview &overview)
	Set the case overview.
Overview	get_overview () const
	Get the current case overview.
void	set_overrides (const Overrides &ov)
	Set the overrides for this case.
Overrides	get_overrides () const
	Get the case overrides.
void	set_initial_block_id (const Glib::ustring &id)
	Set the ID of the initial text block.
Glib::ustring	get_initial_block_id () const
	Get the initial text block ID.
void	add_character (const Character &character)
	Add a character to the internal map.
void	remove_character (const Glib::ustring &name)
	Remove a character based on name.
void	add_image (const Image &image)
	Add an image to the internal map.
void	remove_image (const Glib::ustring &id)
	Remove an image from the case.
void	add_testimony (const Testimony &testimony)
	Add a testimony to the internal map.
void	remove_testimony (const Glib::ustring &id)
	Remove a testimony from the case.
void	add_background (const Background &bg)
	Add a background to the internal map.
void	remove_background (const Glib::ustring &id)
	Remove a background from the case.
void	add_evidence (const Evidence &evidence)
	Add a piece of evidence to the internal map.
void	remove_evidence (const Glib::ustring &id)
	Remove a piece of evidence from the case.
void	add_location (const Location &loc)
	Add a location to the internal map.
void	remove_location (const Glib::ustring &id)
	Remove a location from the case.
void	add_audio (const Audio &audio)
	Add an audio sample to the internal map.
StringVector	get_character_names ()
	Get all character internal names.
StringVector	get_image_ids ()
	Get all image internal IDs.
StringVector	get_background_ids ()
	Get all background internal IDs.
StringVector	get_evidence_ids ()
	Get all evidence internal IDs.
StringVector	get_location_ids ()
	Get all location internal IDs.
StringVector	get_audio_ids ()
	Get all audio internal IDs.
StringVector	get_testimony_ids ()
	Get all testimony internal IDs.
void	clear ()
	Clear the entire case information.
void	clear_backgrounds ()
	Clear all backgrounds.
void	clear_images ()
	Clear all images.
void	clear_characters ()
	Clear all characters.
void	clear_evidence ()
	Clear all of the evidence.
void	clear_locations ()
	Clear all locations.
void	clear_audio ()
	Clear all audio samples.
void	clear_testimonies ()
	Clear all testimonies.
CharacterMap	get_characters () const
	Get a full map of characters.
ImageMap	get_images () const
	Get a full map of images.
BackgroundMap	get_backgrounds () const
	Get a full map of backgrounds.
EvidenceMap	get_evidence () const
	Get a full map of evidence.
LocationMap	get_locations () const
	Get a full map of locations.
AudioMap	get_audio () const
	Get a full map of audio.
TestimonyMap	get_testimonies () const
	Get a full map of testimonies.
Private Attributes
Overrides	m_Overrides
	User-defined overrides.
Overview	m_Overview
	General case data.
Glib::ustring	m_InitialBlockId
	Initial text block that will be displayed when the case starts.
CharacterMap	m_Characters
	Map of characters.
ImageMap	m_Images
	Map of images.
BackgroundMap	m_Backgrounds
	Map of backgrounds.
EvidenceMap	m_Evidence
	Map of evidence.
LocationMap	m_Locations
	Map of locations.
AudioMap	m_Audio
	Map of audio.
TestimonyMap	m_Testimonies
	Map of testimonies.

---

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::set_overview

(

const Overview &

overview

)

Set the case overview.

Parameters:

overview

An Overview struct

Overview Case::Case::get_overview

(

)

const [inline]

Get the current case overview.

Returns:

The Overview struct for this case

void Case::Case::set_overrides

(

const Overrides &

ov

)

[inline]

Set the overrides for this case.

Parameters:

ov

A filled Overrides struct

Overrides Case::Case::get_overrides

(

)

const [inline]

Get the case overrides.

Returns:

The set Overrides struct

void Case::Case::set_initial_block_id

(

const Glib::ustring &

id

)

[inline]

Set the ID of the initial text block.

Parameters:

id

ID of the text block

Glib::ustring Case::Case::get_initial_block_id

(

)

const [inline]

Get the initial text block ID.

Returns:

ID of the initial text block

void Case::Case::add_character

(

const Character &

character

)

Add a character to the internal map.

Parameters:

character

The character

void Case::Case::remove_character

(

const Glib::ustring &

name

)

Remove a character based on name.

Parameters:

name

The name of the character to remove

void Case::Case::add_image

(

const Image &

image

)

Add an image to the internal map.

Parameters:

image

The image

void Case::Case::remove_image

(

const Glib::ustring &

id

)

Remove an image from the case.

Parameters:

id

The ID of the image to remove

void Case::Case::add_testimony

(

const Testimony &

testimony

)

Add a testimony to the internal map.

Parameters:

testimony

The testimony

void Case::Case::remove_testimony

(

const Glib::ustring &

id

)

Remove a testimony from the case.

Parameters:

id

ID of testimony to remove

void Case::Case::add_background

(

const Background &

bg

)

Add a background to the internal map.

Parameters:

bg

The background

void Case::Case::remove_background

(

const Glib::ustring &

id

)

Remove a background from the case.

Parameters:

id

ID of background to remove

void Case::Case::add_evidence

(

const Evidence &

evidence

)

Add a piece of evidence to the internal map.

Parameters:

evidence

The evidence

void Case::Case::remove_evidence

(

const Glib::ustring &

id

)

Remove a piece of evidence from the case.

Parameters:

id

ID of evidence to remove

void Case::Case::add_location

(

const Location &

loc

)

Add a location to the internal map.

Parameters:

loc

The location

void Case::Case::remove_location

(

const Glib::ustring &

id

)

Remove a location from the case.

Parameters:

id

ID of location

void Case::Case::add_audio

(

const Audio &

audio

)

Add an audio sample to the internal map.

Parameters:

audio

The audio sample

StringVector Case::Case::get_character_names

(

)

Get all character internal names.

Returns:

A vector with internal names

StringVector Case::Case::get_image_ids

(

)

Get all image internal IDs.

Returns:

A vector with image IDs

StringVector Case::Case::get_background_ids

(

)

Get all background internal IDs.

Returns:

A vector with background IDs

StringVector Case::Case::get_evidence_ids

(

)

Get all evidence internal IDs.

Returns:

A vector with evidence IDs

StringVector Case::Case::get_location_ids

(

)

Get all location internal IDs.

Returns:

A vector with location IDs

StringVector Case::Case::get_audio_ids

(

)

Get all audio internal IDs.

Returns:

A vector with audio IDs

StringVector Case::Case::get_testimony_ids

(

)

Get all testimony internal IDs.

Returns:

A vector with testimony IDs

CharacterMap Case::Case::get_characters

(

)

const [inline]

Get a full map of characters.

Returns:

Map of every character

ImageMap Case::Case::get_images

(

)

const [inline]

Get a full map of images.

Returns:

Map of every image

BackgroundMap Case::Case::get_backgrounds

(

)

const [inline]

Get a full map of backgrounds.

Returns:

Map of every background

EvidenceMap Case::Case::get_evidence

(

)

const [inline]

Get a full map of evidence.

Returns:

Map of every piece of evidence

LocationMap Case::Case::get_locations

(

)

const [inline]

Get a full map of locations.

Returns:

Map of every location

AudioMap Case::Case::get_audio

(

)

const [inline]

Get a full map of audio.

Returns:

Map of every audio sample

TestimonyMap Case::Case::get_testimonies

(

)

const [inline]

Get a full map of testimonies.

Returns:

Map of every testimony

---

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

• case.h
• case.cpp

---