Lumiverse  2.5
A framework for creating lighting control applications
Public Member Functions | Private Attributes | List of all members
Lumiverse::ShowControl::CueList Class Reference
Collaboration diagram for Lumiverse::ShowControl::CueList:
Collaboration graph
[legend]

Public Member Functions

 CueList (string name, Playback *pb)
 Make a new empty cue list.
 
 CueList (JSONNode node, Playback *pb)
 Load a CueList from a JSON node.
 
bool storeCue (float num, string cueID, bool overwrite=false)
 
void deleteCue (float num, bool totalDelete=false)
 
const map< float, string > & getCueList ()
 
float getFirstCueNum ()
 Gets the number of the first cue. More...
 
string getFirstCue ()
 
float getLastCueNum ()
 Gets the number of the last cue. More...
 
string getLastCue ()
 
CuegetCue (float num)
 
string getCueName (float num)
 
string getNextCue (float num)
 
float getNextCueNum (float num)
 
string getPrevCue (float num)
 Gets the previous cue in the list. More...
 
float getPrevCueNum (float num)
 Gets the number of the previous cue in the list. More...
 
float getCueNumAtIndex (int index)
 
void setName (string name)
 Sets the name of the cue list.
 
string getName ()
 Gets the name of the cue list.
 
JSONNode toJSON ()
 Returns the JSON representation of the cue list.
 

Private Attributes

map< float, string > _cues
 
string _name
 Name of the list.
 
Playback_pb
 Pointer to Playback object that contains the actual cue data.
 

Member Function Documentation

float Lumiverse::ShowControl::CueList::getFirstCueNum ( )

Gets the number of the first cue.

If no cues exist, this returns 0.

float Lumiverse::ShowControl::CueList::getLastCueNum ( )

Gets the number of the last cue.

If no cues exist, this returns 0.

string Lumiverse::ShowControl::CueList::getPrevCue ( float  num)

Gets the previous cue in the list.

Parameters
numCue to start search at.
Returns
Pointer to previous cue in the list from cue num.
float Lumiverse::ShowControl::CueList::getPrevCueNum ( float  num)

Gets the number of the previous cue in the list.

Parameters
numCue to start search at.
Returns
Number of previous cue in the list.

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