Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

MusicPlayList Class Reference

A List containing several tracks of music. More...

#include <music.h>

List of all members.

Public Member Functions

const ASCStringgetName ()
void runTextIO (PropertyContainer &pc)
 loads a PlayList from a .ASCTXT file
void reset ()
 resets the internal track iterator
const ASCStringgetNextTrack ()
 returns the filename of the next music track
void read (tnstream &stream)
void write (tnstream &stream) const
ASCString getDiagnosticText ()

Public Attributes

ASCString filename
ASCString location


Detailed Description

A List containing several tracks of music.

Definition at line 19 of file music.h.


Member Function Documentation

ASCString MusicPlayList::getDiagnosticText  ) 
 

Definition at line 117 of file music.cpp.

References location.

Referenced by SoundSystem::getDiagnosticText().

const ASCString& MusicPlayList::getName  )  [inline]
 

Definition at line 31 of file music.h.

const ASCString & MusicPlayList::getNextTrack  ) 
 

returns the filename of the next music track

Definition at line 79 of file music.cpp.

References reset().

void MusicPlayList::read tnstream stream  ) 
 

Definition at line 58 of file music.cpp.

References fatalError(), filename, location, readClassContainer(), tnstream::readInt(), tnstream::readString(), and reset().

void MusicPlayList::reset  ) 
 

resets the internal track iterator

Definition at line 92 of file music.cpp.

References displayLogMessage(), filename, tfindfile::getnextname(), location, and pathdelimitterstring.

Referenced by getNextTrack(), read(), and runTextIO().

void MusicPlayList::runTextIO PropertyContainer pc  ) 
 

loads a PlayList from a .ASCTXT file

Definition at line 47 of file music.cpp.

References PropertyContainer::addString(), PropertyContainer::addStringArray(), displayLogMessage(), and reset().

Referenced by PlayListLoader::readTextFiles().

void MusicPlayList::write tnstream stream  )  const
 

Definition at line 69 of file music.cpp.

References filename, location, writeClassContainer(), tnstream::writeInt(), and tnstream::writeString().


Member Data Documentation

ASCString MusicPlayList::filename
 

Definition at line 31 of file music.h.

Referenced by read(), PlayListLoader::readTextFiles(), reset(), and write().

ASCString MusicPlayList::location
 

Definition at line 31 of file music.h.

Referenced by getDiagnosticText(), read(), PlayListLoader::readTextFiles(), reset(), and write().


The documentation for this class was generated from the following files:
Generated on Tue Jun 24 02:18:32 2008 for Advanced Strategic Command by  doxygen 1.4.2