Main Page   Namespace List   Class Hierarchy   Compound List   File List   Compound Members   File Members  

Timeline Class Reference

#include <Timeline.h>

Collaboration diagram for Timeline:

Collaboration graph
[legend]
List of all members.

Public Methods

 Timeline (const Id &id)
 Constructor. More...

 ~Timeline ()
 Destructor. More...

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

IdSet getSignals () const
 Get signal Ids. More...

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. More...

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

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

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

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

StringSet getFeatureNames ()
void setFeatures (Features features)
Features getFeatures ()
void unsetFeatures ()
list<string> storeSQLs (AGSetId id)
 Create list of SQLs used to save the timeline to the DB server. More...

string toString ()
 Dump the timeline in AIF format. More...


Detailed Description

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


Constructor & Destructor Documentation

Timeline::Timeline ( const Id & id )
 

Constructor.

Timeline::~Timeline ( )
 

Destructor.


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)

void Timeline::deleteFeature ( FeatureName featureName )
 

Delete the specified feature in the metadata.

void Timeline::deleteSignal ( Signal * signal )
 

Remove a signal from the timeline.

bool Timeline::existsFeature ( FeatureName featureName )
 

Test if a feature exists in the metadata.

string Timeline::getFeature ( FeatureName featureName )
 

Get the value of the specified feature in the metadata.

StringSet Timeline::getFeatureNames ( )
 

Get feature names in the metadata

Returns:
string set which contains all the feature names

Features Timeline::getFeatures ( )
 

Get all the features in a single string. returns all features in a single string in Dublin Core Structured Values DCSV (Cox & Iannella) format. For example, "name=Stone Philips;phone=(215)555-8888;age=40"

Note:
see http://dublincore.org/documents/2000/07/28/dcmi-dcsv/ for details about DCSV format.

const Id Timeline::getId ( ) const [inline]
 

Get the id of the timeline.

IdSet Timeline::getSignals ( ) const
 

Get signal Ids.

void Timeline::setFeature ( FeatureName featureName,
FeatureValue featureValue )
 

Set the value of a feature in the metadata.

void Timeline::setFeatures ( Features features )
 

Set multiple features in a single string. Set multiple features in a single string in Dublin Core Structured Values DCSV (Cox & Iannella) format. For example, "name=Stone Philips;phone=(215)555-8888;age=40"

Note:
see http://dublincore.org/documents/2000/07/28/dcmi-dcsv/ for details about DCSV format.

list< string > Timeline::storeSQLs ( AGSetId id )
 

Create list of SQLs used to save the timeline to the DB server.

string Timeline::toString ( )
 

Dump the timeline in AIF format.

void Timeline::unsetFeatures ( )
 

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


The documentation for this class was generated from the following file:
Generated at Wed Jul 3 14:55:58 2002 for Annotation Graph API by doxygen1.2.7 written by Dimitri van Heesch, © 1997-2001