pianod2
multisource multiuser scriptable networked music player
Public Member Functions | List of all members
Pandora::ArtistSuggestion Class Reference

An artist contructed from search results. More...

#include <pandoratypes.h>

Inheritance diagram for Pandora::ArtistSuggestion:
Inheritance graph
[legend]
Collaboration diagram for Pandora::ArtistSuggestion:
Collaboration graph
[legend]

Public Member Functions

 ArtistSuggestion (Source *const owner, const Parsnip::Data &message)
 
- Public Member Functions inherited from Pandora::Artist
 Artist (Source *const owner)
 
 Artist (Source *const owner, MusicThingie::Type type, const Parsnip::Data &message)
 
- Public Member Functions inherited from PersistentArtist
 PersistentArtist (Media::Source *const owner, Type type, const Parsnip::Data &data)
 Reconstruct a song from our persistence format. More...
 
virtual Parsnip::Data persist () const
 Assemble the song details for serialization. More...
 
 EncapsulatedArtist (Media::Source *const owner, Type type=Type::Artist)
 
- Public Member Functions inherited from EncapsulatedArtist
 EncapsulatedArtist (Media::Source *const owner, Type type=Type::Artist)
 
virtual Type type (void) const override
 Return the type letter for a thingie. More...
 
virtual Media::Source *const source (void) const override
 MediaSource from which this thingie originates. More...
 
virtual const std::string & artistId (void) const override
 Item's artist ID. More...
 
virtual const std::string & artist (void) const override
 Get artist name. More...
 
void artistId (const std::string &a)
 
void artistId (const char *a)
 
void artist (const std::string &a)
 
void artist (const char *a)
 
- Public Member Functions inherited from PianodArtist
virtual const std::string id (void) const override
 Get primary ID with media manager ID on it. More...
 
virtual const std::string id (MusicThingie::Type type) const override
 Return the complete ID when used in a specific context. More...
 
virtual const std::string & internalId (MusicThingie::Type type) const override
 Return the inner ID when used in a specific context. More...
 
virtual const std::string & name (void) const override
 Return the most specific name of this, whatever type it is. More...
 
virtual Football::ThingietransmitCommon (Football::Thingie &recipient) const override
 Typecode for artist type. More...
 
virtual PianodConnectiontransmitPrivate (PianodConnection &recipient) const override
 Transmit the thingie's user-specific data on a connection. More...
 
virtual Parsnip::Data serialize () const override
 Assemble the thingie's data for JSON tranmission. More...
 
virtual void serializePrivate (Parsnip::Data &, const User *user) const override
 Add the thingie's user-specific data for JSON transmission. More...
 
virtual bool matches (const Filter &filter) const override
 Check if a filter matches this item. More...
 
virtual PianodArtistasArtist () override
 
virtual const PianodArtistasArtist () const override
 
virtual bool operator== (const std::string &compare) const override
 See if the artist has a certain name. More...
 
virtual bool operator== (const MusicThingie &compare) const override
 Compare artist's name to that of an artist/album/song. More...
 
- Public Member Functions inherited from MusicThingie
 MusicThingie (void)
 When allocated, use count starts at 1 and the object is put in the release pool, justifying its existence. More...
 
bool isPrimary (void) const
 
bool isSuggestion (void) const
 
bool isSeed (void) const
 
bool isPlaylist (void) const
 
bool isSong (void) const
 
bool isAlbum (void) const
 
bool isArtist (void) const
 
bool isValidType (void) const
 
Type primaryType (void) const
 
virtual bool canQueue () const
 Indicate if specific item can be queued/requested. More...
 
virtual PianodAlbumasAlbum ()
 
virtual PianodSongasSong ()
 
virtual PianodPlaylistasPlaylist ()
 
virtual const PianodAlbumasAlbum () const
 
virtual const PianodSongasSong () const
 
virtual const PianodPlaylistasPlaylist () const
 
std::string operator() (void) const
 
void retain (void) const
 Claim an instance. More...
 
void release (void)
 Abandon an instance. More...
 
int getUseCount (void) const
 
virtual OwnershipparentOwner (void) const
 Defer the ownership to the source. More...
 
void serializeCommon (Parsnip::Data &) const
 Insert common items into the serialization dictionary. More...
 
bool operator!= (const std::string &compare)
 
bool operator!= (const MusicThingie &compare)
 
virtual SongList songs ()
 Retrieve a list of requestable songs applicable to this thingie. More...
 
- Public Member Functions inherited from SubordinateOwnership
virtual bool isOwnedBy (const User *user) const override
 
virtual bool hasPermission (const User *user, Action action) const override
 
- Public Member Functions inherited from Ownership
bool isVisibleBy (const User *user) const
 
bool isUsableBy (const User *user) const
 
bool isDecendableBy (const User *user) const
 
bool isReadableBy (const User *user) const
 
bool isEditableBy (const User *user) const
 

Additional Inherited Members

- Public Types inherited from MusicThingie
enum class  Type : char {
  Playlist = 'p' , Artist = 'a' , Album = 'l' , Song = 's' ,
  PlaylistSuggestion = 'e' , ArtistSuggestion = 't' , AlbumSuggestion = 'b' , SongSuggestion = 'n' ,
  PlaylistSeed = 'y' , ArtistSeed = 'd' , AlbumSeed = 'u' , SongSeed = 'g' ,
  SongRating = 'i'
}
 
- Public Types inherited from Ownership
enum class  Type {
  DISOWNED , PRIVATE , SHARED , PUBLISHED ,
  PUBLIC
}
 Access levels for an object. More...
 
enum class  Action { SEE , USE , READ , ALTER }
 Access actions for an object. More...
 
- Static Public Member Functions inherited from PianodArtist
static Type typetype (void)
 Typecode for artist objects. More...
 
- Static Public Member Functions inherited from MusicThingie
static std::string TypeName (Type type)
 Get the type name of a music thingie. More...
 
static Type TypeFromName (const std::string &name)
 
static constexpr bool isPrimary (Type t)
 
static constexpr bool isSuggestion (const Type t)
 
static constexpr bool isSeed (const Type t)
 
static constexpr bool isPlaylist (const Type t)
 
static constexpr bool isSong (const Type t)
 
static constexpr bool isAlbum (const Type t)
 
static constexpr bool isArtist (const Type t)
 
static constexpr bool isValidType (const Type t)
 
static Type primaryType (const Type t)
 
- Protected Member Functions inherited from Pandora::Artist
Source *const pandora () const
 
- Protected Member Functions inherited from MusicThingie
virtual ~MusicThingie (void)
 

Detailed Description

An artist contructed from search results.

Constructor & Destructor Documentation

◆ ArtistSuggestion()

Pandora::ArtistSuggestion::ArtistSuggestion ( Source *const  owner,
const Parsnip::Data message 
)
Here is the call graph for this function:

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