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

Signal Class Reference

#include <Signal.h>

Collaboration diagram for Signal:

Collaboration graph
[legend]
List of all members.

Public Methods

 Signal (const Id id, string xlinkHref, MimeClass mimeClass, MimeType mimeType, Encoding encoding, Unit unit, Track track="")
 Create a signal. More...

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

const MimeClass getMimeClass () const
 Get the mimeclass of the signal. More...

const MimeType getMimeType () const
 Get the mimetype of the signal. More...

const Encoding getEncoding () const
 Get the encoding of the signal. More...

const string getXlinkHref () const
 Get the xlink:href of the signal. More...

const string getXlinkType () const
 Get the xlink:type of the signal. More...

const Unit getUnit () const
 Get the unit of the signal. More...

const Track getTrack () const
 Get the track of the signal. 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 agSetId, TimelineId timelineId)
 Create list of SQLs used to save the signal to the DB server. More...

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


Detailed Description

Signal is the thing to be annotated, it can be audio, video, or text.
Version:
1.3 September 21, 2001
Author(s):
Xiaoyi Ma


Constructor & Destructor Documentation

Signal::Signal ( const Id id,
string xlinkHref,
MimeClass mimeClass,
MimeType mimeType,
Encoding encoding,
Unit unit,
Track track = "" )
 

Create a signal.


Member Function Documentation

void Signal::deleteFeature ( FeatureName featureName )
 

Delete the specified feature in the metadata.

bool Signal::existsFeature ( FeatureName featureName )
 

Test if a feature exists in the metadata.

const Encoding Signal::getEncoding ( ) const
 

Get the encoding of the signal.

string Signal::getFeature ( FeatureName featureName )
 

Get the value of the specified feature in the metadata.

StringSet Signal::getFeatureNames ( )
 

Get feature names in the metadata

Returns:
string set which contains all the feature names

Features Signal::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 Signal::getId ( ) const
 

Get the id of the signal.

const MimeClass Signal::getMimeClass ( ) const
 

Get the mimeclass of the signal.

const MimeType Signal::getMimeType ( ) const
 

Get the mimetype of the signal.

const Track Signal::getTrack ( ) const
 

Get the track of the signal.

const Unit Signal::getUnit ( ) const
 

Get the unit of the signal.

const string Signal::getXlinkHref ( ) const
 

Get the xlink:href of the signal.

const string Signal::getXlinkType ( ) const
 

Get the xlink:type of the signal.

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

Set the value of a feature in the metadata.

void Signal::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 > Signal::storeSQLs ( AGSetId agSetId,
TimelineId timelineId )
 

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

string Signal::toString ( )
 

Dump the signal in AIF format.

void Signal::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:46 2002 for Annotation Graph API by doxygen1.2.7 written by Dimitri van Heesch, © 1997-2001