daeIOEmpty Class Reference

#include <daeIOPlugin.h>

Inheritance diagram for daeIOEmpty:

[legend]

List of all members.

Public Member Functions
virtual daeString	getOption (daeString option)
virtual daeInt	read (const daeURI &uri, daeString docBuffer)
virtual void	setDatabase (daeDatabase *database)
virtual daeInt	setMeta (daeMetaElement *topMeta)
virtual daeInt	setOption (daeString option, daeString value)
virtual daeInt	write (const daeURI &name, daeDocument *document, daeBool replace)

---

Detailed Description

Definition at line 117 of file daeIOPlugin.h.

---

Member Function Documentation

virtual daeString daeIOEmpty::getOption

(

daeString

option

)

[inline, virtual]

getOption retrieves the value of an option from this IOPlugin. Which options a plugin supports is dependent on the plugin itself.

Parameters:

option

The option to get.

Returns:

Returns the string value of the option or NULL if option is not valid.

Implements daeIOPlugin.

Definition at line 124 of file daeIOPlugin.h.

virtual daeInt daeIOEmpty::read	(	const daeURI &	uri,
		daeString	docBuffer
	)			[inline, virtual]

Imports content into the database from an input. The input can be a file, a database or another runtime.

Parameters:

	uri	the URI of the COLLADA document to load, not all plugins accept all types of URIs, check the documentation for the IO plugin you are using.
	docBuffer	A string containing the text of the document to load. This is an optional attribute and should only be used if the document has already been loaded into memory.

Returns:

Returns DAE_OK if successfully loaded, otherwise returns a negative value defined in daeError.h.

See also:

DAE::load().

Implements daeIOPlugin.

Definition at line 121 of file daeIOPlugin.h.

virtual void daeIOEmpty::setDatabase

(

daeDatabase *

database

)

[inline, virtual]

Sets the database to use. All daeIOPlugins use the same interface to the daeDatabase, setDatabase() tells the daeIOPlugin which daeDatabase object it should use for storage and queries.

Parameters:

database

Database to set.

Implements daeIOPlugin.

Definition at line 120 of file daeIOPlugin.h.

virtual daeInt daeIOEmpty::setMeta

(

daeMetaElement *

topMeta

)

[inline, virtual]

Sets the top meta object. Called by dae::setIOPlugin() when the IO plugin changes. It passes to this function the top meta object, which is the root of a hierarchy of daeMetaElement objects. This top meta object is capable of creating any of the root objects in the DOM tree.

Parameters:

topMeta

Top meta object to use to create objects to fill the database.

Returns:

Returns DAE_OK if successful, otherwise returns a negative value defined in daeError.h.

Implements daeIOPlugin.

Definition at line 119 of file daeIOPlugin.h.

virtual daeInt daeIOEmpty::setOption	(	daeString	option,
		daeString	value
	)			[inline, virtual]

setOption allows you to set options for this IOPlugin. Which options a plugin supports is dependent on the plugin itself. There is currently no list of options that plugins are suggested to implement.

Parameters:

	option	The option to set.
	value	The value to set the option.

Returns:

Returns DAE_OK upon success.

Implements daeIOPlugin.

Definition at line 123 of file daeIOPlugin.h.

virtual daeInt daeIOEmpty::write	(	const daeURI &	name,
		daeDocument *	document,
		daeBool	replace
	)			[inline, virtual]

Writes a specific document to an output.

Parameters:

	name	URI to write the document to, not all IO plugins support all types of URIs check the documentation for the IO plugin you are using.
	document	Pointer to the document that we're going to write out.
	replace	True if write should overwrite an existing file. False otherwise.

Returns:

Returns DAE_OK if success, a negative value defined in daeError.h otherwise.

See also:

DAE::saveAs()

Implements daeIOPlugin.

Definition at line 122 of file daeIOPlugin.h.

---

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

• daeIOPlugin.h