#include <ISFSObject.h>

Inheritance diagram for Sfs2X::Entities::Data::ISFSObject:

Public Member Functions
virtual bool	IsNull (string key)=0
	Indicates if the value mapped by the specified key is `null`. More...

virtual bool	IsNull (boost::shared_ptr< string > key)=0
	Indicates if the value mapped by the specified key is `null`. More...

virtual bool	ContainsKey (string key)=0
	Indicates whether this object contains a mapping for the specified key or not. More...

virtual bool	ContainsKey (boost::shared_ptr< string > key)=0
	Indicates whether this object contains a mapping for the specified key or not. More...

virtual void	RemoveElement (string key)=0
	Removes the element corresponding to the passed key from this object. More...

virtual void	RemoveElement (boost::shared_ptr< string > key)=0
	Removes the element corresponding to the passed key from this object. More...

virtual boost::shared_ptr< vector< string > >	GetKeys ()=0
	Retrieves a list of all the keys contained in this object. More...

virtual long int	Size ()=0
	Indicates the number of elements in this object. More...

virtual boost::shared_ptr< ByteArray >	ToBinary ()=0
	Provides the binary form of this object. More...

virtual boost::shared_ptr< string >	GetDump (bool format)=0
	Provides a formatted string representing this object. More...

virtual boost::shared_ptr< string >	GetDump ()=0
	See GetDump(bool). More...

virtual boost::shared_ptr< string >	GetHexDump ()=0
	Provides a detailed hexadecimal representation of this object. More...

virtual boost::shared_ptr< SFSDataWrapper >	GetData (string key)=0
	<exclude>

virtual boost::shared_ptr< bool >	GetBool (string key)=0
	Returns the element corresponding to the specified key as a boolean. More...

virtual boost::shared_ptr< bool >	GetBool (boost::shared_ptr< string > key)=0
	Returns the element corresponding to the specified key as a boolean. More...

virtual boost::shared_ptr< unsigned char >	GetByte (string key)=0
	Returns the element corresponding to the specified key as a signed byte (8 bits). More...

virtual boost::shared_ptr< unsigned char >	GetByte (boost::shared_ptr< string > key)=0
	Returns the element corresponding to the specified key as a signed byte (8 bits). More...

virtual boost::shared_ptr< short int >	GetShort (string key)=0
	Returns the element corresponding to the specified key as a short integer (16 bits). More...

virtual boost::shared_ptr< short int >	GetShort (boost::shared_ptr< string > key)=0
	Returns the element corresponding to the specified key as a short integer (16 bits). More...

virtual boost::shared_ptr< long int >	GetInt (string key)=0
	Returns the element corresponding to the specified key as an integer (32 bits). More...

virtual boost::shared_ptr< long int >	GetInt (boost::shared_ptr< string > key)=0
	Returns the element corresponding to the specified key as an integer (32 bits). More...

virtual boost::shared_ptr< long long >	GetLong (string key)=0
	Returns the element corresponding to the specified key as a long integer (64 bits). More...

virtual boost::shared_ptr< long long >	GetLong (boost::shared_ptr< string > key)=0
	Returns the element corresponding to the specified key as a long integer (64 bits). More...

virtual boost::shared_ptr< float >	GetFloat (string key)=0
	Returns the element corresponding to the specified key as a floating point number. More...

virtual boost::shared_ptr< float >	GetFloat (boost::shared_ptr< string > key)=0
	Returns the element corresponding to the specified key as a floating point number. More...

virtual boost::shared_ptr< double >	GetDouble (string key)=0
	Returns the element corresponding to the specified key as a double precision number. More...

virtual boost::shared_ptr< double >	GetDouble (boost::shared_ptr< string > key)=0
	Returns the element corresponding to the specified key as a double precision number. More...

virtual boost::shared_ptr< string >	GetUtfString (string key)=0
	Returns the element corresponding to the specified key as an UTF-8 string, with max length of 32 KBytes. More...

virtual boost::shared_ptr< string >	GetUtfString (boost::shared_ptr< string > key)=0
	Returns the element corresponding to the specified key as an UTF-8 string, with max length of 32 KBytes. More...

virtual boost::shared_ptr< string >	GetText (string key)=0
	Returns the element corresponding to the specified key as an UTF-8 string, with max length of 2 GBytes. More...

virtual boost::shared_ptr< string >	GetText (boost::shared_ptr< string > key)=0
	Returns the element corresponding to the specified key as an UTF-8 string, with max length of 2 GBytes. More...

virtual boost::shared_ptr< vector< bool > >	GetBoolArray (string key)=0
	Returns the element corresponding to the specified key as an array of booleans. More...

virtual boost::shared_ptr< vector< bool > >	GetBoolArray (boost::shared_ptr< string > key)=0
	Returns the element corresponding to the specified key as an array of booleans. More...

virtual boost::shared_ptr< ByteArray >	GetByteArray (string key)=0
	Returns the element corresponding to the specified key as a ByteArray object. More...

virtual boost::shared_ptr< ByteArray >	GetByteArray (boost::shared_ptr< string > key)=0
	Returns the element corresponding to the specified key as a ByteArray object. More...

virtual boost::shared_ptr< vector< short int > >	GetShortArray (string key)=0
	Returns the element corresponding to the specified key as an array of shorts. More...

virtual boost::shared_ptr< vector< short int > >	GetShortArray (boost::shared_ptr< string > key)=0
	Returns the element corresponding to the specified key as an array of shorts. More...

virtual boost::shared_ptr< vector< long int > >	GetIntArray (string key)=0
	Returns the element corresponding to the specified key as an array of integers. More...

virtual boost::shared_ptr< vector< long int > >	GetIntArray (boost::shared_ptr< string > key)=0
	Returns the element corresponding to the specified key as an array of integers. More...

virtual boost::shared_ptr< vector< long long > >	GetLongArray (string key)=0
	Returns the element corresponding to the specified key as an array of longs. More...

virtual boost::shared_ptr< vector< long long > >	GetLongArray (boost::shared_ptr< string > key)=0
	Returns the element corresponding to the specified key as an array of longs. More...

virtual boost::shared_ptr< vector< float > >	GetFloatArray (string key)=0
	Returns the element corresponding to the specified key as an array of floats. More...

virtual boost::shared_ptr< vector< float > >	GetFloatArray (boost::shared_ptr< string > key)=0
	Returns the element corresponding to the specified key as an array of floats. More...

virtual boost::shared_ptr< vector< double > >	GetDoubleArray (string key)=0
	Returns the element corresponding to the specified key as an array of doubles. More...

virtual boost::shared_ptr< vector< double > >	GetDoubleArray (boost::shared_ptr< string > key)=0
	Returns the element corresponding to the specified key as an array of doubles. More...

virtual boost::shared_ptr< vector< string > >	GetUtfStringArray (string key)=0
	Returns the element corresponding to the specified key as an array of UTF-8 strings. More...

virtual boost::shared_ptr< vector< string > >	GetUtfStringArray (boost::shared_ptr< string > key)=0
	Returns the element corresponding to the specified key as an array of UTF-8 strings. More...

virtual boost::shared_ptr< ISFSArray >	GetSFSArray (string key)=0
	Returns the element corresponding to the specified key as an ISFSArray object. More...

virtual boost::shared_ptr< ISFSArray >	GetSFSArray (boost::shared_ptr< string > key)=0
	Returns the element corresponding to the specified key as an ISFSArray object. More...

virtual boost::shared_ptr< ISFSObject >	GetSFSObject (string key)=0
	Returns the element corresponding to the specified key as an ISFSObject object. More...

virtual boost::shared_ptr< ISFSObject >	GetSFSObject (boost::shared_ptr< string > key)=0
	Returns the element corresponding to the specified key as an ISFSObject object. More...

virtual boost::shared_ptr< void >	GetClass (string key)=0
	Returns the element corresponding to the specified key as an instance of a custom class. More...

virtual void	PutNull (string key)=0
	<exclude>

virtual void	PutBool (string key, boost::shared_ptr< bool > val)=0
	Associates the passed boolean value with the specified key in this object. More...

virtual void	PutBool (boost::shared_ptr< string > key, boost::shared_ptr< bool > val)=0
	Associates the passed boolean value with the specified key in this object. More...

virtual void	PutBool (string key, bool val)=0
	Associates the passed boolean value with the specified key in this object. More...

virtual void	PutBool (boost::shared_ptr< string > key, bool val)=0
	Associates the passed boolean value with the specified key in this object. More...

virtual void	PutByte (string key, boost::shared_ptr< unsigned char > val)=0
	Associates the passed byte value with the specified key in this object. More...

virtual void	PutByte (boost::shared_ptr< string > key, boost::shared_ptr< unsigned char > val)=0
	Associates the passed byte value with the specified key in this object. More...

virtual void	PutByte (string key, unsigned char val)=0
	Associates the passed byte value with the specified key in this object. More...

virtual void	PutByte (boost::shared_ptr< string > key, unsigned char val)=0
	Associates the passed byte value with the specified key in this object. More...

virtual void	PutShort (string key, boost::shared_ptr< short int > val)=0
	Associates the passed short value with the specified key in this object. More...

virtual void	PutShort (boost::shared_ptr< string > key, boost::shared_ptr< short int > val)=0
	Associates the passed short value with the specified key in this object. More...

virtual void	PutShort (string key, short int val)=0
	Associates the passed short value with the specified key in this object. More...

virtual void	PutShort (boost::shared_ptr< string > key, short int val)=0
	Associates the passed short value with the specified key in this object. More...

virtual void	PutInt (string key, boost::shared_ptr< long int > val)=0
	Associates the passed integer value with the specified key in this object. More...

virtual void	PutInt (boost::shared_ptr< string > key, boost::shared_ptr< long int > val)=0
	Associates the passed integer value with the specified key in this object. More...

virtual void	PutInt (string key, long int val)=0
	Associates the passed integer value with the specified key in this object. More...

virtual void	PutInt (boost::shared_ptr< string > key, long int val)=0
	Associates the passed integer value with the specified key in this object. More...

virtual void	PutLong (string key, boost::shared_ptr< long long > val)=0
	Associates the passed long value with the specified key in this object. More...

virtual void	PutLong (boost::shared_ptr< string > key, boost::shared_ptr< long long > val)=0
	Associates the passed long value with the specified key in this object. More...

virtual void	PutLong (string key, long long val)=0
	Associates the passed long value with the specified key in this object. More...

virtual void	PutLong (boost::shared_ptr< string > key, long long val)=0
	Associates the passed long value with the specified key in this object. More...

virtual void	PutFloat (string key, boost::shared_ptr< float > val)=0
	Associates the passed float value with the specified key in this object. More...

virtual void	PutFloat (boost::shared_ptr< string > key, boost::shared_ptr< float > val)=0
	Associates the passed float value with the specified key in this object. More...

virtual void	PutFloat (string key, float val)=0
	Associates the passed float value with the specified key in this object. More...

virtual void	PutFloat (boost::shared_ptr< string > key, float val)=0
	Associates the passed float value with the specified key in this object. More...

virtual void	PutDouble (string key, boost::shared_ptr< double > val)=0
	Associates the passed double value with the specified key in this object. More...

virtual void	PutDouble (boost::shared_ptr< string > key, boost::shared_ptr< double > val)=0
	Associates the passed double value with the specified key in this object. More...

virtual void	PutDouble (string key, double val)=0
	Associates the passed double value with the specified key in this object. More...

virtual void	PutDouble (boost::shared_ptr< string > key, double val)=0
	Associates the passed double value with the specified key in this object. More...

virtual void	PutUtfString (string key, boost::shared_ptr< string > val)=0
	Associates the passed UTF-8 string value (max length: 32 KBytes) with the specified key in this object. More...

virtual void	PutUtfString (boost::shared_ptr< string > key, boost::shared_ptr< string > val)=0
	Associates the passed UTF-8 string value (max length: 32 KBytes) with the specified key in this object. More...

virtual void	PutUtfString (string key, string val)=0
	Associates the passed UTF-8 string value (max length: 32 KBytes) with the specified key in this object. More...

virtual void	PutUtfString (boost::shared_ptr< string > key, string val)=0
	Associates the passed UTF-8 string value (max length: 32 KBytes) with the specified key in this object. More...

virtual void	PutText (string key, boost::shared_ptr< string > val)=0
	Associates the passed UTF-8 string value (max length: 2 GBytes) with the specified key in this object. More...

virtual void	PutText (boost::shared_ptr< string > key, boost::shared_ptr< string > val)=0
	Associates the passed UTF-8 string value (max length: 2 GBytes) with the specified key in this object. More...

virtual void	PutText (string key, string val)=0
	Associates the passed UTF-8 string value (max length: 2 GBytes) with the specified key in this object. More...

virtual void	PutText (boost::shared_ptr< string > key, string val)=0
	Associates the passed UTF-8 string value (max length: 2 GBytes) with the specified key in this object. More...

virtual void	PutBoolArray (string key, boost::shared_ptr< vector< bool > > val)=0
	Associates the passed array of booleans with the specified key in this object. More...

virtual void	PutBoolArray (boost::shared_ptr< string > key, boost::shared_ptr< vector< bool > > val)=0
	Associates the passed array of booleans with the specified key in this object. More...

virtual void	PutByteArray (string key, boost::shared_ptr< ByteArray > val)=0
	Associates the passed ByteArray object with the specified key in this object. More...

virtual void	PutByteArray (boost::shared_ptr< string > key, boost::shared_ptr< ByteArray > val)=0
	Associates the passed ByteArray object with the specified key in this object. More...

virtual void	PutShortArray (string key, boost::shared_ptr< vector< short int > > val)=0
	Associates the passed array of shorts with the specified key in this object. More...

virtual void	PutShortArray (boost::shared_ptr< string > key, boost::shared_ptr< vector< short int > > val)=0
	Associates the passed array of shorts with the specified key in this object. More...

virtual void	PutIntArray (string key, boost::shared_ptr< vector< long int > > val)=0
	Associates the passed array of integers with the specified key in this object. More...

virtual void	PutIntArray (boost::shared_ptr< string > key, boost::shared_ptr< vector< long int > > val)=0
	Associates the passed array of integers with the specified key in this object. More...

virtual void	PutLongArray (string key, boost::shared_ptr< vector< long long > > val)=0
	Associates the passed array of longs with the specified key in this object. More...

virtual void	PutLongArray (boost::shared_ptr< string > key, boost::shared_ptr< vector< long long > > val)=0
	Associates the passed array of longs with the specified key in this object. More...

virtual void	PutFloatArray (string key, boost::shared_ptr< vector< float > > val)=0
	Associates the passed array of floats with the specified key in this object. More...

virtual void	PutFloatArray (boost::shared_ptr< string > key, boost::shared_ptr< vector< float > > val)=0
	Associates the passed array of floats with the specified key in this object. More...

virtual void	PutDoubleArray (string key, boost::shared_ptr< vector< double > > val)=0
	Associates the passed array of doubles with the specified key in this object. More...

virtual void	PutDoubleArray (boost::shared_ptr< string > key, boost::shared_ptr< vector< double > > val)=0
	Associates the passed array of doubles with the specified key in this object. More...

virtual void	PutUtfStringArray (string key, boost::shared_ptr< vector< string > > val)=0
	Associates the passed array of UTF-8 strings with the specified key in this object. More...

virtual void	PutUtfStringArray (boost::shared_ptr< string > key, boost::shared_ptr< vector< string > > val)=0
	Associates the passed array of UTF-8 strings with the specified key in this object. More...

virtual void	PutSFSArray (string key, boost::shared_ptr< ISFSArray > val)=0
	Associates the passed ISFSArray object with the specified key in this object. More...

virtual void	PutSFSArray (boost::shared_ptr< string > key, boost::shared_ptr< ISFSArray > val)=0
	Associates the passed ISFSArray object with the specified key in this object. More...

virtual void	PutSFSObject (string key, boost::shared_ptr< ISFSObject > val)=0
	Associates the passed ISFSObject object with the specified key in this object. More...

virtual void	PutSFSObject (boost::shared_ptr< string > key, boost::shared_ptr< ISFSObject > val)=0
	Associates the passed ISFSObject object with the specified key in this object. More...

virtual void	PutClass (string key, boost::shared_ptr< void > val)=0
	Associates the passed custom class instance with the specified key in this object. More...

virtual void	PutClass (boost::shared_ptr< string > key, boost::shared_ptr< void > val)=0
	Associates the passed custom class instance with the specified key in this object. More...

virtual void	Put (string key, boost::shared_ptr< SFSDataWrapper > val)=0
	<exclude>

virtual void	Put (boost::shared_ptr< string > key, boost::shared_ptr< SFSDataWrapper > val)=0
	<exclude>

Detailed Description

SFSObject interface

Member Function Documentation

◆ ContainsKey() [1/2]

virtual bool Sfs2X::Entities::Data::ISFSObject::ContainsKey ( string key )

pure virtual

Indicates whether this object contains a mapping for the specified key or not.

Parameters

key	The key whose presence in this object is to be tested.

Returns: true if this object contains a mapping for the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ ContainsKey() [2/2]

virtual bool Sfs2X::Entities::Data::ISFSObject::ContainsKey ( boost::shared_ptr< string > key )

pure virtual

Indicates whether this object contains a mapping for the specified key or not.

Parameters

key	The key whose presence in this object is to be tested.

Returns: true if this object contains a mapping for the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetBool() [1/2]

virtual boost::shared_ptr<bool> Sfs2X::Entities::Data::ISFSObject::GetBool ( string key )

pure virtual

Returns the element corresponding to the specified key as a boolean.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object associated with the specified key; false if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetBool() [2/2]

virtual boost::shared_ptr<bool> Sfs2X::Entities::Data::ISFSObject::GetBool ( boost::shared_ptr< string > key )

pure virtual

Returns the element corresponding to the specified key as a boolean.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object associated with the specified key; false if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetBoolArray() [1/2]

virtual boost::shared_ptr<vector<bool> > Sfs2X::Entities::Data::ISFSObject::GetBoolArray ( string key )

pure virtual

Returns the element corresponding to the specified key as an array of booleans.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as an array of booleans; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetBoolArray() [2/2]

virtual boost::shared_ptr<vector<bool> > Sfs2X::Entities::Data::ISFSObject::GetBoolArray ( boost::shared_ptr< string > key )

pure virtual

Returns the element corresponding to the specified key as an array of booleans.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as an array of booleans; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetByte() [1/2]

virtual boost::shared_ptr<unsigned char> Sfs2X::Entities::Data::ISFSObject::GetByte ( string key )

pure virtual

Returns the element corresponding to the specified key as a signed byte (8 bits).

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object associated with the specified key; 0 if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetByte() [2/2]

virtual boost::shared_ptr<unsigned char> Sfs2X::Entities::Data::ISFSObject::GetByte ( boost::shared_ptr< string > key )

pure virtual

Returns the element corresponding to the specified key as a signed byte (8 bits).

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object associated with the specified key; 0 if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetByteArray() [1/2]

virtual boost::shared_ptr<ByteArray> Sfs2X::Entities::Data::ISFSObject::GetByteArray ( string key )

pure virtual

Returns the element corresponding to the specified key as a ByteArray object.

IMPORTANT: ByteArrays transmission is not supported in Unity WebGL.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as a ByteArray object; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetByteArray() [2/2]

virtual boost::shared_ptr<ByteArray> Sfs2X::Entities::Data::ISFSObject::GetByteArray ( boost::shared_ptr< string > key )

pure virtual

Returns the element corresponding to the specified key as a ByteArray object.

IMPORTANT: ByteArrays transmission is not supported in Unity WebGL.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as a ByteArray object; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetClass()

virtual boost::shared_ptr<void> Sfs2X::Entities::Data::ISFSObject::GetClass ( string key )

pure virtual

Returns the element corresponding to the specified key as an instance of a custom class.

This advanced feature allows the transmission of specific object instances between client-side C++ and server-side Java provided that:

the respective class definitions on both sides have the same package name
the following code is executed right after creating the SmartFox object: DefaultSFSDataSerializer.RunningAssembly = Assembly.GetExecutingAssembly(); (requires System.Reflection and Sfs2X.Protocol.Serialization)

This is an example of the same class on the server and client side:

Server Java code:

package my.game.spacecombat
public class SpaceShip
{
    private String type;
    private String name;
    private int firePower;
    private int maxSpeed;
    private List<String> weapons;
    public SpaceShip(String name, String type)
    {
        this.name = name;
        this.type = type;
    }
    // ... Getters / Setters ...
}

Client AS3 code:

package my.game.spacecombat
{
    public class SpaceShip
    {
        private var _type:String
        private var _name:String
        private var _firePower:int;
        private var _maxSpeed:int;
        private var _weapons:Array;
        public SpaceShip(name:String, type:Strig)
        {
            _name = name
            _type = type
        }
        // ... Getters / Setters ...
    }
}   

A SpaceShip instance from server side is sent to the client. This is how you get it:

boost::shared_ptr<string> name (new string("spaceShip"));

boost::shared_ptr<SpaceShip> mySpaceShip = (boost::static_pointer_cast<SpaceShip>)sfsObject->getClass(name)

Parameters

key	A string pointer

Returns: A void pointer

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetDouble() [1/2]

virtual boost::shared_ptr<double> Sfs2X::Entities::Data::ISFSObject::GetDouble ( string key )

pure virtual

Returns the element corresponding to the specified key as a double precision number.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object associated with the specified key; 0 if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetDouble() [2/2]

virtual boost::shared_ptr<double> Sfs2X::Entities::Data::ISFSObject::GetDouble ( boost::shared_ptr< string > key )

pure virtual

Returns the element corresponding to the specified key as a double precision number.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object associated with the specified key; 0 if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetDoubleArray() [1/2]

virtual boost::shared_ptr<vector<double> > Sfs2X::Entities::Data::ISFSObject::GetDoubleArray ( string key )

pure virtual

Returns the element corresponding to the specified key as an array of doubles.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as an array of doubles; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetDoubleArray() [2/2]

virtual boost::shared_ptr<vector<double> > Sfs2X::Entities::Data::ISFSObject::GetDoubleArray ( boost::shared_ptr< string > key )

pure virtual

Returns the element corresponding to the specified key as an array of doubles.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as an array of doubles; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetDump() [1/2]

virtual boost::shared_ptr<string> Sfs2X::Entities::Data::ISFSObject::GetDump ( bool format )

pure virtual

Provides a formatted string representing this object.

The returned string can be logged or traced in the console for debugging purposes.

Parameters

format If true, the output is formatted in a human-readable way.

Returns: The string representation of this object.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetDump() [2/2]

virtual boost::shared_ptr<string> Sfs2X::Entities::Data::ISFSObject::GetDump ( )

pure virtual

See GetDump(bool).

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetFloat() [1/2]

virtual boost::shared_ptr<float> Sfs2X::Entities::Data::ISFSObject::GetFloat ( string key )

pure virtual

