|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object model.cue.ACue
public class ACue
This class represents an individual cue. It contains the channel assignments for the cue, the cue number, name, description, fade up time, and fade down time.
Constructor Summary | |
---|---|
ACue(float _number,
String _name,
String _desc,
long _fadeUpMillis,
long _fadeDownMillis,
int _maxChannel)
This constructor will create a cue with a set number, name, description, fade up time, and fade down time. |
|
ACue(float _number,
String _name,
String _desc,
long _fadeUpMillis,
long _fadeDownMillis,
int _maxChannel,
Hashtable<Short,Channel> _channels)
This constructor will create a cue with a set number, name, description, fade up time, fade down time, and starting channel values. |
|
ACue(int _maxChannel)
This constructor creates a new cueset with the default cue 0 |
Method Summary | |
---|---|
static ACue |
extractFile(String data,
int cueMaxChannel)
This method takes in the data from a saved cue file, and returns a new cue. |
Channel[] |
getAllChannels()
This method will return the complete set of Channel objects for this cue. |
Channel |
getChannel(Channel channel)
This method will return a channel object for the given channel object address. |
Channel |
getChannel(short address)
This method will return a channel object for the given address. |
Channel[] |
getChannels()
This method will return all non-zero channels for this cue. |
Channel[] |
getChannels(short[] addresses)
This method returns an array of Channel objects for the given addresses. |
short |
getChannelValue(short address)
This method will return the value of the given channel in this cue. |
short[] |
getChannelValues(short[] addresses)
This method returns an array of channel values. |
String |
getDesc()
This method will return the cue's description. |
long |
getFadeDownMillis()
This method returns the fade down time in milliseconds. |
long |
getFadeUpMillis()
This method returns the fade up time in milliseconds. |
String |
getFileData()
This method is used for saving cues to a file. |
String |
getName()
This method will return the cue's name. |
float |
getNumber()
This method will get the cue's number. |
Channel |
getRawChannel(short address)
|
String |
getSummary()
This method returns a string containing the cue's number, fade up and fade down times, and name. |
void |
resetValues()
|
void |
setChannelValue(Channel channel)
This method will set the value of the given channel in this cue. |
void |
setChannelValue(short address,
short value)
This method will change the value of the given address to the given value. |
void |
setChannelValues(Channel[] c)
This method will set a series of channel values in the cue. |
void |
setDesc(String _desc)
This method will set the cue's description. |
void |
setFadeDownMillis(long _fadeDownMillis)
This method sets the fade down time in milliseconds. |
void |
setFadeUpMillis(long _fadeUpMillis)
This method sets the fade up time in milliseconds. |
void |
setName(String _name)
This method will set the cue's name. |
void |
setNumber(float _number)
This method will set the cue's number. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ACue(int _maxChannel)
_maxChannel
- The maximum number of channels for this cue.public ACue(float _number, String _name, String _desc, long _fadeUpMillis, long _fadeDownMillis, int _maxChannel)
_number
- The cue's number_name
- The cue's name_desc
- The cue's description_fadeUpMillis
- The fade up time for this cue, in milliseconds_fadeDownMillis
- The fade down time for this cue, in milliseconds_maxChannel
- The maximum number of channels possible for this showpublic ACue(float _number, String _name, String _desc, long _fadeUpMillis, long _fadeDownMillis, int _maxChannel, Hashtable<Short,Channel> _channels)
_number
- The cue's number_name
- The cue's name_desc
- The cue's description_fadeUpMillis
- The fade up time for this cue, in milliseconds_fadeDownMillis
- The fade down time for this cue, in milliseconds_maxChannel
- The maximum number of channels possible for this show_channels
- This hashtable contains any number of address, channel pairs with the default values for
this cue. Any channels that are not present in the hashtable will have an assumed value of 0.Method Detail |
---|
public short getChannelValue(short address)
address
- The address to return the value for
public Channel getRawChannel(short address)
public short[] getChannelValues(short[] addresses)
addresses
- The array of channel addresses to return the values for.
public Channel[] getChannels(short[] addresses)
addresses
- The addresses to return Channel objects for.
public Channel getChannel(short address)
address
- The address to return the Channel object for.
public Channel getChannel(Channel channel)
channel
- The Channel object with the address to return a Channel
object for.
public Channel[] getChannels()
public Channel[] getAllChannels()
public void setChannelValue(Channel channel)
channel
- The Channel object with the address, value pair.public void setChannelValue(short address, short value)
address
- The address to change the value at.value
- The new value of the given address.public void setChannelValues(Channel[] c)
c
- The Channel objects with the new address, value pairs.public String getName()
public void setName(String _name)
_name
- The cue's new name.public float getNumber()
public void setNumber(float _number)
_number
- The cue's number.public String getDesc()
public void setDesc(String _desc)
_desc
- The cue's new description.public String getSummary()
public long getFadeUpMillis()
public void setFadeUpMillis(long _fadeUpMillis)
_fadeUpMillis
- The fade up time in milliseconds.public long getFadeDownMillis()
public void setFadeDownMillis(long _fadeDownMillis)
_fadeDownMillis
- The fade down time in milliseconds.public String getFileData()
public static ACue extractFile(String data, int cueMaxChannel)
data
- The data from the saved cue file.int
- cueMaxChannel The maximum number of channels for this cue.
public void resetValues()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |