RVC::SIMPLE Class Reference

Interface for RVC objects that support a Read Once, Write Once paradigm. More...

#include <rvc/simple.h>

Inheritance diagram for RVC::SIMPLE:

[legend]

Public Member Functions
	SIMPLE (const RVC::SIMPLE &rhs)
	SIMPLE ()
virtual	~SIMPLE ()=0
ERRVALUE	GetDftNameDesc (const RVC::OBJECT &ParentObject, RVC::DESCRIPTOR &Descriptor)
ERRVALUE	GetDftNameDesc (const RVC::OBJITEM &ParentObjItem, RVC::DESCRIPTOR &Descriptor)
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)
ERRVALUE	Make (const RVC::OBJECT &parent, const char Source=0, const CREDENTIALS Credentials=0)
RVC::SIMPLE &	operator= (const RVC::SIMPLE &rhs)
ERRVALUE	Read (const RVC::OBJECT &source, const MIUNICODE filename, const MISTRING &ObjectPath, const CREDENTIALS Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE	Read (const RVC::OBJITEM &ObjItem, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE	Read (const RVC::OBJECT &parent, const RVC::DESCRIPTOR &Descriptor, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
DEPRECATED ERRVALUE	Read (const RVC::OBJECT &parent, const RVC::OBJECTNAME &name, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE	Read (const RVC::OBJECT &object, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE	Read (const FILEPATH &filepath, const MISTRING &ObjectPath, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE	Read (const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE	Write (const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
Private Member Functions
virtual ERRVALUE	v_GetDftNameDesc (const OBJECT &parent, DESCRIPTOR &Descriptor)=0
virtual ERRVALUE	v_MakeData (RVC::OBJMAKEPARMS &ObjMakeParms)=0
virtual ERRVALUE	v_ReadData (RVC::OBJOPENPARMS &ObjOpenParms)=0
virtual ERRVALUE	v_WriteData (RVC::OBJOPENPARMS &ObjOpenParms)=0

Detailed Description

Interface for RVC objects that support a Read Once, Write Once paradigm.

Derived classes do not open / close the rvc object.

This class inherits from RVC::OBJECT

RVC Object Types that this class supports: Derived class

Default RVC Object Type for this class: Derived class

Valid parents for this class: Derived class

Constructor & Destructor Documentation

RVC::SIMPLE::SIMPLE ( )

Default Constructor.

RVC::SIMPLE::SIMPLE ( const RVC::SIMPLE & rhs )

Copy constructor.

virtual RVC::SIMPLE::~SIMPLE ( ) [pure virtual]

Destructor, pure virtual.

Member Function Documentation

ERRVALUE RVC::SIMPLE::GetDftNameDesc	(	const RVC::OBJECT &	ParentObject,
		RVC::DESCRIPTOR &	Descriptor
	)

Obtain default name and description information from derived class.

Parameters:

	ParentObject	Parent rvc object
	Descriptor	Default generated descriptor RETURNED

ERRVALUE RVC::SIMPLE::GetDftNameDesc	(	const RVC::OBJITEM &	ParentObjItem,
		RVC::DESCRIPTOR &	Descriptor
	)

Obtain default name and description information from derived class.

Parameters:

	ParentObjItem	Parent rvc object item
	Descriptor	Default generated descriptor RETURNED

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

Create new rvc object of derived class type with given OBJITEM.

This method will attach this instance to the parent of the ObjItem after writing the data. This instance file handle will be closed

Parameters:

	ObjItem	Parent object and DESCRIPTOR of object to create, new location RETURNED
	Source	Who created this rvc object, 0 to use result from GetAppName()
	Credentials	User credentials passed in, NULL for default behavior

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

Create new rvc object of derived class type with given name and desc.

This method will attach this instance to the rvc object after writing the data. This instance file handle will be closed

Parameters:

	parent	Parent rvc object to create derived class under
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

ERRVALUE RVC::SIMPLE::Make	(	const RVC::OBJECT &	parent,
		const char *	Source = `0`,
		const CREDENTIALS *	Credentials = `0`
	)

Create new rvc object of derived class type using default name and desc.

This method will attach this instance to the rvc object after writing the data. This instance file handle will be closed

Parameters:

	parent	Parent rvc object to create derived class under
	Source	Who created this rvc object, 0 to use result from GetAppName()
	Credentials	User credentials passed in, NULL for default behavior

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

Assignment.

Parameters:

rhs

Assignment operator

Reimplemented from RVC::OBJECT.

Reimplemented in NAMEDREGION, RVC::ASSOCIATION, RVC::CAMERACALIB, RVC::COLORMAP, RVC::CONTRAST, RVC::DBCONSTRAINT, RVC::DBFORM, RVC::EDITPARM, RVC::FREQPROC, RVC::GEOREFERENCE, RVC::HYPERSENSOR, RVC::INITEXT, RVC::PRINTER_COLOR_BALANCE, RVC::RASTERSENSOR, RVC::RASTERTHEMEPARM, RVC::RASTERTREND, RVC::REGION, RVC::SPATIALFILTER, RVC::THEMEPARM, and RVC::TIEPOINTOBJ.

ERRVALUE RVC::SIMPLE::Read	(	const RVC::OBJECT &	source,
		const MIUNICODE *	filename,
		const MISTRING &	ObjectPath,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Read data from found rvc object, data stored in derived class.

This method will open the file, if not open already, and after reading the data, close its instance of the file. If the file was in this instance open before the call, this method still closes the file. This is by design.

Parameters:

	source	Source rvc object used if 'filename' is a relative path
	filename	Full or relative path to the rvc file to open
	ObjectPath	Full name of rvc object obtained from GetObjectPath()
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

ERRVALUE RVC::SIMPLE::Read	(	const RVC::OBJITEM &	ObjItem,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Read data from defined rvc object, data stored in derived class.

This method will open the file, if not open already, and after reading the data, close its instance of the file. If the file was in this instance open before the call, this method still closes the file. This is by design.

Parameters:

	ObjItem	This contains the file and rvc object location information
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

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

Read data from found rvc object, data stored in derived class.

This method will open the file, if not open already, and after reading the data, close its instance of the file. If the file was in this instance open before the call, this method still closes the file. This is by design.

Parameters:

	parent	Parent rvc object
	Descriptor	Name of rvc object to locate and read from
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

DEPRECATED ERRVALUE RVC::SIMPLE::Read	(	const RVC::OBJECT &	parent,
		const RVC::OBJECTNAME &	name,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Read data from found rvc object, data stored in derived class.

This method will open the file, if not open already, and after reading the data, close its instance of the file. If the file was in this instance open before the call, this method still closes the file. This is by design.

Deprecated:: Use the method that takes a DESCRIPTOR

Parameters:

	parent	Parent rvc object
	name	Name of rvc object to locate and read from
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

ERRVALUE RVC::SIMPLE::Read	(	const RVC::OBJECT &	object,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Read data from rvc object, data stored in derived class.

This method will open the file, if not open already, and after reading the data, close its instance of the file. If the file was open in this instance before the call, this method still closes the file. This is by design.

Parameters:

	object	RVC Object to read data from
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

ERRVALUE RVC::SIMPLE::Read	(	const FILEPATH &	filepath,
		const MISTRING &	ObjectPath,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Read data from named rvc object, data stored in derived class.

This method will open the file, if not open already, and after reading the data, close its instance of the file. If the file was open before the call, this method still closes the file. This is by design.

Parameters:

	filepath	Path to RVC file
	ObjectPath	Path to requested rvc object
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

ERRVALUE RVC::SIMPLE::Read ( const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS )

Read data from rvc object, data stored in derived class.

This method will open the file, if not open already, and after reading the data, close its instance of the file. If the file was open before the call, this method still closes the file. This is by design.

Parameters:

RVC_DEFAULT_CREDENTIALS

User credentials passed in, NULL for default behavior

virtual ERRVALUE RVC::SIMPLE::v_GetDftNameDesc	(	const OBJECT &	parent,
		DESCRIPTOR &	Descriptor
	)			`[private, pure virtual]`

Obtain default name and description information from derived class.

Parameters:

parent

Parent rvc object to create derived class under

virtual ERRVALUE RVC::SIMPLE::v_MakeData ( RVC::OBJMAKEPARMS & ObjMakeParms ) [private, pure virtual]

Parameters:

ObjMakeParms

Make specific data method for derived classes

Implemented in RVC::INITEXT.

virtual ERRVALUE RVC::SIMPLE::v_ReadData ( RVC::OBJOPENPARMS & ObjOpenParms ) [private, pure virtual]

Parameters:

ObjOpenParms

Read specific data method for derived classes

Implemented in RVC::INITEXT.

virtual ERRVALUE RVC::SIMPLE::v_WriteData ( RVC::OBJOPENPARMS & ObjOpenParms ) [private, pure virtual]

Parameters:

ObjOpenParms

Write specific data method for derived classes

Implemented in RVC::INITEXT.

ERRVALUE RVC::SIMPLE::Write ( const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS )

Overwrite existing derived class type with current information.

This method will open the file, if not open already, and after writing the data, close its instance of the file. If the file was open in this instance before the call, this method still closes the file. This is by design.

Parameters:

RVC_DEFAULT_CREDENTIALS

User credentials passed in, NULL for default behavior

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

rvc/simple.h

RVC::SIMPLE Class Reference

Public Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation