RVC::SCRIPT Class Reference

Interface for RVC objects that support SML query scripts. More...

#include <rvc/script.h>

Inheritance diagram for RVC::SCRIPT:

[legend]

List of all members.

Classes
class	MAKEPARMS
Public Types
enum	USAGE { USAGE_Normal = 0, USAGE_ComputedField = 1 }
Public Member Functions
	SCRIPT (const RVC::SCRIPT &rhs)
	SCRIPT ()
virtual	~SCRIPT ()
UINT32	GetFieldNumber () const
USAGE	GetUsage () const
ERRVALUE	Make (RVC::OBJITEM &ObjItem, const MAKEPARMS &MakeParms, const char *Source=0)
ERRVALUE	Make (const RVC::OBJECT &parent, const MAKEPARMS &MakeParms, const RVC::DESCRIPTOR &Descriptor)
RVC::SCRIPT &	operator= (const RVC::SCRIPT &rhs)
Static Public Member Functions
static RVC::OBJTYPESET	GetObjTypeSet ()
static bool	IsScript (RVC::OBJTYPE ObjType)

---

Detailed Description

Interface for RVC objects that support SML query scripts.

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

---

Member Enumeration Documentation

enum RVC::SCRIPT::USAGE

Enumerator:

USAGE_Normal
USAGE_ComputedField

---

Constructor & Destructor Documentation

RVC::SCRIPT::SCRIPT

(

)

Default constructor.

RVC::SCRIPT::SCRIPT

(

const RVC::SCRIPT &

rhs

)

Copy constructor.

virtual RVC::SCRIPT::~SCRIPT

(

)

[virtual]

Destructor.

---

Member Function Documentation

UINT32 RVC::SCRIPT::GetFieldNumber

(

)

const

Get the database table field number for this script.

Returns:

Database table field number for this script object

static RVC::OBJTYPESET RVC::SCRIPT::GetObjTypeSet

(

)

[static]

Get correct OBJTYPESET for all text script OBJTYPE's.

Returns:

OBJTYPESET for all text script OBJTYPE's

Reimplemented from RVC::TEXTOBJ.

USAGE RVC::SCRIPT::GetUsage

(

)

const

Get the usage for this script.

Returns:

USAGE for this script object

static bool RVC::SCRIPT::IsScript

(

RVC::OBJTYPE

ObjType

)

[static]

Determine if the object type is a script text object.

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

Create a new rvc script object.

Parameters:

	ObjItem	Parent object and DESCRIPTOR of object to create, new location RETURNED
	Source	Source of rvc text object creator, default is GetAppName()

ERRVALUE RVC::SCRIPT::Make	(	const RVC::OBJECT &	parent,
		const MAKEPARMS &	MakeParms,
		const RVC::DESCRIPTOR &	Descriptor
	)

Create a new rvc script object.

Parameters:

	parent	Parent rvc object to create text object under
	Descriptor	Name of new rvc text object

RVC::SCRIPT& RVC::SCRIPT::operator=

(

const RVC::SCRIPT &

rhs

)

Assignment.

Reimplemented from RVC::TEXTOBJ.

Reimplemented in RVC::QUERY, and RVC::SML.

---

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

• rvc/script.h