---

skRValue Class Reference

This class is used to hold the value of a variable in Simkin. More...

#include <skRValue.h>

Inheritance diagram for skRValue:

List of all members.

Public Types
enum	RType
	An RValue has a value of one of these types: Executable object, String, integer, float or character.
Public Member Functions
	skRValue ()
	Default Constructor - creates a blank string object.
IMPORT_C	skRValue (const skRValue &)
	Copy Constructor - copies type and value from the other object.
void	assignObject (skiExecutable *object, bool created=false)
	Assign an executable object.
	skRValue (const skString &s)
	Constructor with a string.
	skRValue (Char c)
	Constructor with a character.
	skRValue (int n)
	Constructor with an integer.
	skRValue (unsigned int n)
	Constructor with an unsigned integer.
	skRValue (float f)
	Constructor with a float.
virtual	~skRValue ()
	Destructor - will delete an associated object if the created flag is set in constructor.
IMPORT_C skRValue &	operator= (const skRValue &v)
	Assigment operator - clears this value, and then assigns type and value.
IMPORT_C skRValue &	operator= (bool value)
	Assigment operator - clears this value, and then assigns boolean value.
IMPORT_C skRValue &	operator= (const skString &value)
	Assigment operator - clears this value, and then assigns string value.
IMPORT_C skRValue &	operator= (int value)
	Assigment operator - clears this value, and then assigns integer value.
IMPORT_C skRValue &	operator= (float value)
	Assigment operator - clears this value, and then assigns float value.
IMPORT_C skRValue &	operator= (Char value)
	Assigment operator - clears this value, and then assigns character value.
IMPORT_C bool	operator== (const skRValue &)
	returns true if the other value is equal to this one.
IMPORT_C Char	charValue () const
	returns a character representation of the value, converting if necessary
IMPORT_C bool	boolValue () const
	returns a boolean representation of the value, converting if necessary
IMPORT_C int	intValue () const
	returns an integer representation of the value, converting if necessary
IMPORT_C float	floatValue () const
	returns a float representation of the value, converting if necessary
IMPORT_C skString	str () const
	returns a string representation of the value, converting if necessary
skiExecutable *	obj () const
	returns the object associated with this RValue, or 0 if there is none
RType	type () const
	returns the type of the value held in this RValue - one of the enumerated RType
	operator TCleanupItem ()
	Conversion operator to Symbian TCleanupItem.
Static Public Member Functions
void	Cleanup (TAny *s)
	Called via Symbian CleanupStack in the event of a leave.

---

Detailed Description

This class is used to hold the value of a variable in Simkin.

It can hold reference counts for objects and delete them when these reach zero.

---

Member Function Documentation

void skRValue::assignObject (  skiExecutable *  object, bool  created = false )  [inline]

Assign an executable object. Parameters: object  - the object to be associated with the RValue created  - set this to true if you want the object to be deleted once all references have reached zero Exceptions: Symbian  - a leaving function

void skRValue::Cleanup (  TAny *  s  )  [inline, static]

Called via Symbian CleanupStack in the event of a leave. This calls the deRef method in the object Remarks: only available in Symbian version

skRValue::operator TCleanupItem (   )  [inline]

Conversion operator to Symbian TCleanupItem. This is provided to allow this object to be pushed by value onto the Symbian Cleanup Stack Remarks: only available in Symbian version

IMPORT_C bool skRValue::operator== (  const skRValue &   )

returns true if the other value is equal to this one. Comparison depends on the types held in each value.

---

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

• skRValue.h

---