tracktion::engine::ProjectItemID Class Reference

An ID representing one of the items in a Project. More...

#include "tracktion_ProjectItemID.h"

Public Member Functions
	ProjectItemID (const ProjectItemID &) noexcept=default
ProjectItemID &	operator= (const ProjectItemID &) noexcept=default
	ProjectItemID (const juce::String &stringID) noexcept
	takes a string created by toString().
	ProjectItemID (int itemID, int projectID) noexcept
	Creates an ID from the .
ProjectItemID	withNewProjectID (int newProjectID) const
int	getProjectID () const
	Returns the ID of the project this item belongs to.
int	getItemID () const
	Returns the ID of the item within the project.
int64_t	getRawID () const noexcept
	Returns a combined ID as an integer, useful for creating hashes.
bool	isValid () const noexcept
bool	isInvalid () const noexcept
juce::String	toString () const
juce::String	toStringSuitableForFilename () const
bool	operator== (ProjectItemID other) const
bool	operator!= (ProjectItemID other) const
bool	operator< (ProjectItemID other) const

Static Public Member Functions
static ProjectItemID	createNewID (int projectID) noexcept
	Generates a new ID for a given project.
static ProjectItemID	fromProperty (const juce::ValueTree &, const juce::Identifier &)

Detailed Description

An ID representing one of the items in a Project.

A ProjectItemID consists of two parts: the ID of the project it belongs to, and an ID of the item within that project.

Definition at line 20 of file tracktion_ProjectItemID.h.

Constructor & Destructor Documentation

ProjectItemID() [1/2]

tracktion::engine::ProjectItemID::ProjectItemID ( const juce::String &  stringID )

explicitnoexcept

takes a string created by toString().

Definition at line 14 of file tracktion_ProjectItemID.cpp.

ProjectItemID() [2/2]

tracktion::engine::ProjectItemID::ProjectItemID ( int  itemID, int  projectID  )

noexcept

Creates an ID from the .

Definition at line 49 of file tracktion_ProjectItemID.cpp.

Member Function Documentation

createNewID()

ProjectItemID tracktion::engine::ProjectItemID::createNewID ( int  projectID )

staticnoexcept

Generates a new ID for a given project.

Definition at line 67 of file tracktion_ProjectItemID.cpp.

fromProperty()

ProjectItemID tracktion::engine::ProjectItemID::fromProperty ( const juce::ValueTree &  v, const juce::Identifier &  prop  )

static

Definition at line 72 of file tracktion_ProjectItemID.cpp.

getItemID()

int tracktion::engine::ProjectItemID::getItemID

(

)

const

Returns the ID of the item within the project.

Definition at line 55 of file tracktion_ProjectItemID.cpp.

getProjectID()

int tracktion::engine::ProjectItemID::getProjectID

(

)

const

Returns the ID of the project this item belongs to.

Definition at line 54 of file tracktion_ProjectItemID.cpp.

getRawID()

int64_t tracktion::engine::ProjectItemID::getRawID ( ) const

noexcept

Returns a combined ID as an integer, useful for creating hashes.

Definition at line 49 of file tracktion_ProjectItemID.h.

isInvalid()

bool tracktion::engine::ProjectItemID::isInvalid ( ) const

noexcept

Definition at line 53 of file tracktion_ProjectItemID.h.

isValid()

bool tracktion::engine::ProjectItemID::isValid ( ) const

noexcept

Definition at line 52 of file tracktion_ProjectItemID.h.

operator!=()

bool tracktion::engine::ProjectItemID::operator!=

(

ProjectItemID

other

)

const

Definition at line 61 of file tracktion_ProjectItemID.h.

operator<()

bool tracktion::engine::ProjectItemID::operator<

(

ProjectItemID

other

)

const

Definition at line 62 of file tracktion_ProjectItemID.h.

operator==()

bool tracktion::engine::ProjectItemID::operator==

(

ProjectItemID

other

)

const

Definition at line 60 of file tracktion_ProjectItemID.h.

toString()

juce::String tracktion::engine::ProjectItemID::toString

(

)

const

Definition at line 57 of file tracktion_ProjectItemID.cpp.

toStringSuitableForFilename()

juce::String tracktion::engine::ProjectItemID::toStringSuitableForFilename

(

)

const

Definition at line 62 of file tracktion_ProjectItemID.cpp.

withNewProjectID()

ProjectItemID tracktion::engine::ProjectItemID::withNewProjectID

(

int

newProjectID

)

const

Definition at line 77 of file tracktion_ProjectItemID.cpp.

---

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

• tracktion_engine/project/tracktion_ProjectItemID.h
• tracktion_engine/project/tracktion_ProjectItemID.cpp