RVC::ARRAY Class Reference

Manages OBJTYPE_GenericRef RVC objects. More...

#include <rvc/array.h>

Inheritance diagram for RVC::ARRAY:

[legend]

List of all members.

Classes
class	MAKEPARMS
	Base class for ARRAY MAKEPARMS. More...
Public Member Functions
	ARRAY (const RVC::ARRAY &obj)
	ARRAY ()
virtual	~ARRAY ()
template<class _CT >
INT32	Append (const _CT &item)
INT32	GetItemSize () const
INT32	GetNumItems () const
bool	IsInverted () const
ERRVALUE	Make (RVC::OBJITEM &ObjItem, const MAKEPARMS &MakeParms, const char *Source=0, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE	Make (const RVC::OBJECT &parent, const RVC::DESCRIPTOR &Descriptor, const MAKEPARMS &MakeParms, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
RVC::ARRAY &	operator= (const RVC::ARRAY &rhs)
INT32	Read (INT32 ItemNum, void *ptr) const
ERRVALUE	Resize (INT32 NewNumItems)
INT32	Write (INT32 ItemNum, const void *ptr)
Protected Member Functions
ERRVALUE	Make (const RVC::OBJECT &parent, OBJMAKEPARMS &ObjMakeParms)
ERRVALUE	OpenObject (OPENMODE OpenFlags, ARRAYINFO &newinfo, int HeaderSize, int HeaderType, MDLGPARENT parent, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
virtual ERRVALUE	v_OpenObject (OPENMODE OpenFlags, MDLGPARENT parent, const CREDENTIALS *Credentials)

---

Detailed Description

Manages OBJTYPE_GenericRef RVC objects.

The interface currently wraps the MfArray functions.

RVC Object Types that this class supports: OBJTYPE_GenericRef.

Default RVC Object Type for this class: OBJTYPE_GenericRef.

Valid parents for this class:

• OBJTYPE_File
• OBJTYPE_Folder

---

Constructor & Destructor Documentation

RVC::ARRAY::ARRAY

(

)

Default constructor.

RVC::ARRAY::ARRAY

(

const RVC::ARRAY &

obj

)

Copy constructor.

virtual RVC::ARRAY::~ARRAY

(

)

[virtual]

Destructor.

---

Member Function Documentation

template<class _CT >

INT32 RVC::ARRAY::Append

(

const _CT &

item

)

[inline]

Append an item to the ARRAY.

Returns:

Index to the appended item in the ARRAY

INT32 RVC::ARRAY::GetItemSize

(

)

const [inline]

Obtain the size of a array entry.

Returns:

List entry size

INT32 RVC::ARRAY::GetNumItems

(

)

const

Obtain the number of array entries.

Returns:

Number of array entries

bool RVC::ARRAY::IsInverted

(

)

const

Determine whether or not object is byte order inverted.

Returns:

True' if the object need to be inverted (SwapBytes())

ERRVALUE RVC::ARRAY::Make	(	const RVC::OBJECT &	parent,
		OBJMAKEPARMS &	ObjMakeParms
	)			[protected]

Used for objects that inherit from this object.

ERRVALUE RVC::ARRAY::Make	(	RVC::OBJITEM &	ObjItem,
		const MAKEPARMS &	MakeParms,
		const char *	Source = 0,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Create a new rvc array object under a specified parent rvc object RVC::OBJITEM.

Parameters:

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

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

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

Parameters:

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

ERRVALUE RVC::ARRAY::OpenObject	(	OPENMODE	OpenFlags,
		ARRAYINFO &	newinfo,
		int	HeaderSize,
		int	HeaderType,
		MDLGPARENT	parent,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)			[protected]

Used for objects that inherit from this object.

Parameters:

	OpenFlags	Open the raster object
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

RVC::ARRAY& RVC::ARRAY::operator=

(

const RVC::ARRAY &

rhs

)

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

Reimplemented from RVC::OBJECT.

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

Read a array entry.

Returns:

Number of bytes of the entry

ERRVALUE RVC::ARRAY::Resize

(

INT32

NewNumItems

)

Resize the array to a new number of items.

virtual ERRVALUE RVC::ARRAY::v_OpenObject	(	OPENMODE	OpenMode,
		MDLGPARENT	parent,
		const CREDENTIALS *	Credentials
	)			[protected, virtual]

Called by the Open() methods to open an rvc object.

If the derived class retains an open state with the rvc object, then the derived class MUST support this method The default behaviour is to return (0).

If this method is supported, then the derived class must support CloseObject() and IsObjectOpen().

Reimplemented from RVC::OBJECT.

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

Write data to a array item.

Returns:

Number of bytes written

---

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

• rvc/array.h