PhosphorAnimation::ProfileTree Class Reference

Hierarchical profile storage with walk-up inheritance. More...

#include <phosphor-animation/include/PhosphorAnimation/ProfileTree.h>

Public Member Functions
	ProfileTree ()=default
	ProfileTree (const ProfileTree &)=default
ProfileTree &	operator= (const ProfileTree &)=default
	ProfileTree (ProfileTree &&)=default
ProfileTree &	operator= (ProfileTree &&)=default
Profile	resolve (const QString &path) const
	Resolve effective Profile for path (walks parents, fills defaults).
Profile	directOverride (const QString &path) const
	Direct override at path without walking parents.
bool	hasOverride (const QString &path) const
QStringList	overriddenPaths () const
	Every path with a direct override, in insertion order.
void	setOverride (const QString &path, const Profile &profile)
	Install an explicit override. Empty path is rejected (no-op).
bool	clearOverride (const QString &path)
	Remove the override at path. Returns true if one was removed.
void	clearAllOverrides ()
Profile	baseline () const
	The baseline "global" profile — always participates in resolution.
void	setBaseline (const Profile &profile)
QJsonObject	toJson () const
	Serialize the entire tree.
bool	operator== (const ProfileTree &other) const
bool	operator!= (const ProfileTree &other) const

Static Public Member Functions
static ProfileTree	fromJson (const QJsonObject &obj, const CurveRegistry &registry)
	Parse from JSON.

Detailed Description

Hierarchical profile storage with walk-up inheritance.

Sparse map from dot-paths (see ProfilePaths.h) to Profile overrides plus a baseline. resolve() walks the chain and fills library defaults. Schema-less beyond the dot-path convention — plugins add paths freely. Not internally synchronized (value type).

Constructor & Destructor Documentation

ProfileTree() [1/3]

PhosphorAnimation::ProfileTree::ProfileTree ( )

default

ProfileTree() [2/3]

PhosphorAnimation::ProfileTree::ProfileTree ( const ProfileTree &  )

default

ProfileTree() [3/3]

PhosphorAnimation::ProfileTree::ProfileTree ( ProfileTree &&  )

default

Member Function Documentation

baseline()

Profile PhosphorAnimation::ProfileTree::baseline ( ) const

inline

The baseline "global" profile — always participates in resolution.

clearAllOverrides()

void PhosphorAnimation::ProfileTree::clearAllOverrides

(

)

clearOverride()

bool PhosphorAnimation::ProfileTree::clearOverride

(

const QString &

path

)

Remove the override at path. Returns true if one was removed.

directOverride()

Profile PhosphorAnimation::ProfileTree::directOverride

(

const QString &

path

)

const

Direct override at path without walking parents.

Use hasOverride() to distinguish absent from all-unset.

fromJson()

static ProfileTree PhosphorAnimation::ProfileTree::fromJson ( const QJsonObject &  obj, const CurveRegistry &  registry  )

static

Parse from JSON.

Invalid entries fall back to default Profile; empty paths are dropped. registry forwarded to Profile::fromJson.

hasOverride()

bool PhosphorAnimation::ProfileTree::hasOverride

(

const QString &

path

)

const

operator!=()

bool PhosphorAnimation::ProfileTree::operator!= ( const ProfileTree &  other ) const

inline

operator=() [1/2]

ProfileTree & PhosphorAnimation::ProfileTree::operator= ( const ProfileTree &  )

default

operator=() [2/2]

ProfileTree & PhosphorAnimation::ProfileTree::operator= ( ProfileTree &&  )

default

operator==()

bool PhosphorAnimation::ProfileTree::operator==

(

const ProfileTree &

other

)

const

overriddenPaths()

QStringList PhosphorAnimation::ProfileTree::overriddenPaths

(

)

const

Every path with a direct override, in insertion order.

resolve()

Profile PhosphorAnimation::ProfileTree::resolve

(

const QString &

path

)

const

Resolve effective Profile for path (walks parents, fills defaults).

Curve may still be null if no chain member supplied one.

setBaseline()

void PhosphorAnimation::ProfileTree::setBaseline

(

const Profile &

profile

)

setOverride()

void PhosphorAnimation::ProfileTree::setOverride	(	const QString &	path,
		const Profile &	profile
	)

Install an explicit override. Empty path is rejected (no-op).

toJson()

QJsonObject PhosphorAnimation::ProfileTree::toJson

(

)

const

Serialize the entire tree.

Overrides stored as JSON array (not object) so insertion order round-trips losslessly.

---

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

• phosphor-animation/include/PhosphorAnimation/ProfileTree.h