Steinberg::Vst::PresetFile Class Reference

#include <vstpresetfile.h>

List of all members.

Public Member Functions
	PresetFile (IBStream *stream)
virtual	~PresetFile ()
IBStream *	getStream ()
const FUID &	getClassID () const
void	setClassID (const FUID &uid)
const Entry *	getEntry (ChunkType which) const
const Entry *	getLastEntry () const
int32	getEntryCount () const
const Entry &	at (int32 index) const
bool	contains (ChunkType which) const
bool	readChunkList ()
bool	writeHeader ()
bool	writeChunkList ()
bool	readMetaInfo (char *xmlBuffer, int32 &size)
bool	writeMetaInfo (const char *xmlBuffer, int32 size=-1)
bool	prepareMetaInfoUpdate ()
bool	writeChunk (const void *data, int32 size, ChunkType which=kComponentState)
bool	storeComponentState (IComponent *component)
bool	restoreComponentState (IComponent *component)
bool	restoreComponentState (IEditController *editController)
bool	storeControllerState (IEditController *editController)
bool	restoreControllerState (IEditController *editController)
bool	storeProgramData (IBStream *stream, ProgramListID listID, int32 programIndex)
bool	storeProgramData (IUnitData *unitData, ProgramListID listID, int32 programIndex)
bool	restoreProgramData (IUnitData *unitData, ProgramListID *listID=0, int32 programIndex=0)
bool	restoreProgramData (IUnitInfo *unitInfo, ProgramListID listID, int32 programIndex)
Static Public Member Functions
static bool	savePreset (IBStream *stream, const FUID &classID, IComponent *component, IEditController *editController=0, const char *xmlBuffer=0, int32 xmlSize=-1)
static bool	loadPreset (IBStream *stream, const FUID &classID, IComponent *component, IEditController *editController=0)
Protected Types
	kMaxEntries = 128
enum	{ kMaxEntries = 128 }
Protected Member Functions
bool	readID (ChunkID id)
bool	writeID (const ChunkID id)
bool	readEqualID (const ChunkID id)
bool	readSize (TSize &size)
bool	writeSize (TSize size)
bool	readInt32 (int32 &value)
bool	writeInt32 (int32 value)
bool	seekTo (TSize offset)
bool	beginChunk (Entry &e, ChunkType which)
bool	endChunk (Entry &e)
Protected Attributes
IBStream *	stream
FUID	classID
Entry	entries [kMaxEntries]
int32	entryCount
Classes
struct	Entry

---

Detailed Description

Definition at line 110 of file vstpresetfile.h.

---

Member Enumeration Documentation

anonymous enum [protected]

Enumerator:

kMaxEntries

Definition at line 176 of file vstpresetfile.h.

---

Constructor & Destructor Documentation

Steinberg::Vst::PresetFile::PresetFile

(

IBStream *

stream

)

Definition at line 128 of file vstpresetfile.cpp.

Steinberg::Vst::PresetFile::~PresetFile

(

)

[virtual]

Definition at line 139 of file vstpresetfile.cpp.

---

Member Function Documentation

const Entry& Steinberg::Vst::PresetFile::at

(

int32

index

)

const [inline]

Definition at line 132 of file vstpresetfile.h.

bool Steinberg::Vst::PresetFile::beginChunk	(	Entry &	e,
		ChunkType	which
	)			[protected]

Definition at line 325 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::contains

(

ChunkType

which

)

const [inline]

Definition at line 133 of file vstpresetfile.h.

bool Steinberg::Vst::PresetFile::endChunk

(

Entry &

e

)

[protected]

Definition at line 338 of file vstpresetfile.cpp.

const FUID& Steinberg::Vst::PresetFile::getClassID

(

)

const [inline]

Definition at line 126 of file vstpresetfile.h.

const PresetFile::Entry * Steinberg::Vst::PresetFile::getEntry

(

ChunkType

which

)

const

Definition at line 146 of file vstpresetfile.cpp.

int32 Steinberg::Vst::PresetFile::getEntryCount

(

)

const [inline]

Definition at line 131 of file vstpresetfile.h.

const PresetFile::Entry * Steinberg::Vst::PresetFile::getLastEntry

(

)

const

Definition at line 156 of file vstpresetfile.cpp.

IBStream* Steinberg::Vst::PresetFile::getStream

(

)

[inline]

Definition at line 124 of file vstpresetfile.h.

bool Steinberg::Vst::PresetFile::loadPreset	(	IBStream *	stream,
		const FUID &	classID,
		IComponent *	component,
		IEditController *	editController = 0
	)			[static]

Definition at line 102 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::prepareMetaInfoUpdate

(

)

Definition at line 387 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::readChunkList

(

)

Definition at line 237 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::readEqualID

(

const ChunkID

id

)

[protected]

Definition at line 178 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::readID

(

ChunkID

id

)

[protected]

Definition at line 162 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::readInt32

(

int32 &

value

)

[protected]

Definition at line 207 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::readMetaInfo	(	char *	xmlBuffer,
		int32 &	size
	)

Definition at line 351 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::readSize

(

TSize &

size

)

[protected]

Definition at line 185 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::restoreComponentState

(

IEditController *

editController

)

Definition at line 443 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::restoreComponentState

(

IComponent *

component

)

Definition at line 435 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::restoreControllerState

(

IEditController *

editController

)

Definition at line 463 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::restoreProgramData	(	IUnitInfo *	unitInfo,
		ProgramListID	listID,
		int32	programIndex
	)

Definition at line 528 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::restoreProgramData	(	IUnitData *	unitData,
		ProgramListID *	listID = 0,
		int32	programIndex = 0
	)

Definition at line 511 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::savePreset	(	IBStream *	stream,
		const FUID &	classID,
		IComponent *	component,
		IEditController *	editController = 0,
		const char *	xmlBuffer = 0,
		int32	xmlSize = -1
	)			[static]

Definition at line 80 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::seekTo

(

TSize

offset

)

[protected]

Definition at line 229 of file vstpresetfile.cpp.

void Steinberg::Vst::PresetFile::setClassID

(

const FUID &

uid

)

[inline]

Definition at line 127 of file vstpresetfile.h.

bool Steinberg::Vst::PresetFile::storeComponentState

(

IComponent *

component

)

Definition at line 423 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::storeControllerState

(

IEditController *

editController

)

Definition at line 451 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::storeProgramData	(	IUnitData *	unitData,
		ProgramListID	listID,
		int32	programIndex
	)

Definition at line 498 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::storeProgramData	(	IBStream *	stream,
		ProgramListID	listID,
		int32	programIndex
	)

Definition at line 471 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::writeChunk	(	const void *	data,
		int32	size,
		ChunkType	which = kComponentState
	)

Definition at line 411 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::writeChunkList

(

)

Definition at line 297 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::writeHeader

(

)

Definition at line 282 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::writeID

(

const ChunkID

id

)

[protected]

Definition at line 170 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::writeInt32

(

int32

value

)

[protected]

Definition at line 218 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::writeMetaInfo	(	const char *	xmlBuffer,
		int32	size = -1
	)

Definition at line 372 of file vstpresetfile.cpp.

bool Steinberg::Vst::PresetFile::writeSize

(

TSize

size

)

[protected]

Definition at line 196 of file vstpresetfile.cpp.

---

Member Data Documentation

FUID Steinberg::Vst::PresetFile::classID [protected]

Definition at line 175 of file vstpresetfile.h.

Entry Steinberg::Vst::PresetFile::entries[kMaxEntries] [protected]

Definition at line 177 of file vstpresetfile.h.

int32 Steinberg::Vst::PresetFile::entryCount [protected]

Definition at line 178 of file vstpresetfile.h.

IBStream* Steinberg::Vst::PresetFile::stream [protected]

Definition at line 174 of file vstpresetfile.h.

---

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

• vstpresetfile.h
• vstpresetfile.cpp

---

Copyright ©2008 Steinberg Media Technologies. All Rights Reserved.