A PianodAlbum that is self-contained, unrelated to artists, songs, or playlists Encapsulated albums may not be needed; may not occur with services. More...

#include <encapmusic.h>

Inheritance diagram for PersistentAlbum:

[legend]

Collaboration diagram for PersistentAlbum:

[legend]

Public Member Functions
	PersistentAlbum (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...

	EncapsulatedAlbum (Media::Source *const owner, Type item_type=Type::Album)

Public Member Functions inherited from EncapsulatedAlbum
	EncapsulatedAlbum (Media::Source *const owner, Type item_type=Type::Album)

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

virtual const std::string &	albumId (void) const override
	Item's album ID. More...

virtual const std::string &	albumTitle (void) const override

virtual const std::string &	coverArtUrl (void) const override

void	artistId (const std::string &a)

void	artistId (const char *a)

void	artist (const std::string &a)

void	artist (const char *a)

void	albumId (const std::string &a)

void	albumId (const char *a)

void	albumTitle (const std::string &t)

void	albumTitle (const char *t)

void	coverArtUrl (const std::string &u)

void	coverArtUrl (const char *u)

Public Member Functions inherited from PianodAlbum
virtual const std::string	id (void) const override
	Primary ID is album ID. 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::Thingie &	transmitCommon (Football::Thingie &recipient) const override
	Typecode for album type. More...

virtual PianodConnection &	transmitPrivate (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 PianodArtist *	asArtist () override

virtual const PianodArtist *	asArtist () const override

virtual PianodAlbum *	asAlbum () override final

virtual const PianodAlbum *	asAlbum () const override final

virtual bool	compilation () const

virtual bool	operator== (const std::string &compare) const override
	Is album a compilation? 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 PianodSong *	asSong ()

virtual PianodPlaylist *	asPlaylist ()

virtual const PianodSong *	asSong () const

virtual const PianodPlaylist *	asPlaylist () 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 Ownership *	parentOwner (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 PianodAlbum
static Type	typetype (void)
	Typecode for album objects. 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 MusicThingie
virtual	~MusicThingie (void)

Detailed Description

A PianodAlbum that is self-contained, unrelated to artists, songs, or playlists Encapsulated albums may not be needed; may not occur with services.

Constructor & Destructor Documentation

◆ PersistentAlbum()

PersistentAlbum::PersistentAlbum	(	Media::Source *const	owner,
		Type	type,
		const Parsnip::Data &	data
	)

Reconstruct a song from our persistence format.

Here is the call graph for this function:

Member Function Documentation

◆ EncapsulatedAlbum()

EncapsulatedAlbum::EncapsulatedAlbum

inline

◆ persist()

Parsnip::Data PersistentAlbum::persist ( void ) const

virtual

Assemble the song details for serialization.

Here is the call graph for this function:

Here is the caller graph for this function:

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

songs/encapmusic.h
songs/encapmusic.cpp