AtomObject Struct Reference

#include <atom.hpp>

Classes
class	iterator

Public Member Functions
	AtomObject (const void *atom)
	AtomObject (ForgeRef ref)
	AtomObject (const AtomObject &other)
uint32_t	otype () const
uint32_t	id () const
uint32_t	total_size () const
void	query (ObjectQuery &query)
LV2_Atom_Object *	cobj () const
	operator LV2_Atom_Object * ()
AtomObject &	operator= (const AtomObject &other)
iterator	begin () const
iterator	end () const

Detailed Description

Basic wrapper for an LV2_Atom_Object This class is intended to be created on the stack

Constructor & Destructor Documentation

AtomObject ( const void *  atom )

inline

Create an AtomObject from raw data

AtomObject ( ForgeRef  ref )

inline

Create an AtomObject from a ForgeRef

Member Function Documentation

LV2_Atom_Object* cobj ( ) const

inline

Get the underlying LV2_Atom_Object pointer

uint32_t id ( ) const

inline

Return the object's id

uint32_t otype ( ) const

inline

Return the object type

void query ( ObjectQuery &  query )

inline

Get an object's values for various keys.

The value pointer of each item in query will be set to the location of the corresponding value in object. Every value pointer in query MUST be initialised to NULL. This function reads object in a single linear sweep. By allocating query on the stack, objects can be "queried" quickly without allocating any memory. This method is realtime safe.

This function can only do "flat" queries, it is not smart enough to match variables in nested objects.

uint32_t total_size ( ) const

inline

Return the object's total size

---

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

• atom.hpp