Returns the element corresponding to the specified key as a floating point number.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object associated with the specified key; 0 if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetFloat() [2/2]

virtual boost::shared_ptr<float> Sfs2X::Entities::Data::ISFSObject::GetFloat ( boost::shared_ptr< string > key )

pure virtual

Returns the element corresponding to the specified key as a floating point number.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object associated with the specified key; 0 if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetFloatArray() [1/2]

virtual boost::shared_ptr<vector<float> > Sfs2X::Entities::Data::ISFSObject::GetFloatArray ( string key )

pure virtual

Returns the element corresponding to the specified key as an array of floats.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as an array of floats; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetFloatArray() [2/2]

virtual boost::shared_ptr<vector<float> > Sfs2X::Entities::Data::ISFSObject::GetFloatArray ( boost::shared_ptr< string > key )

pure virtual

Returns the element corresponding to the specified key as an array of floats.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as an array of floats; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetHexDump()

virtual boost::shared_ptr<string> Sfs2X::Entities::Data::ISFSObject::GetHexDump ( )

pure virtual

Provides a detailed hexadecimal representation of this object.

The returned string can be logged or traced in the console for debugging purposes.

Returns: The hexadecimal string representation of this object.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetInt() [1/2]

virtual boost::shared_ptr<long int> Sfs2X::Entities::Data::ISFSObject::GetInt ( string key )

pure virtual

Returns the element corresponding to the specified key as an integer (32 bits).

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object associated with the specified key; 0 if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetInt() [2/2]

virtual boost::shared_ptr<long int> Sfs2X::Entities::Data::ISFSObject::GetInt ( boost::shared_ptr< string > key )

pure virtual

Returns the element corresponding to the specified key as an integer (32 bits).

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object associated with the specified key; 0 if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetIntArray() [1/2]

virtual boost::shared_ptr<vector<long int> > Sfs2X::Entities::Data::ISFSObject::GetIntArray ( string key )

pure virtual

Returns the element corresponding to the specified key as an array of integers.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as an array of integers; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetIntArray() [2/2]

virtual boost::shared_ptr<vector<long int> > Sfs2X::Entities::Data::ISFSObject::GetIntArray ( boost::shared_ptr< string > key )

pure virtual

Returns the element corresponding to the specified key as an array of integers.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as an array of integers; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetKeys()

virtual boost::shared_ptr<vector<string> > Sfs2X::Entities::Data::ISFSObject::GetKeys ( )

pure virtual

Retrieves a list of all the keys contained in this object.

Returns: The list of all the keys in this object.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetLong() [1/2]

virtual boost::shared_ptr<long long> Sfs2X::Entities::Data::ISFSObject::GetLong ( string key )

pure virtual

Returns the element corresponding to the specified key as a long integer (64 bits).

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object associated with the specified key; 0 if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetLong() [2/2]

virtual boost::shared_ptr<long long> Sfs2X::Entities::Data::ISFSObject::GetLong ( boost::shared_ptr< string > key )

pure virtual

Returns the element corresponding to the specified key as a long integer (64 bits).

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object associated with the specified key; 0 if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetLongArray() [1/2]

virtual boost::shared_ptr<vector<long long> > Sfs2X::Entities::Data::ISFSObject::GetLongArray ( string key )

pure virtual

Returns the element corresponding to the specified key as an array of longs.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as an array of longs; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetLongArray() [2/2]

virtual boost::shared_ptr<vector<long long> > Sfs2X::Entities::Data::ISFSObject::GetLongArray ( boost::shared_ptr< string > key )

pure virtual

Returns the element corresponding to the specified key as an array of longs.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as an array of longs; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetSFSArray() [1/2]

virtual boost::shared_ptr<ISFSArray> Sfs2X::Entities::Data::ISFSObject::GetSFSArray ( string key )

pure virtual

Returns the element corresponding to the specified key as an ISFSArray object.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as an object implementing the ISFSArray interface; null if a mapping for the passed key doesn't exist.

See also: SFSArray

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetSFSArray() [2/2]

virtual boost::shared_ptr<ISFSArray> Sfs2X::Entities::Data::ISFSObject::GetSFSArray ( boost::shared_ptr< string > key )

pure virtual

Returns the element corresponding to the specified key as an ISFSArray object.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as an object implementing the ISFSArray interface; null if a mapping for the passed key doesn't exist.

See also: SFSArray

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetSFSObject() [1/2]

virtual boost::shared_ptr<ISFSObject> Sfs2X::Entities::Data::ISFSObject::GetSFSObject ( string key )

pure virtual

Returns the element corresponding to the specified key as an ISFSObject object.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as an object implementing the ISFSObject interface; null if a mapping for the passed key doesn't exist.

See also: SFSObject

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetSFSObject() [2/2]

virtual boost::shared_ptr<ISFSObject> Sfs2X::Entities::Data::ISFSObject::GetSFSObject ( boost::shared_ptr< string > key )

pure virtual

Returns the element corresponding to the specified key as an ISFSObject object.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as an object implementing the ISFSObject interface; null if a mapping for the passed key doesn't exist.

See also: SFSObject

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetShort() [1/2]

virtual boost::shared_ptr<short int> Sfs2X::Entities::Data::ISFSObject::GetShort ( string key )

pure virtual

Returns the element corresponding to the specified key as a short integer (16 bits).

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object associated with the specified key; 0 if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetShort() [2/2]

virtual boost::shared_ptr<short int> Sfs2X::Entities::Data::ISFSObject::GetShort ( boost::shared_ptr< string > key )

pure virtual

Returns the element corresponding to the specified key as a short integer (16 bits).

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object associated with the specified key; 0 if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetShortArray() [1/2]

virtual boost::shared_ptr<vector<short int> > Sfs2X::Entities::Data::ISFSObject::GetShortArray ( string key )

pure virtual

Returns the element corresponding to the specified key as an array of shorts.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as an array of shorts; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetShortArray() [2/2]

