RVC::LIST Class Reference

Manages RVC::OBJTYPE_GenericRef objects. More...

#include <rvc/list.h>

Inheritance diagram for RVC::LIST:

[legend]

Public Member Functions
	LIST (const RVC::LIST &obj)
	LIST ()
virtual	~LIST ()
INT32	GetItemSize (INT32 ItemNum) const
INT32	GetMaxItemSize () const
INT32	GetNumItems () const
ERRVALUE	InsertItems (INT32 StartPosn, INT32 NumItems=1)
ERRVALUE	Make (RVC::OBJITEM &ObjItem, const char Source=0, const CREDENTIALS Credentials=0)
ERRVALUE	Make (const RVC::OBJECT &parent, const RVC::DESCRIPTOR &Descriptor, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
RVC::LIST &	operator= (const RVC::LIST &rhs)
template<class _CT >
ERRVALUE	Read (INT32 ItemNum, INT32 StartPosn, INT32 Length, SIMPLE_ARRAY< _CT > &data) const
INT32	Read (INT32 ItemNum, INT32 StartPosn, INT32 Length, void *ptr) const
template<class _CT >
ERRVALUE	Read (INT32 ItemNum, DOUBLE_ARRAY< _CT > &data) const
template<class _CT >
ERRVALUE	Read (INT32 ItemNum, SIMPLE_ARRAY< _CT > &data) const
INT32	Read (INT32 ItemNum, void **buffer, INT32 BufferSize) const
INT32	Read (INT32 ItemNum, MIDOUBLEARRAY &ptr) const
INT32	Read (INT32 ItemNum, void *ptr) const
ERRVALUE	Resize (INT32 NewNumItems)
ERRVALUE	ResizeItem (INT32 ItemNum, INT32 NewItemSize)
ERRVALUE	SwapItems (INT32 Item1, INT32 Item2)
template<class _CT >
ERRVALUE	Write (INT32 ItemNum, const DOUBLE_ARRAY< _CT > &data)
template<class _CT >
ERRVALUE	Write (INT32 ItemNum, const SIMPLE_ARRAY< _CT > &data)
INT32	Write (INT32 ItemNum, INT32 TotalSize, INT32 StartPosn, INT32 Length, const void *ptr)
INT32	Write (INT32 ItemNum, INT32 Length, const void *ptr)
Protected Member Functions
ERRVALUE	Make (const OBJECT &parent, const DESCRIPTOR &Descriptor, GENLISTINFO &newinfo, int HeaderSize, int HeaderType, const CREDENTIALS *Credentials)
ERRVALUE	OpenObject (OPENMODE OpenFlags, GENLISTINFO &newinfo, int HeaderSize, int HeaderType, MDLGPARENT parent, const CREDENTIALS *Credentials)

Detailed Description

Manages RVC::OBJTYPE_GenericRef objects.

Valid parents for this class:

Constructor & Destructor Documentation

RVC::LIST::LIST ( )

Default constructor.

RVC::LIST::LIST ( const RVC::LIST & obj )

Copy constructor.

virtual RVC::LIST::~LIST ( ) [virtual]

Destructor.

Member Function Documentation

INT32 RVC::LIST::GetItemSize ( INT32 ItemNum ) const

Obtain the size of a list entry.

Returns:: List entry size

INT32 RVC::LIST::GetMaxItemSize ( ) const

Obtain the size of the largest list entry.

Returns:: Largest list entry size

INT32 RVC::LIST::GetNumItems ( ) const

Obtain the number of list entries.

Returns:: Number of list entries

ERRVALUE RVC::LIST::InsertItems	(	INT32	StartPosn,
		INT32	NumItems = `1`
	)

Inserts 1 or more entries into a generic list with each new entry initially the size of zero.

ERRVALUE RVC::LIST::Make	(	const OBJECT &	parent,
		const DESCRIPTOR &	Descriptor,
		GENLISTINFO &	newinfo,
		int	HeaderSize,
		int	HeaderType,
		const CREDENTIALS *	Credentials
	)			`[protected]`

Used for objects that inherit from this object.

ERRVALUE RVC::LIST::Make	(	RVC::OBJITEM &	ObjItem,
		const char *	Source = `0`,
		const CREDENTIALS *	Credentials = `0`
	)

Create a new rvc list object under a specified parent rvc object with name, description, and source.

Parameters:

	ObjItem	Parent object and DESCRIPTOR of object to create, new location RETURNED
	Source	Source of new list object, default is application name
	Credentials	User credentials passed in, NULL for default behavior

ERRVALUE RVC::LIST::Make	(	const RVC::OBJECT &	parent,
		const RVC::DESCRIPTOR &	Descriptor,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Create a new rvc list object under a specified parent rvc object with name, description, and source.

Parameters:

	parent	Parent object to create list object under
	Descriptor	Name of new list object
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

ERRVALUE RVC::LIST::OpenObject	(	OPENMODE	OpenFlags,
		GENLISTINFO &	newinfo,
		int	HeaderSize,
		int	HeaderType,
		MDLGPARENT	parent,
		const CREDENTIALS *	Credentials
	)			`[protected]`

Used for objects that inherit from this object.

RVC::LIST& RVC::LIST::operator= ( const RVC::LIST & rhs )

Assignment. Will close if necessary and reopen if 'rhs' is open.

Reimplemented from RVC::OBJECT.

template<class _CT >

ERRVALUE RVC::LIST::Read	(	INT32	ItemNum,
		INT32	StartPosn,
		INT32	Length,
		SIMPLE_ARRAY< _CT > &	data
	)			const `[inline]`

Read a list entry into a SIMPLE_ARRAY.

Set to correct number of items

Parameters:

Length

Length in _CT units

INT32 RVC::LIST::Read	(	INT32	ItemNum,
		INT32	StartPosn,
		INT32	Length,
		void *	ptr
	)			const

Partially read a list entry.

Returns:: Number of bytes read of the entry

template<class _CT >

ERRVALUE RVC::LIST::Read	(	INT32	ItemNum,
		DOUBLE_ARRAY< _CT > &	data
	)			const `[inline]`

Read a list entry into a DOUBLE_ARRAY.

Set to correct number of items

template<class _CT >

ERRVALUE RVC::LIST::Read	(	INT32	ItemNum,
		SIMPLE_ARRAY< _CT > &	data
	)			const `[inline]`

Read a list entry into a SIMPLE_ARRAY.

Set to correct number of items

INT32 RVC::LIST::Read	(	INT32	ItemNum,
		void **	buffer,
		INT32	BufferSize
	)			const

Read a list entry.

Returns:: Number of bytes of the entry

INT32 RVC::LIST::Read	(	INT32	ItemNum,
		MIDOUBLEARRAY &	ptr
	)			const

Read a list entry.

Returns:: Number of bytes of the entry

INT32 RVC::LIST::Read	(	INT32	ItemNum,
		void *	ptr
	)			const

Read a list entry.

Returns:: Number of bytes of the entry

ERRVALUE RVC::LIST::Resize ( INT32 NewNumItems )

Resize the list to a new number of items.

ERRVALUE RVC::LIST::ResizeItem	(	INT32	ItemNum,
		INT32	NewItemSize
	)

Resize a list item to a new size.

ERRVALUE RVC::LIST::SwapItems	(	INT32	Item1,
		INT32	Item2
	)

Swap two list items.

template<class _CT >

ERRVALUE RVC::LIST::Write	(	INT32	ItemNum,
		const DOUBLE_ARRAY< _CT > &	data
	)			`[inline]`

Write SIMPLE_ARRAY<> to a list item.

template<class _CT >

ERRVALUE RVC::LIST::Write	(	INT32	ItemNum,
		const SIMPLE_ARRAY< _CT > &	data
	)			`[inline]`

Write SIMPLE_ARRAY<> to a list item.

INT32 RVC::LIST::Write	(	INT32	ItemNum,
		INT32	TotalSize,
		INT32	StartPosn,
		INT32	Length,
		const void *	ptr
	)

Write partial data to a list item.

Returns:: Number of bytes written

INT32 RVC::LIST::Write	(	INT32	ItemNum,
		INT32	Length,
		const void *	ptr
	)

Write data to a list item.

Returns:: Number of bytes written

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

rvc/list.h

RVC::LIST Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation