Sfs2X::Entities::Variables::Variable Class Reference

The Variable interface defines all the default public methods and properties that an object representing a SmartFoxServer Variable exposes. More...

#include <Variable.h>

Inheritance diagram for Sfs2X::Entities::Variables::Variable:

Public Member Functions
virtual boost::shared_ptr< string >	Name ()=0
	Indicates the name of this variable. More...
virtual VariableType	Type ()=0
	Indicates the type of this variable. More...
virtual boost::shared_ptr< void >	Value ()=0
	Returns the untyped value of this variable. More...
virtual boost::shared_ptr< bool >	GetBoolValue ()=0
	Retrieves the value of a boolean variable. More...
virtual boost::shared_ptr< long int >	GetIntValue ()=0
	Retrieves the value of an integer variable. More...
virtual boost::shared_ptr< double >	GetDoubleValue ()=0
	Retrieves the value of a double precision variable. More...
virtual boost::shared_ptr< string >	GetStringValue ()=0
	Retrieves the value of a string variable. More...
virtual boost::shared_ptr< ISFSObject >	GetSFSObjectValue ()=0
	Retrieves the value of a SFSObject variable. More...
virtual boost::shared_ptr< ISFSArray >	GetSFSArrayValue ()=0
	Retrieves the value of a SFSArray variable. More...
virtual bool	IsNull ()=0
	Indicates if the variable is null. More...
virtual boost::shared_ptr< ISFSArray >	ToSFSArray ()=0
	<exclude>

Detailed Description

The Variable interface defines all the default public methods and properties that an object representing a SmartFoxServer Variable exposes.

Member Function Documentation

GetBoolValue()

virtual boost::shared_ptr<bool> Sfs2X::Entities::Variables::Variable::GetBoolValue ( )

pure virtual

Retrieves the value of a boolean variable.

Returns

The variable value as a boolean.

Implemented in Sfs2X::Entities::Variables::SFSUserVariable, Sfs2X::Entities::Variables::SFSRoomVariable, Sfs2X::Entities::Variables::SFSBuddyVariable, Sfs2X::Entities::Variables::BaseVariable, and Sfs2X::Entities::Variables::MMOItemVariable.

GetDoubleValue()

virtual boost::shared_ptr<double> Sfs2X::Entities::Variables::Variable::GetDoubleValue ( )

pure virtual

Retrieves the value of a double precision variable.

Returns

The variable value as a double.

Implemented in Sfs2X::Entities::Variables::SFSUserVariable, Sfs2X::Entities::Variables::SFSRoomVariable, Sfs2X::Entities::Variables::SFSBuddyVariable, Sfs2X::Entities::Variables::BaseVariable, and Sfs2X::Entities::Variables::MMOItemVariable.

GetIntValue()

virtual boost::shared_ptr<long int> Sfs2X::Entities::Variables::Variable::GetIntValue ( )

pure virtual

Retrieves the value of an integer variable.

Returns

The variable value as an integer.

Implemented in Sfs2X::Entities::Variables::SFSUserVariable, Sfs2X::Entities::Variables::SFSRoomVariable, Sfs2X::Entities::Variables::SFSBuddyVariable, Sfs2X::Entities::Variables::BaseVariable, and Sfs2X::Entities::Variables::MMOItemVariable.

GetSFSArrayValue()

virtual boost::shared_ptr<ISFSArray> Sfs2X::Entities::Variables::Variable::GetSFSArrayValue ( )

pure virtual

Retrieves the value of a SFSArray variable.

Returns

The variable value as an object implementing the ISFSArray interface.

See also

SFSArray

Implemented in Sfs2X::Entities::Variables::SFSUserVariable, Sfs2X::Entities::Variables::SFSRoomVariable, Sfs2X::Entities::Variables::SFSBuddyVariable, Sfs2X::Entities::Variables::BaseVariable, and Sfs2X::Entities::Variables::MMOItemVariable.

GetSFSObjectValue()

virtual boost::shared_ptr<ISFSObject> Sfs2X::Entities::Variables::Variable::GetSFSObjectValue ( )

pure virtual

Retrieves the value of a SFSObject variable.

Returns

The variable value as an object implementing the ISFSObject interface.

See also

SFSObject

Implemented in Sfs2X::Entities::Variables::SFSUserVariable, Sfs2X::Entities::Variables::SFSRoomVariable, Sfs2X::Entities::Variables::SFSBuddyVariable, Sfs2X::Entities::Variables::BaseVariable, and Sfs2X::Entities::Variables::MMOItemVariable.

GetStringValue()

virtual boost::shared_ptr<string> Sfs2X::Entities::Variables::Variable::GetStringValue ( )

pure virtual

Retrieves the value of a string variable.

Returns

The variable value as a string.

Implemented in Sfs2X::Entities::Variables::SFSUserVariable, Sfs2X::Entities::Variables::SFSRoomVariable, Sfs2X::Entities::Variables::SFSBuddyVariable, Sfs2X::Entities::Variables::BaseVariable, and Sfs2X::Entities::Variables::MMOItemVariable.

IsNull()

virtual bool Sfs2X::Entities::Variables::Variable::IsNull ( )

pure virtual

Indicates if the variable is null.

Returns

true if the variable has a null value.

Implemented in Sfs2X::Entities::Variables::SFSUserVariable, Sfs2X::Entities::Variables::SFSRoomVariable, Sfs2X::Entities::Variables::SFSBuddyVariable, Sfs2X::Entities::Variables::BaseVariable, and Sfs2X::Entities::Variables::MMOItemVariable.

Name()

virtual boost::shared_ptr<string> Sfs2X::Entities::Variables::Variable::Name ( )

pure virtual

Indicates the name of this variable.

Implemented in Sfs2X::Entities::Variables::SFSUserVariable, Sfs2X::Entities::Variables::SFSRoomVariable, Sfs2X::Entities::Variables::SFSBuddyVariable, Sfs2X::Entities::Variables::BaseVariable, and Sfs2X::Entities::Variables::MMOItemVariable.

Type()

virtual VariableType Sfs2X::Entities::Variables::Variable::Type ( )

pure virtual

Indicates the type of this variable.

See also

VariableType

Implemented in Sfs2X::Entities::Variables::SFSUserVariable, Sfs2X::Entities::Variables::SFSRoomVariable, Sfs2X::Entities::Variables::SFSBuddyVariable, Sfs2X::Entities::Variables::BaseVariable, and Sfs2X::Entities::Variables::MMOItemVariable.

Value()

virtual boost::shared_ptr<void> Sfs2X::Entities::Variables::Variable::Value ( )

pure virtual

Returns the untyped value of this variable.

Implemented in Sfs2X::Entities::Variables::SFSUserVariable, Sfs2X::Entities::Variables::SFSRoomVariable, Sfs2X::Entities::Variables::SFSBuddyVariable, Sfs2X::Entities::Variables::BaseVariable, and Sfs2X::Entities::Variables::MMOItemVariable.