virtual boost::shared_ptr<vector<short int> > Sfs2X::Entities::Data::ISFSObject::GetShortArray ( boost::shared_ptr< string > key )

pure virtual

Returns the element corresponding to the specified key as an array of shorts.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as an array of shorts; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetText() [1/2]

virtual boost::shared_ptr<string> Sfs2X::Entities::Data::ISFSObject::GetText ( string key )

pure virtual

Returns the element corresponding to the specified key as an UTF-8 string, with max length of 2 GBytes.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object associated with the specified key; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetText() [2/2]

virtual boost::shared_ptr<string> Sfs2X::Entities::Data::ISFSObject::GetText ( boost::shared_ptr< string > key )

pure virtual

Returns the element corresponding to the specified key as an UTF-8 string, with max length of 2 GBytes.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object associated with the specified key; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetUtfString() [1/2]

virtual boost::shared_ptr<string> Sfs2X::Entities::Data::ISFSObject::GetUtfString ( string key )

pure virtual

Returns the element corresponding to the specified key as an UTF-8 string, with max length of 32 KBytes.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object associated with the specified key; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetUtfString() [2/2]

virtual boost::shared_ptr<string> Sfs2X::Entities::Data::ISFSObject::GetUtfString ( boost::shared_ptr< string > key )

pure virtual

Returns the element corresponding to the specified key as an UTF-8 string, with max length of 32 KBytes.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object associated with the specified key; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetUtfStringArray() [1/2]

virtual boost::shared_ptr<vector<string> > Sfs2X::Entities::Data::ISFSObject::GetUtfStringArray ( string key )

pure virtual

Returns the element corresponding to the specified key as an array of UTF-8 strings.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as an array of UTF-8 strings; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ GetUtfStringArray() [2/2]

virtual boost::shared_ptr<vector<string> > Sfs2X::Entities::Data::ISFSObject::GetUtfStringArray ( boost::shared_ptr< string > key )

pure virtual

Returns the element corresponding to the specified key as an array of UTF-8 strings.

Parameters

key	The key whose associated value is to be returned.

Returns: The element of this object as an array of UTF-8 strings; null if a mapping for the passed key doesn't exist.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ IsNull() [1/2]

virtual bool Sfs2X::Entities::Data::ISFSObject::IsNull ( string key )

pure virtual

Indicates if the value mapped by the specified key is null.

Parameters

key	The key to be checked.

Returns: true if the value mapped by the passed key is null or the mapping doesn't exist for that key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ IsNull() [2/2]

virtual bool Sfs2X::Entities::Data::ISFSObject::IsNull ( boost::shared_ptr< string > key )

pure virtual

Indicates if the value mapped by the specified key is null.

Parameters

key	The key to be checked.

Returns: true if the value mapped by the passed key is null or the mapping doesn't exist for that key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutBool() [1/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutBool	(	string	key,
		boost::shared_ptr< bool >	val
	)

pure virtual

Associates the passed boolean value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutBool() [2/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutBool	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< bool >	val
	)

pure virtual

Associates the passed boolean value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutBool() [3/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutBool	(	string	key,
		bool	val
	)

pure virtual

Associates the passed boolean value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutBool() [4/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutBool	(	boost::shared_ptr< string >	key,
		bool	val
	)

pure virtual

Associates the passed boolean value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutBoolArray() [1/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutBoolArray	(	string	key,
		boost::shared_ptr< vector< bool > >	val
	)

pure virtual

Associates the passed array of booleans with the specified key in this object.

Parameters

key	The key with which the specified array is to be associated.
val	The array of booleans to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutBoolArray() [2/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutBoolArray	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< vector< bool > >	val
	)

pure virtual

Associates the passed array of booleans with the specified key in this object.

Parameters

key	The key with which the specified array is to be associated.
val	The array of booleans to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutByte() [1/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutByte	(	string	key,
		boost::shared_ptr< unsigned char >	val
	)

pure virtual

Associates the passed byte value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutByte() [2/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutByte	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< unsigned char >	val
	)

pure virtual

Associates the passed byte value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutByte() [3/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutByte	(	string	key,
		unsigned char	val
	)

pure virtual

Associates the passed byte value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutByte() [4/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutByte	(	boost::shared_ptr< string >	key,
		unsigned char	val
	)

pure virtual

Associates the passed byte value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutByteArray() [1/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutByteArray	(	string	key,
		boost::shared_ptr< ByteArray >	val
	)

pure virtual

Associates the passed ByteArray object with the specified key in this object.

IMPORTANT: ByteArrays transmission is not supported in Unity WebGL.

Parameters

key	The key with which the specified object is to be associated.
val	The object to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutByteArray() [2/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutByteArray	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< ByteArray >	val
	)

pure virtual

Associates the passed ByteArray object with the specified key in this object.

IMPORTANT: ByteArrays transmission is not supported in Unity WebGL.

Parameters

key	The key with which the specified object is to be associated.
val	The object to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutClass() [1/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutClass	(	string	key,
		boost::shared_ptr< void >	val
	)

pure virtual

Associates the passed custom class instance with the specified key in this object.

Read the GetClass method description for more informations.

Parameters

key	The key with which the specified custom class instance is to be associated.
val	The custom class instance to be associated with the specified key.

See also: GetClass

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutClass() [2/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutClass	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< void >	val
	)

pure virtual

Associates the passed custom class instance with the specified key in this object.

Read the GetClass method description for more informations.

Parameters

key	The key with which the specified custom class instance is to be associated.
val	The custom class instance to be associated with the specified key.

See also: GetClass

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutDouble() [1/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutDouble	(	string	key,
		boost::shared_ptr< double >	val
	)

pure virtual

Associates the passed double value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutDouble() [2/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutDouble	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< double >	val
	)

pure virtual

Associates the passed double value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutDouble() [3/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutDouble	(	string	key,
		double	val
	)

pure virtual

Associates the passed double value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutDouble() [4/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutDouble	(	boost::shared_ptr< string >	key,
		double	val
	)

pure virtual

Associates the passed double value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutDoubleArray() [1/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutDoubleArray	(	string	key,
		boost::shared_ptr< vector< double > >	val
	)

pure virtual

Associates the passed array of doubles with the specified key in this object.

Parameters

key	The key with which the specified array is to be associated.
val	The array of doubles to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutDoubleArray() [2/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutDoubleArray	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< vector< double > >	val
	)

pure virtual

Associates the passed array of doubles with the specified key in this object.

Parameters

key	The key with which the specified array is to be associated.
val	The array of doubles to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutFloat() [1/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutFloat	(	string	key,
		boost::shared_ptr< float >	val
	)

pure virtual

Associates the passed float value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutFloat() [2/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutFloat	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< float >	val
	)

pure virtual

Associates the passed float value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutFloat() [3/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutFloat	(	string	key,
		float	val
	)

pure virtual

Associates the passed float value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutFloat() [4/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutFloat	(	boost::shared_ptr< string >	key,
		float	val
	)

pure virtual

Associates the passed float value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutFloatArray() [1/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutFloatArray	(	string	key,
		boost::shared_ptr< vector< float > >	val
	)

pure virtual

Associates the passed array of floats with the specified key in this object.

Parameters

key	The key with which the specified array is to be associated.
val	The array of floats to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutFloatArray() [2/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutFloatArray	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< vector< float > >	val
	)

pure virtual

Associates the passed array of floats with the specified key in this object.

Parameters

key	The key with which the specified array is to be associated.
val	The array of floats to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutInt() [1/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutInt	(	string	key,
		boost::shared_ptr< long int >	val
	)

pure virtual

Associates the passed integer value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutInt() [2/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutInt	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< long int >	val
	)

pure virtual

Associates the passed integer value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutInt() [3/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutInt	(	string	key,
		long int	val
	)

pure virtual

Associates the passed integer value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutInt() [4/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutInt	(	boost::shared_ptr< string >	key,
		long int	val
	)

pure virtual

Associates the passed integer value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutIntArray() [1/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutIntArray	(	string	key,
		boost::shared_ptr< vector< long int > >	val
	)

pure virtual

Associates the passed array of integers with the specified key in this object.

Parameters

key	The key with which the specified array is to be associated.
val	The array of integers to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutIntArray() [2/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutIntArray	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< vector< long int > >	val
	)

pure virtual

Associates the passed array of integers with the specified key in this object.

Parameters

key	The key with which the specified array is to be associated.
val	The array of integers to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutLong() [1/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutLong	(	string	key,
		boost::shared_ptr< long long >	val
	)

pure virtual

Associates the passed long value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutLong() [2/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutLong	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< long long >	val
	)

pure virtual

Associates the passed long value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutLong() [3/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutLong	(	string	key,
		long long	val
	)

pure virtual

Associates the passed long value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutLong() [4/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutLong	(	boost::shared_ptr< string >	key,
		long long	val
	)

pure virtual

Associates the passed long value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutLongArray() [1/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutLongArray	(	string	key,
		boost::shared_ptr< vector< long long > >	val
	)

pure virtual

Associates the passed array of longs with the specified key in this object.

Parameters

key	The key with which the specified array is to be associated.
val	The array of longs to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutLongArray() [2/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutLongArray	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< vector< long long > >	val
	)

pure virtual

Associates the passed array of longs with the specified key in this object.

Parameters

key	The key with which the specified array is to be associated.
val	The array of longs to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutSFSArray() [1/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutSFSArray	(	string	key,
		boost::shared_ptr< ISFSArray >	val
	)

pure virtual

Associates the passed ISFSArray object with the specified key in this object.

Parameters

key	The key with which the specified object is to be associated.
val	The object to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutSFSArray() [2/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutSFSArray	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< ISFSArray >	val
	)

pure virtual

Associates the passed ISFSArray object with the specified key in this object.

Parameters

key	The key with which the specified object is to be associated.
val	The object to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutSFSObject() [1/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutSFSObject	(	string	key,
		boost::shared_ptr< ISFSObject >	val
	)

pure virtual

Associates the passed ISFSObject object with the specified key in this object.

Parameters

key	The key with which the specified object is to be associated.
val	The object to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutSFSObject() [2/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutSFSObject	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< ISFSObject >	val
	)

pure virtual

Associates the passed ISFSObject object with the specified key in this object.

Parameters

key	The key with which the specified object is to be associated.
val	The object to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutShort() [1/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutShort	(	string	key,
		boost::shared_ptr< short int >	val
	)

pure virtual

Associates the passed short value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutShort() [2/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutShort	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< short int >	val
	)

pure virtual

Associates the passed short value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutShort() [3/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutShort	(	string	key,
		short int	val
	)

pure virtual

Associates the passed short value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutShort() [4/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutShort	(	boost::shared_ptr< string >	key,
		short int	val
	)

pure virtual

Associates the passed short value with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutShortArray() [1/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutShortArray	(	string	key,
		boost::shared_ptr< vector< short int > >	val
	)

pure virtual

Associates the passed array of shorts with the specified key in this object.

Parameters

key	The key with which the specified array is to be associated.
val	The array of shorts to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutShortArray() [2/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutShortArray	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< vector< short int > >	val
	)

pure virtual

Associates the passed array of shorts with the specified key in this object.

Parameters

key	The key with which the specified array is to be associated.
val	The array of shorts to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutText() [1/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutText	(	string	key,
		boost::shared_ptr< string >	val
	)

pure virtual

Associates the passed UTF-8 string value (max length: 2 GBytes) with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutText() [2/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutText	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< string >	val
	)

pure virtual

Associates the passed UTF-8 string value (max length: 2 GBytes) with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutText() [3/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutText	(	string	key,
		string	val
	)

pure virtual

Associates the passed UTF-8 string value (max length: 2 GBytes) with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutText() [4/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutText	(	boost::shared_ptr< string >	key,
		string	val
	)

pure virtual

Associates the passed UTF-8 string value (max length: 2 GBytes) with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutUtfString() [1/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutUtfString	(	string	key,
		boost::shared_ptr< string >	val
	)

pure virtual

Associates the passed UTF-8 string value (max length: 32 KBytes) with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutUtfString() [2/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutUtfString	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< string >	val
	)

pure virtual

Associates the passed UTF-8 string value (max length: 32 KBytes) with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutUtfString() [3/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutUtfString	(	string	key,
		string	val
	)

pure virtual

Associates the passed UTF-8 string value (max length: 32 KBytes) with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutUtfString() [4/4]

virtual void Sfs2X::Entities::Data::ISFSObject::PutUtfString	(	boost::shared_ptr< string >	key,
		string	val
	)

pure virtual

Associates the passed UTF-8 string value (max length: 32 KBytes) with the specified key in this object.

Parameters

key	The key with which the specified value is to be associated.
val	The value to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutUtfStringArray() [1/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutUtfStringArray	(	string	key,
		boost::shared_ptr< vector< string > >	val
	)

pure virtual

Associates the passed array of UTF-8 strings with the specified key in this object.

Parameters

key	The key with which the specified array is to be associated.
val	The array of UTF-8 strings to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ PutUtfStringArray() [2/2]

virtual void Sfs2X::Entities::Data::ISFSObject::PutUtfStringArray	(	boost::shared_ptr< string >	key,
		boost::shared_ptr< vector< string > >	val
	)

pure virtual

Associates the passed array of UTF-8 strings with the specified key in this object.

Parameters

key	The key with which the specified array is to be associated.
val	The array of UTF-8 strings to be associated with the specified key.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ RemoveElement() [1/2]

virtual void Sfs2X::Entities::Data::ISFSObject::RemoveElement ( string key )

pure virtual

Removes the element corresponding to the passed key from this object.

Parameters

key	The key of the element to be removed.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ RemoveElement() [2/2]

virtual void Sfs2X::Entities::Data::ISFSObject::RemoveElement ( boost::shared_ptr< string > key )

pure virtual

Removes the element corresponding to the passed key from this object.

Parameters

key	The key of the element to be removed.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ Size()

virtual long int Sfs2X::Entities::Data::ISFSObject::Size ( )

pure virtual

Indicates the number of elements in this object.

Returns: The number of elements in this object.

Implemented in Sfs2X::Entities::Data::SFSObject.

◆ ToBinary()

virtual boost::shared_ptr<ByteArray> Sfs2X::Entities::Data::ISFSObject::ToBinary ( )

pure virtual

Provides the binary form of this object.

Returns: The binary data representing this object.

Implemented in Sfs2X::Entities::Data::SFSObject.

Public Member Functions

Detailed Description

Member Function Documentation

◆ ContainsKey() [1/2]

◆ ContainsKey() [2/2]

◆ GetBool() [1/2]

◆ GetBool() [2/2]

◆ GetBoolArray() [1/2]

◆ GetBoolArray() [2/2]

◆ GetByte() [1/2]

◆ GetByte() [2/2]

◆ GetByteArray() [1/2]

◆ GetByteArray() [2/2]

◆ GetClass()

◆ GetDouble() [1/2]

◆ GetDouble() [2/2]

◆ GetDoubleArray() [1/2]

◆ GetDoubleArray() [2/2]

◆ GetDump() [1/2]

◆ GetDump() [2/2]

◆ GetFloat() [1/2]

◆ GetFloat() [2/2]

◆ GetFloatArray() [1/2]

◆ GetFloatArray() [2/2]

◆ GetHexDump()

◆ GetInt() [1/2]

◆ GetInt() [2/2]

◆ GetIntArray() [1/2]

◆ GetIntArray() [2/2]

◆ GetKeys()

◆ GetLong() [1/2]

◆ GetLong() [2/2]

◆ GetLongArray() [1/2]

◆ GetLongArray() [2/2]

◆ GetSFSArray() [1/2]

◆ GetSFSArray() [2/2]

◆ GetSFSObject() [1/2]

◆ GetSFSObject() [2/2]

◆ GetShort() [1/2]

◆ GetShort() [2/2]

◆ GetShortArray() [1/2]

◆ GetShortArray() [2/2]

◆ GetText() [1/2]

◆ GetText() [2/2]

◆ GetUtfString() [1/2]

◆ GetUtfString() [2/2]

◆ GetUtfStringArray() [1/2]

◆ GetUtfStringArray() [2/2]

◆ IsNull() [1/2]

◆ IsNull() [2/2]

◆ PutBool() [1/4]

◆ PutBool() [2/4]

◆ PutBool() [3/4]

◆ PutBool() [4/4]

◆ PutBoolArray() [1/2]

◆ PutBoolArray() [2/2]

◆ PutByte() [1/4]

◆ PutByte() [2/4]

◆ PutByte() [3/4]

◆ PutByte() [4/4]

◆ PutByteArray() [1/2]

◆ PutByteArray() [2/2]

◆ PutClass() [1/2]

◆ PutClass() [2/2]

◆ PutDouble() [1/4]

◆ PutDouble() [2/4]

◆ PutDouble() [3/4]

◆ PutDouble() [4/4]

◆ PutDoubleArray() [1/2]

◆ PutDoubleArray() [2/2]

◆ PutFloat() [1/4]

◆ PutFloat() [2/4]

◆ PutFloat() [3/4]

◆ PutFloat() [4/4]

◆ PutFloatArray() [1/2]

◆ PutFloatArray() [2/2]

◆ PutInt() [1/4]

◆ PutInt() [2/4]

◆ PutInt() [3/4]

◆ PutInt() [4/4]