smtk::model::ArrangementReference Class Reference

A simple structure that robustly references an arrangement. More...

#include <Arrangement.h>

Collaboration diagram for smtk::model::ArrangementReference:

Public Member Functions
	ArrangementReference (const smtk::common::UUID &entId, ArrangementKind k, int idx)
	Construct a valid reference.
	ArrangementReference ()=default
	Construct an invalid reference.
bool	isValid () const
	Indicate whether a reference is valid or not:

Public Attributes
smtk::common::UUID	entityId
	The ID of the entity on which the arrangement is defined.
ArrangementKind	kind { KINDS_OF_ARRANGEMENTS }
	The kind of the arrangement.
int	index { -1 }
	The index of the arrangement.

Detailed Description

A simple structure that robustly references an arrangement.

This is more robust than pointers or iterators into instances of UUIDsToArrangements objects, since these are invalidated by modifications to arrangements.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/latest/smtk/model/Arrangement.h