oasys::MultiTypeDurableTable< _BaseType, _Collection > Class Template Reference

#include <DurableStore.h>

Inheritance diagram for oasys::MultiTypeDurableTable< _BaseType, _Collection >:

List of all members.

---

Detailed Description

template<typename _BaseType, typename _Collection>
class oasys::MultiTypeDurableTable< _BaseType, _Collection >

Class for a durable table that can store various objects, each a subclass of _BaseType which must in turn be or be a subclass of TypedSerializableObject, and that has a type code defined in the template parameter _Collection.

Definition at line 613 of file DurableStore.h.

Public Member Functions
	MultiTypeDurableTable (DurableTableImpl *impl, const std::string &name, DurableObjectCache< _BaseType > *cache)
	Constructor.
int	put (const SerializableObject &key, TypeCollection::TypeCode_t type, const _BaseType *data, int flags)
	Update the value of the key, data pair in the database.
int	get (const SerializableObject &key, _BaseType **data, bool *from_cache=0)
	Get the data for key, possibly creating a new object of the given template type _Type (or some derivative), using the multitype collection specified by _Collection.
Static Public Member Functions
static int	new_object (TypeCollection::TypeCode_t typecode, SerializableObject **generic_object)
	Object allocation callback that is handed to the implementation to allow it to properly create an object once it extracts the type code.
Private Member Functions
	MultiTypeDurableTable (const MultiTypeDurableTable &)

---

Constructor & Destructor Documentation

template<typename _BaseType, typename _Collection>

oasys::MultiTypeDurableTable< _BaseType, _Collection >::MultiTypeDurableTable	(	DurableTableImpl *	impl,
		const std::string &	name,
		DurableObjectCache< _BaseType > *	cache
	)			[inline]

Constructor.

Definition at line 618 of file DurableStore.h.

template<typename _BaseType, typename _Collection>

oasys::MultiTypeDurableTable< _BaseType, _Collection >::MultiTypeDurableTable

(

const MultiTypeDurableTable< _BaseType, _Collection > &

)

[private]

---

Member Function Documentation

template<typename _BaseType, typename _Collection>

int MultiTypeDurableTable< _BaseType, _Collection >::put	(	const SerializableObject &	key,
		TypeCollection::TypeCode_t	type,
		const _BaseType *	data,
		int	flags
	)			[inline]

Update the value of the key, data pair in the database.

It should already exist.

Parameters:

	key	Key object
	type	Type code for the object
	data	Data object
	flags	Bit vector of DurableStoreFlags_t values.

Returns:

DS_OK, DS_NOTFOUND, DS_ERR

Definition at line 1128 of file DurableStore.h.

template<typename _BaseType, typename _Collection>

int MultiTypeDurableTable< _BaseType, _Collection >::get	(	const SerializableObject &	key,
		_BaseType **	data,
		bool *	from_cache = 0
	)			[inline]

Get the data for key, possibly creating a new object of the given template type _Type (or some derivative), using the multitype collection specified by _Collection.

_Type therefore must be a valid superclass for the object identified by the type code in the database.

Parameters:

	key	Key object
	data	Data object
	from_cache	== true if the object retrieved from the cache

Returns:

DS_OK, DS_NOTFOUND if key is not found

Definition at line 1063 of file DurableStore.h.

template<typename _BaseType, typename _Collection>

int MultiTypeDurableTable< _BaseType, _Collection >::new_object	(	TypeCollection::TypeCode_t	typecode,
		SerializableObject **	generic_object
	)			[inline, static]

Object allocation callback that is handed to the implementation to allow it to properly create an object once it extracts the type code.

Definition at line 1109 of file DurableStore.h.

---

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

• DurableStore.h

---