AtomForge Class Reference

#include <atom.hpp>

Collaboration diagram for AtomForge:

Public Member Functions
	AtomForge ()
	AtomForge (LV2_URID_Map *map)
void	init (LV2_URID_Map *map)
LV2_Atom_Forge *	cobj ()
ForgeRef	sequence_head (ForgeFrame &frame, uint32_t unit)
	operator LV2_Atom_Forge * ()
void	set_buffer (uint8_t *buf, uint32_t size)
ForgeRef	beat_time (double beats)
ForgeRef	frame_time (int64_t frames)
ForgeRef	property_head (uint32_t key, uint32_t context)
void	pop (ForgeFrame &frame)
ForgeRef	write_atom (uint32_t size, uint32_t type)
ForgeRef	write_path (const std::string &path)
ForgeRef	write_resource (ForgeFrame &frame, uint32_t id, uint32_t otype)
ForgeRef	write_blank (ForgeFrame &frame, uint32_t id, uint32_t otype)
ForgeRef	write_bool (const bool val)
ForgeRef	write_int (const int val)
ForgeRef	write_float (const float val)
ForgeRef	write_long (const int64_t val)
ForgeRef	write_string (const char *str)
ForgeRef	write_uri (const char *uri)
ForgeRef	write_raw (const void *data, uint32_t size)
ForgeRef	write_urid (LV2_URID id)

Detailed Description

Class wrapper around LV2_Atom_Forge

Constructor & Destructor Documentation

AtomForge ( )

inline

Uninitialized AtomForge.

Note

Client code must call AtomForge::init() before using otherwise written output will be unpredictable

AtomForge ( LV2_URID_Map *  map )

inline

Initialized AtomForge.

Parameters

map	The LV2_URID_Map to use for initialization

Member Function Documentation

ForgeRef beat_time ( double  beats )

inline

Forge frame time (in a sequence)

LV2_Atom_Forge* cobj ( )

inline

Get the underlying atom forge

Returns

The forge

ForgeRef frame_time ( int64_t  frames )

inline

Forge frame time (in a sequence). The returned ForgeRef is to an LV2_Atom_Event

void init ( LV2_URID_Map *  map )

inline

Initialize the underlying atom forge

Parameters

map	The mapping function needed for init

void pop ( ForgeFrame &  frame )

inline

Pop a forge frame

Parameters

frame

The frame to pop

ForgeRef property_head ( uint32_t  key, uint32_t  context  )

inline

Forge a property header

Parameters

key	The URID for the key
context	The context

ForgeRef sequence_head ( ForgeFrame &  frame, uint32_t  unit  )

inline

Forge the header of a sequence

void set_buffer ( uint8_t *  buf, uint32_t  size  )

inline

Set the forge's buffer

Parameters

buf	The buffer to use
size	The size of the buffer

ForgeRef write_atom ( uint32_t  size, uint32_t  type  )

inline

Write an atom header

Parameters

size	The atom's body size
type	The atom's body type

Returns

A reference to the written atom

ForgeRef write_blank ( ForgeFrame &  frame, uint32_t  id, uint32_t  otype  )

inline

Forge a blank object

Parameters

frame
id
otype

ForgeRef write_bool ( const bool  val )

inline

Forge a boolean value

Parameters

val	The value to write

ForgeRef write_float ( const float  val )

inline

Forge a float value

Parameters

val	The value to write

ForgeRef write_int ( const int  val )

inline

Forge an integeger value

Parameters

val	The value to write

ForgeRef write_long ( const int64_t  val )

inline

Forge a long integer value

Parameters

val	The value to write

ForgeRef write_path ( const std::string &  path )

inline

Write an atom path from string

Parameters

path	The path to forge

Returns

An Atom

ForgeRef write_raw ( const void *  data, uint32_t  size  )

inline

Forge raw data

Parameters

data	The data to write
size	The size in bytes of data

ForgeRef write_resource ( ForgeFrame &  frame, uint32_t  id, uint32_t  otype  )

inline

Forge an atom resource

Parameters

frame
id
otype

Returns

A reference to the Atom

ForgeRef write_string ( const char *  str )

inline

Forge a string value

Parameters

val	The value to write

ForgeRef write_uri ( const char *  uri )

inline

Forge a uri value

Parameters

val	The value to write

ForgeRef write_urid ( LV2_URID  id )

inline

Forge a URID value

Parameters

id	The URID to write

---

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

• atom.hpp