#include <SFSObject.h>

Inheritance diagram for Sfs2X::Entities::Data::SFSObject:

Public Member Functions
	SFSObject ()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	PutNull (string key)
	<exclude>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

bool	IsNull (string key)
	Indicates if the value mapped by the specified key is `null`. More...

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

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

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

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

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

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

Static Public Member Functions
static boost::shared_ptr< SFSObject >	NewFromObject (boost::shared_ptr< void > o)
	Alternative static constructor that builds an SFSObject populated with the data found in the passed Object More...

static boost::shared_ptr< SFSObject >	NewFromBinaryData (boost::shared_ptr< ByteArray > ba)
	Alternative static constructor that builds an SFSObject from a valid SFSObject binary representation More...

static boost::shared_ptr< SFSObject >	NewInstance ()
	Alternative static constructor More...

Detailed Description

SFSObject

SFSObject is used from server and client side to exchange data. It can be thought of a specialized Dictionary/Map object that can contain any type of data.
The advantage of using SFSObject is that you can fine tune the way your data will be transmitted over the network.
For instance, a number like 100 can be transmitted as a normal integer (which takes 32 bits) but also a short (16 bit) or even a byte (8 bit)

SFSObject supports many primitive data types and related arrays of primitives. It also allows to serialize class instances and rebuild them on the Java side.
This is explained in greater detail in a separate document.

See also: SFSArray

Constructor & Destructor Documentation

◆ SFSObject()

Sfs2X::Entities::Data::SFSObject::SFSObject ( )

Member Function Documentation

◆ ContainsKey() [1/2]

bool Sfs2X::Entities::Data::SFSObject::ContainsKey ( string key )

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ ContainsKey() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetBool() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetBool() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetBoolArray() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetBoolArray() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetByte() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetByte() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetByteArray() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetByteArray() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetClass()

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

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

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetDouble() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetDouble() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetDoubleArray() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetDoubleArray() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetDump() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetDump() [2/2]

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

virtual

See GetDump(bool).

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetFloat() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetFloat() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetFloatArray() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetFloatArray() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetHexDump()

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetInt() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetInt() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetIntArray() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetIntArray() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetKeys()

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

virtual

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

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

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetLong() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetLong() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetLongArray() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetLongArray() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetSFSArray() [1/2]

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

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

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetSFSArray() [2/2]

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

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

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetSFSObject() [1/2]

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

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

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetSFSObject() [2/2]

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

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

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetShort() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetShort() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetShortArray() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetShortArray() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetText() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetText() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetUtfString() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetUtfString() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetUtfStringArray() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ GetUtfStringArray() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ IsNull() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ IsNull() [2/2]

bool Sfs2X::Entities::Data::SFSObject::IsNull ( string key )

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ NewFromBinaryData()

boost::shared_ptr< SFSObject > Sfs2X::Entities::Data::SFSObject::NewFromBinaryData ( boost::shared_ptr< ByteArray > ba )

static

Alternative static constructor that builds an SFSObject from a valid SFSObject binary representation

Parameters

ba	Pointer to a ByteArray instance

Returns: Pointer to a SFSObject instance

◆ NewFromObject()

boost::shared_ptr< SFSObject > Sfs2X::Entities::Data::SFSObject::NewFromObject ( boost::shared_ptr< void > o )

static

Alternative static constructor that builds an SFSObject populated with the data found in the passed Object

Parameters

o	A void pointer

Returns: Pointer to a SFSObject instance

◆ NewInstance()

boost::shared_ptr< SFSObject > Sfs2X::Entities::Data::SFSObject::NewInstance ( )

static

Alternative static constructor

Returns: Pointer to a SFSObject instance

◆ PutBool() [1/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutBool() [2/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutBool() [3/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutBool() [4/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutBoolArray() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutBoolArray() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutByte() [1/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutByte() [2/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutByte() [3/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutByte() [4/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutByteArray() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutByteArray() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutClass() [1/2]

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

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

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutClass() [2/2]

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

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

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutDouble() [1/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutDouble() [2/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutDouble() [3/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutDouble() [4/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutDoubleArray() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutDoubleArray() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutFloat() [1/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutFloat() [2/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutFloat() [3/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutFloat() [4/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutFloatArray() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutFloatArray() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutInt() [1/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutInt() [2/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutInt() [3/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutInt() [4/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutIntArray() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutIntArray() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutLong() [1/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutLong() [2/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutLong() [3/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutLong() [4/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutLongArray() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutLongArray() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutSFSArray() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutSFSArray() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutSFSObject() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutSFSObject() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutShort() [1/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutShort() [2/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutShort() [3/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutShort() [4/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutShortArray() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutShortArray() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutText() [1/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutText() [2/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutText() [3/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutText() [4/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutUtfString() [1/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutUtfString() [2/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutUtfString() [3/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutUtfString() [4/4]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutUtfStringArray() [1/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ PutUtfStringArray() [2/2]

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

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.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ RemoveElement() [1/2]

void Sfs2X::Entities::Data::SFSObject::RemoveElement ( string key )

virtual

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

Parameters

key	The key of the element to be removed.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ RemoveElement() [2/2]

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

virtual

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

Parameters

key	The key of the element to be removed.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ Size()

long int Sfs2X::Entities::Data::SFSObject::Size ( )

virtual

Indicates the number of elements in this object.

Returns: The number of elements in this object.

Implements Sfs2X::Entities::Data::ISFSObject.

◆ ToBinary()

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

virtual

Provides the binary form of this object.

Returns: The binary data representing this object.

Implements Sfs2X::Entities::Data::ISFSObject.

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SFSObject()

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]

◆ NewFromBinaryData()

◆ NewFromObject()

◆ NewInstance()

◆ 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]