RVC::BINARY Class Reference

Manages RVC::OBJTYPE_GenericRef RVC objects. More...

#include <rvc/binary.h>

Inheritance diagram for RVC::BINARY:

[legend]

List of all members.

Public Member Functions
	BINARY (const RVC::BINARY &obj)
	BINARY ()
virtual	~BINARY ()
bool	IsInverted () const
ERRVALUE	Make (RVC::OBJITEM &ObjItem, const char *Source=0, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE	Make (const RVC::OBJECT &parent, const RVC::DESCRIPTOR &Descriptor, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
RVC::BINARY &	operator= (const RVC::BINARY &rhs)
ERRVALUE	Read (SIMPLE_ARRAY< UINT8 > &data) const
ERRVALUE	Write (const void *const data, INT32 NumBytes)
ERRVALUE	Write (const SIMPLE_ARRAY< UINT8 > &data)
Protected Member Functions
ERRVALUE	Make (const OBJECT &parent, OBJMAKEPARMS &ObjMakeParms)

---

Detailed Description

Manages RVC::OBJTYPE_GenericRef RVC objects.

RVC Object Types that this class supports: RVC::OBJTYPE_GenericRef.

Default RVC Object Type for this class: RVC::OBJTYPE_GenericRef.

Valid parents for this class:

• RVC::OBJTYPE_File
• RVC::OBJTYPE_Folder

---

Constructor & Destructor Documentation

RVC::BINARY::BINARY

(

)

Default constructor.

RVC::BINARY::BINARY

(

const RVC::BINARY &

obj

)

Copy constructor.

virtual RVC::BINARY::~BINARY

(

)

[virtual]

Destructor.

---

Member Function Documentation

bool RVC::BINARY::IsInverted

(

)

const

Determine whether or not object is byte order inverted.

Returns:

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

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

Used for objects that inherit from this object.

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

Make a child rvc binary object from a given RVCOBJITEM.

Parameters:

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

Reimplemented in RVC::ICMPROFILE.

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

Make a child rvc binary object from a given parent with a name and description.

Parameters:

RVC_DEFAULT_CREDENTIALS

User credentials passed in, NULL for default behavior

Reimplemented in RVC::ICMPROFILE.

RVC::BINARY& RVC::BINARY::operator=

(

const RVC::BINARY &

rhs

)

Assignment.

Reimplemented from RVC::OBJECT.

Reimplemented in RVC::ICMPROFILE.

ERRVALUE RVC::BINARY::Read

(

SIMPLE_ARRAY< UINT8 > &

data

)

const

Read binary object into a simple array.

ERRVALUE RVC::BINARY::Write	(	const void *const	data,
		INT32	NumBytes
	)

Write binary object from a void pointer and number of bytes Will overwrite existing data and resize object to 'NumBytes'.

ERRVALUE RVC::BINARY::Write

(

const SIMPLE_ARRAY< UINT8 > &

data

)

Write binary object from a simple array Will overwrite existing data and resize object to 'data.GetNumItems()'.

---

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

• rvc/binary.h