Bridges-C++  3.4.2
Bridges(C++ API)
Public Member Functions | List of all members
bridges::dataset::Song Class Reference

#include <Song.h>

Detailed Description

A Song object, used along with the Songs data source.

This is a convenience class provided for users who wish to use this data source as part of their application. It provides an API that makes it easy to access the attributes of this data set.

The Song object is typically obtained from calling bridges::DataSource::getSongData() or bridges::DataSource::getSong().

See also
Refer to tutorial for example of using this feature: https://bridgesuncc.github.io/tutorials/Data_Song_Lyrics.html
Author
David Burlinson, C++ port: Kalpathi Subramanian
Date
5/24/18

Public Member Functions

 Song ()
 
 Song (const string &artist, const string &song, const string &album, const string &lyrics, const string &release_date)
 Song constructor. More...
 
string getArtist () const
 
void setArtist (const string &artist)
 
string getSongTitle () const
 
void setSongTitle (const string &song)
 
string getAlbumTitle () const
 
void setAlbumTitle (const string &album)
 
string getLyrics () const
 
void setLyrics (const string &lyrics)
 
string getReleaseDate () const
 
void setReleaseDate (const string &release_date)
 

Constructor & Destructor Documentation

◆ Song() [1/2]

bridges::dataset::Song::Song ( )
inline

Default constructor

◆ Song() [2/2]

bridges::dataset::Song::Song ( const string &  artist,
const string &  song,
const string &  album,
const string &  lyrics,
const string &  release_date 
)
inline

Song constructor.

Parameters
artistartist of song
songsong title
albumalbum title
lyricslyrics of song (string)
release_datedate released

Member Function Documentation

◆ getAlbumTitle()

string bridges::dataset::Song::getAlbumTitle ( ) const
inline

Get album title containing the song

Returns
album title (string)

◆ getArtist()

string bridges::dataset::Song::getArtist ( ) const
inline

Get song artist

Returns
artist of song

◆ getLyrics()

string bridges::dataset::Song::getLyrics ( ) const
inline

Get lyrics of the song

Returns
lyrics of song (string)

◆ getReleaseDate()

string bridges::dataset::Song::getReleaseDate ( ) const
inline

Get release date of the song

Returns
release date of song (string)

◆ getSongTitle()

string bridges::dataset::Song::getSongTitle ( ) const
inline

Get song title

Returns
title of song (string)

◆ setAlbumTitle()

void bridges::dataset::Song::setAlbumTitle ( const string &  album)
inline

Set song album

Parameters
albumsong album to set

◆ setArtist()

void bridges::dataset::Song::setArtist ( const string &  artist)
inline

Set song artist

Parameters
artistartist to set

◆ setLyrics()

void bridges::dataset::Song::setLyrics ( const string &  lyrics)
inline

Set song lyrics

Parameters
lyricsof song to set

◆ setReleaseDate()

void bridges::dataset::Song::setReleaseDate ( const string &  release_date)
inline

Set release date of song

Parameters
release_datedate of release to set

◆ setSongTitle()

void bridges::dataset::Song::setSongTitle ( const string &  song)
inline

Set song title

Parameters
songsong title to set

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