Main Page   Class Hierarchy   Compound List   Compound Members  

Timeline Class Reference

List of all members.

Public Methods

 Timeline (const Id &id)
 Constructor.

 ~Timeline ()
 Destructor.

const Id getId () const
 Get the id of the timeline.

set< SignalId > getSignals () const
 Get signal Ids.

SignalId createSignal (Id id, string xlinkHref, MimeClass mimeClass, MimeType mimeType, Encoding encoding, Unit unit, string track) throw (AGException)
void deleteSignal (Signal *signal)
 Remove a signal from the timeline.

void setFeature (FeatureName featureName, FeatureValue featureValue)
 Set the value of a feature in the metadata.

bool existsFeature (FeatureName featureName)
 Test if a feature exists in the metadata.

void deleteFeature (FeatureName featureName)
 Delete the specified feature in the metadata.

string getFeature (FeatureName featureName)
 Get the value of the specified feature in the metadata.

set< string > getFeatureNames ()
void setFeatures (map< string, string > &features)
map< string, string > getFeatures ()
void unsetFeatures ()
list< string > storeSQLs (AGSetId id)
 Create list of SQLs used to save the timeline to the DB server.

string toString ()
 Dump the timeline in AIF format.


Detailed Description

Timeline is a set of signals.
Version:
1.3 September 21, 2001
Author:
Xiaoyi Ma


Member Function Documentation

SignalId Timeline::createSignal Id    id,
string    xlinkHref,
MimeClass    mimeClass,
MimeType    mimeType,
Encoding    encoding,
Unit    unit,
string    track
throw (AGException)
 

Create a new signal and add it to the timeline.

Parameters:
id  might be TimelineId or SignalId. If id is a TimelineId, an SignalId will be assigned to new Signal. If id is a SignalId, it will try the given id first, if it's taken, assign a new SignalId.
Returns:
SignalId of the new signal.
Exceptions:
AGException  IF (the id given is invalid)

set<string> Timeline::getFeatureNames  
 

Get feature names in the metadata

Returns:
string set which contains all the feature names

map<string,string> Timeline::getFeatures   [inline]
 

Get all the features in a hash table of feature-value pairs.

void Timeline::setFeatures map< string, string > &    features [inline]
 

Set multiple features in a hash table of feature-value pairs.

void Timeline::unsetFeatures  
 

Unset all features in the metadata Set all the features to empty string.