vrv::PlistInterface Class Reference

This class is an interface for elements having a single time point, such as tempo, reh, etc. More...

#include <plistinterface.h>

Inheritance diagram for vrv::PlistInterface:

Public Member Functions
void	AddRef (const std::string &ref)
	Add a reference ref to the AttPlist vector (if not already there)
void	AddRefAllowDuplicate (const std::string &ref)
	Add a reference, not checking if it is already in the list (for expansion@plist).
void	SetRef (const Object *object)
	Set a reference object when the id is found in the m_ids. More...
Constructors, destructors, reset methods
Reset method reset all attribute classes
	PlistInterface ()
virtual	~PlistInterface ()
void	Reset () override
	Virtual reset method. More...
InterfaceId	IsInterface () const override
	Virtual method returning the InterfaceId of the interface. More...
ArrayOfObjects	GetRefs ()
	Retrieve all reference objects.
const ArrayOfConstObjects &	GetRefs () const
FunctorCode	InterfacePreparePlist (PreparePlistFunctor &functor, Object *object)
	We have functor code in the interface for avoiding code duplication in each implementation class. More...
FunctorCode	InterfaceResetData (ResetDataFunctor &functor, Object *object)
Public Member Functions inherited from vrv::Interface
void	RegisterInterfaceAttClass (AttClassId attClassId)
	Method for registering an MEI att classes in the interface.
std::vector< AttClassId > *	GetAttClasses ()
	Method for obtaining a pointer to the attribute class vector of the interface.
	Interface ()
virtual	~Interface ()

Protected Member Functions
void	SetIDStrs ()
	Extract the fragment of the any URIs given in @plist.
virtual bool	IsValidRef (const Object *ref) const
	Method to be redefined in the child class if specific validation is required. More...

Detailed Description

This class is an interface for elements having a single time point, such as tempo, reh, etc.

It is not an abstract class but should not be instantiated directly.

Member Function Documentation

InterfacePreparePlist()

FunctorCode vrv::PlistInterface::InterfacePreparePlist	(	PreparePlistFunctor &	functor,
		Object *	object
	)

We have functor code in the interface for avoiding code duplication in each implementation class.

Since we are in an interface, we need to pass the object (implementation) to the pseudo functor method.

IsInterface()

InterfaceId vrv::PlistInterface::IsInterface ( ) const

inlineoverridevirtual

Virtual method returning the InterfaceId of the interface.

Needs to be overridden in child classes.

Reimplemented from vrv::Interface.

IsValidRef()

virtual bool vrv::PlistInterface::IsValidRef ( const Object *  ref ) const

inlineprotectedvirtual

Method to be redefined in the child class if specific validation is required.

The method is called from PlistInterface::SetRef

Reimplemented in vrv::Arpeg.

Reset()

void vrv::PlistInterface::Reset ( )

overridevirtual

Virtual reset method.

Needs to be overridden in child classes.

Reimplemented from vrv::Interface.

SetRef()

void vrv::PlistInterface::SetRef

(

const Object *

object

)

Set a reference object when the id is found in the m_ids.

Calls IsValidRef to check that the type of object is valid.

---

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

• plistinterface.h