RVC::ARRAY Class Reference

Manages OBJTYPE_GenericRef RVC objects. More...

#include <rvc/array.h>

Inheritance diagram for RVC::ARRAY:

[legend]List of all members.

Public Member Functions
	ARRAY (const RVC::ARRAY &obj)
	ARRAY ()
INT32	GetItemSize () const
INT32	GetNumItems () const
bool	IsInverted () const
ERRVALUE	Make (const RVC::OBJITEM &ObjItem, const MAKEPARMS &MakeParms, const char *Source=0)
ERRVALUE	Make (const RVC::OBJECT &parent, const RVC::OBJECTNAME &name, const RVC::OBJECTDESC &desc, const MAKEPARMS &MakeParms, const char *Source=0)
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)
virtual	~ARRAY ()
Protected Member Functions
ERRVALUE	Make (const RVC::OBJECT &parent, const RVC::OBJECTNAME &name, const RVC::OBJECTDESC &desc, RVCARRAYINFO &newinfo, int HeaderSize, int HeaderType, const char *Source=0)
ERRVALUE	OpenObject (OPENMODE OpenFlags, RVCARRAYINFO &newinfo, int HeaderSize, int HeaderType, MDLGPARENT parent)
virtual ERRVALUE	v_OpenObject (OPENMODE OpenFlags, MDLGPARENT parent)

---

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

Definition at line 73 of file array.h.

---

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

INT32 RVC::ARRAY::GetItemSize (   )  const [inline]

Obtain the size of a array entry. Returns: List entry size Definition at line 99 of file array.h.

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, const RVC::OBJECTNAME &  name, const RVC::OBJECTDESC &  desc, RVCARRAYINFO &  newinfo, int  HeaderSize, int  HeaderType, const char *  Source = 0 )  [protected]

Used for objects that inherit from this object. Parameters: Source  Source of new array object, default is application name

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

Create a new rvc array object under a specified parent rvc object RVC::OBJITEM. Parameters: ObjItem  Parent object to create array object under Source  Source of new array object, default is application name

ERRVALUE RVC::ARRAY::Make (  const RVC::OBJECT &  parent, const RVC::OBJECTNAME &  name, const RVC::OBJECTDESC &  desc, const MAKEPARMS &  MakeParms, const char *  Source = 0 )

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 name  Name of new array object desc  Description of new array object Source  Source of new array object, default is application name

ERRVALUE RVC::ARRAY::OpenObject (  OPENMODE  OpenFlags, RVCARRAYINFO &  newinfo, int  HeaderSize, int  HeaderType, MDLGPARENT  parent )  [protected]

Used for objects that inherit from this object. Parameters: OpenFlags  Open the raster object

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

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

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  OpenFlags, MDLGPARENT  parent )  [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

---