#include <SFSArray.h>

Inheritance diagram for Sfs2X::Entities::Data::SFSArray:

Public Member Functions
bool	Contains (boost::shared_ptr< void > obj)
	Returns true if the passed object is contained in the Array More...

boost::shared_ptr< void >	GetElementAt (long int index)
	Returns the element at the specified index More...

boost::shared_ptr< void >	RemoveElementAt (unsigned long int index)
	Remove the element at the specified index More...

long int	Size ()
	Return the number of elements in the Array More...

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

boost::shared_ptr< string >	GetDump ()
	Return a formatted dump of the object that can logged or traced in the console for debugging purposes. More...

boost::shared_ptr< string >	GetDump (bool format)
	Return a formatted dump of the object that can logged or traced in the console for debugging purposes. More...

boost::shared_ptr< string >	GetHexDump ()
	Returns a detailed hex-dump of the object that can logged or traced in the console for debugging purposes. More...

void	AddNull ()
	Add a null element More...

void	AddBool (boost::shared_ptr< bool > val)
	Add a Boolean value More...

void	AddBool (bool val)
	Add a Boolean value More...

void	AddByte (boost::shared_ptr< unsigned char > val)
	Add a byte value (8 bit) More...

void	AddByte (unsigned char val)
	Add a byte value (8 bit) More...

void	AddShort (boost::shared_ptr< short int > val)
	Add a short int value (16 bit) More...

void	AddShort (short int val)
	Add a short int value (16 bit) More...

void	AddInt (boost::shared_ptr< long int > val)
	Add an int value (32 bit) More...

void	AddInt (long int val)
	Add an int value (32 bit) More...

void	AddLong (boost::shared_ptr< long long > val)
	Add a long int value (64 bit) More...

void	AddLong (long long val)
	Add a long int value (64 bit) More...

void	AddFloat (boost::shared_ptr< float > val)
	Add a float value (32 bit) More...

void	AddFloat (float val)
	Add a float value (32 bit) More...

void	AddDouble (boost::shared_ptr< double > val)
	Add a dobule value (64 bit) More...

void	AddDouble (double val)
	Add a dobule value (64 bit) More...

void	AddUtfString (boost::shared_ptr< string > val)
	Appends a UTF-8 string (with max length of 32 KBytes) value to the end of this array. More...

void	AddUtfString (string val)
	Appends a UTF-8 string (with max length of 32 KBytes) value to the end of this array. More...

void	AddText (boost::shared_ptr< string > val)
	Appends a UTF-8 string (with max length of 2 GBytes) value to the end of this array. More...

void	AddText (string val)
	Appends a UTF-8 string (with max length of 2 GBytes) value to the end of this array. More...

void	AddBoolArray (boost::shared_ptr< vector< boost::shared_ptr< bool > > > val)
	Add an array of Booleans More...

void	AddByteArray (boost::shared_ptr< ByteArray > val)
	Add an array of bytes More...

void	AddShortArray (boost::shared_ptr< vector< boost::shared_ptr< short int > > > val)
	Add an array of short ints More...

void	AddIntArray (boost::shared_ptr< vector< boost::shared_ptr< long int > > > val)
	Add an array of ints More...

void	AddLongArray (boost::shared_ptr< vector< boost::shared_ptr< long long > > > val)
	Add an array of long ints More...

void	AddFloatArray (boost::shared_ptr< vector< boost::shared_ptr< float > > > val)
	Add an array of floats More...

void	AddDoubleArray (boost::shared_ptr< vector< boost::shared_ptr< double > > > val)
	Add an array of doubles More...

void	AddUtfStringArray (boost::shared_ptr< vector< boost::shared_ptr< string > > > val)
	Add an array of UTF-8 String More...

void	AddSFSArray (boost::shared_ptr< ISFSArray > val)
	Add an SFSArray More...

void	AddSFSObject (boost::shared_ptr< ISFSObject > val)
	Add an SFSObject More...

void	AddClass (boost::shared_ptr< void > val)
	Add an instance of a custom Class. More...

bool	IsNull (unsigned long int index)
	Checks if a certain element in the Array is null More...

bool	GetBool (unsigned long int index)
	Get a Boolean element at the provided index More...

unsigned char	GetByte (unsigned long int index)
	Get a byte element at the provided index More...

short int	GetShort (unsigned long int index)
	Get a short int element at the provided index More...

long int	GetInt (unsigned long int index)
	Get an int element at the provided index More...

long long	GetLong (unsigned long int index)
	Get a long int element at the provided index More...

float	GetFloat (unsigned long int index)
	Get a float element at the provided index More...

double	GetDouble (unsigned long int index)
	Get a double element at the provided index More...

boost::shared_ptr< string >	GetUtfString (unsigned long int index)
	Returns the element at the specified position as an UTF-8 string, with max length of 32 KBytes. More...

boost::shared_ptr< string >	GetText (unsigned long int index)
	Returns the element at the specified position as an UTF-8 string, with max length of 2 GBytes. More...

boost::shared_ptr< vector< bool > >	GetBoolArray (unsigned long int index)
	Get a Boolean Array element at the provided index More...

boost::shared_ptr< ByteArray >	GetByteArray (unsigned long int index)
	Get a byte Array element at the provided index More...

boost::shared_ptr< vector< short int > >	GetShortArray (unsigned long int index)
	Get a short Array element at the provided index More...

boost::shared_ptr< vector< long int > >	GetIntArray (unsigned long int index)
	Get a int Array element at the provided index More...

boost::shared_ptr< vector< long long > >	GetLongArray (unsigned long int index)
	Get a lomg Array element at the provided index More...

boost::shared_ptr< vector< float > >	GetFloatArray (unsigned long int index)
	Get a float Array element at the provided index More...

boost::shared_ptr< vector< double > >	GetDoubleArray (unsigned long int index)
	Get a double Array element at the provided index More...

boost::shared_ptr< vector< string > >	GetUtfStringArray (unsigned long int index)
	Get a String Array element at the provided index More...

boost::shared_ptr< ISFSArray >	GetSFSArray (unsigned long int index)
	Get an SFSArray element at the provided index More...

boost::shared_ptr< void >	GetClass (unsigned long int index)
	Get a class instance at the provided index. More...

boost::shared_ptr< ISFSObject >	GetSFSObject (unsigned long int index)
	Get an SFSObject element at the provided index More...

Static Public Member Functions
static boost::shared_ptr< SFSArray >	NewFromArray (vector< boost::shared_ptr< SFSDataWrapper > > o)
	Alternative static constructor that builds an SFSArray populated with the data found in the passed Array More...

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

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

Detailed Description

SFSArray

SFSArray is used from server and client side to exchange data. It can be thought of a specialized Array/List object that can contain any type of data. The advantage of using SFSArray 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)

SFSArray 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: SFSObject

Member Function Documentation

◆ AddBool() [1/2]

void Sfs2X::Entities::Data::SFSArray::AddBool ( boost::shared_ptr< bool > val )

virtual

Add a Boolean value

Parameters

val A boolean

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddBool() [2/2]

void Sfs2X::Entities::Data::SFSArray::AddBool ( bool val )

virtual

Add a Boolean value

Parameters

val A boolean

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddBoolArray()

void Sfs2X::Entities::Data::SFSArray::AddBoolArray ( boost::shared_ptr< vector< boost::shared_ptr< bool > > > val )

virtual

Add an array of Booleans

Parameters

val A bool[]

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddByte() [1/2]

void Sfs2X::Entities::Data::SFSArray::AddByte ( boost::shared_ptr< unsigned char > val )

virtual

Add a byte value (8 bit)

Parameters

val	An unsigned char

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddByte() [2/2]

void Sfs2X::Entities::Data::SFSArray::AddByte ( unsigned char val )

virtual

Add a byte value (8 bit)

Parameters

val	An unsigned char

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddByteArray()

void Sfs2X::Entities::Data::SFSArray::AddByteArray ( boost::shared_ptr< ByteArray > val )

virtual

Add an array of bytes

Parameters

val	Pointer to a ByteArray instance

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddClass()

void Sfs2X::Entities::Data::SFSArray::AddClass ( boost::shared_ptr< void > val )

virtual

Add an instance of a custom Class.

This is an advanced feature that allows to transmit object instances between Actionscript and Java provided that both classes are definined under the same package name.

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<SpaceShip> mySpaceShip = (boost::shared_ptr<SpaceShip>)sfsArray->getClass(0)

Parameters

val	A void pointer

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddDouble() [1/2]

void Sfs2X::Entities::Data::SFSArray::AddDouble ( boost::shared_ptr< double > val )

virtual

Add a dobule value (64 bit)

Parameters

val A double

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddDouble() [2/2]

void Sfs2X::Entities::Data::SFSArray::AddDouble ( double val )

virtual

Add a dobule value (64 bit)

Parameters

val A double

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddDoubleArray()

void Sfs2X::Entities::Data::SFSArray::AddDoubleArray ( boost::shared_ptr< vector< boost::shared_ptr< double > > > val )

virtual

Add an array of doubles

Parameters

val	A double[]

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddFloat() [1/2]

void Sfs2X::Entities::Data::SFSArray::AddFloat ( boost::shared_ptr< float > val )

virtual

Add a float value (32 bit)

Parameters

val A float

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddFloat() [2/2]

void Sfs2X::Entities::Data::SFSArray::AddFloat ( float val )

virtual

Add a float value (32 bit)

Parameters

val A float

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddFloatArray()

void Sfs2X::Entities::Data::SFSArray::AddFloatArray ( boost::shared_ptr< vector< boost::shared_ptr< float > > > val )

virtual

Add an array of floats

Parameters

val A float[]

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddInt() [1/2]

void Sfs2X::Entities::Data::SFSArray::AddInt ( boost::shared_ptr< long int > val )

virtual

Add an int value (32 bit)

Parameters

val	A long integer

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddInt() [2/2]

void Sfs2X::Entities::Data::SFSArray::AddInt ( long int val )

virtual

Add an int value (32 bit)

Parameters

val	A long integer

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddIntArray()

void Sfs2X::Entities::Data::SFSArray::AddIntArray ( boost::shared_ptr< vector< boost::shared_ptr< long int > > > val )

virtual

Add an array of ints

Parameters

val A int[]

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddLong() [1/2]

void Sfs2X::Entities::Data::SFSArray::AddLong ( boost::shared_ptr< long long > val )

virtual

Add a long int value (64 bit)

Parameters

val A long

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddLong() [2/2]

void Sfs2X::Entities::Data::SFSArray::AddLong ( long long val )

virtual

Add a long int value (64 bit)

Parameters

val A long

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddLongArray()

void Sfs2X::Entities::Data::SFSArray::AddLongArray ( boost::shared_ptr< vector< boost::shared_ptr< long long > > > val )

virtual

Add an array of long ints

Parameters

val A long[]

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddNull()

void Sfs2X::Entities::Data::SFSArray::AddNull ( )

virtual

Add a null element

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddSFSArray()

void Sfs2X::Entities::Data::SFSArray::AddSFSArray ( boost::shared_ptr< ISFSArray > val )

virtual

Add an SFSArray

Parameters

val	Pointer to a ISFSArray instance

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddSFSObject()

void Sfs2X::Entities::Data::SFSArray::AddSFSObject ( boost::shared_ptr< ISFSObject > val )

virtual

Add an SFSObject

Parameters

val	Pointer to a ISFSObject instance

See also: SFSObject

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddShort() [1/2]

void Sfs2X::Entities::Data::SFSArray::AddShort ( boost::shared_ptr< short int > val )

virtual

Add a short int value (16 bit)

Parameters

val	A short integer

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddShort() [2/2]

void Sfs2X::Entities::Data::SFSArray::AddShort ( short int val )

virtual

Add a short int value (16 bit)

Parameters

val	A short integer

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddShortArray()

void Sfs2X::Entities::Data::SFSArray::AddShortArray ( boost::shared_ptr< vector< boost::shared_ptr< short int > > > val )

virtual

Add an array of short ints

Parameters

val A short[]

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddText() [1/2]

void Sfs2X::Entities::Data::SFSArray::AddText ( boost::shared_ptr< string > val )

virtual

Appends a UTF-8 string (with max length of 2 GBytes) value to the end of this array.

Parameters

val	The value to be appended to this array.

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddText() [2/2]

void Sfs2X::Entities::Data::SFSArray::AddText ( string val )

virtual

Appends a UTF-8 string (with max length of 2 GBytes) value to the end of this array.

Parameters

val	The value to be appended to this array.

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddUtfString() [1/2]

void Sfs2X::Entities::Data::SFSArray::AddUtfString ( boost::shared_ptr< string > val )

virtual

Appends a UTF-8 string (with max length of 32 KBytes) value to the end of this array.

Parameters

val	A string pointer

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddUtfString() [2/2]

void Sfs2X::Entities::Data::SFSArray::AddUtfString ( string val )

virtual

Appends a UTF-8 string (with max length of 32 KBytes) value to the end of this array.

Parameters

val	A string pointer

Implements Sfs2X::Entities::Data::ISFSArray.

◆ AddUtfStringArray()

void Sfs2X::Entities::Data::SFSArray::AddUtfStringArray ( boost::shared_ptr< vector< boost::shared_ptr< string > > > val )

virtual

Add an array of UTF-8 String

Parameters

val	A string[]

Implements Sfs2X::Entities::Data::ISFSArray.

◆ Contains()

bool Sfs2X::Entities::Data::SFSArray::Contains ( boost::shared_ptr< void > obj )

virtual

Returns true if the passed object is contained in the Array

Parameters

obj	A void pointer

Returns: A boolean

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetBool()

bool Sfs2X::Entities::Data::SFSArray::GetBool ( unsigned long int index )

virtual

Get a Boolean element at the provided index

Parameters

index An unsigned long integer

Returns: A boolean

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetBoolArray()

boost::shared_ptr< vector< bool > > Sfs2X::Entities::Data::SFSArray::GetBoolArray ( unsigned long int index )

virtual

Get a Boolean Array element at the provided index

Parameters

index An unsigned long integer

Returns: A bool[]

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetByte()

unsigned char Sfs2X::Entities::Data::SFSArray::GetByte ( unsigned long int index )

virtual

Get a byte element at the provided index

Parameters

index An unsigned long integer

Returns: An unsigned char

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetByteArray()

boost::shared_ptr< ByteArray > Sfs2X::Entities::Data::SFSArray::GetByteArray ( unsigned long int index )

virtual

Get a byte Array element at the provided index

Parameters

index An unsigned long integer

Returns: Pointer to a ByteArray instance

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetClass()

boost::shared_ptr< void > Sfs2X::Entities::Data::SFSArray::GetClass ( unsigned long int index )

virtual

Get a class instance at the provided index.

Parameters

index An unsigned long integer

Returns: A void pointer

See also: AddClass

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetDouble()

double Sfs2X::Entities::Data::SFSArray::GetDouble ( unsigned long int index )

virtual

Get a double element at the provided index

Parameters

index An unsigned long integer

Returns: A double

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetDoubleArray()

boost::shared_ptr< vector< double > > Sfs2X::Entities::Data::SFSArray::GetDoubleArray ( unsigned long int index )

virtual

Get a double Array element at the provided index

Parameters

index An unsigned long integer

Returns: A double[]

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetDump() [1/2]

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

virtual

Return a formatted dump of the object that can logged or traced in the console for debugging purposes.

Returns: A string pointer

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetDump() [2/2]

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

virtual

Return a formatted dump of the object that can logged or traced in the console for debugging purposes.

Parameters

format turns the "pretty print" on/off

Returns: A string pointer

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetElementAt()

boost::shared_ptr< void > Sfs2X::Entities::Data::SFSArray::GetElementAt ( long int index )

virtual

Returns the element at the specified index

Parameters

index A long integer

Returns: A void pointer

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetFloat()

float Sfs2X::Entities::Data::SFSArray::GetFloat ( unsigned long int index )

virtual

Get a float element at the provided index

Parameters

index An unsigned long integer

Returns: A float

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetFloatArray()

boost::shared_ptr< vector< float > > Sfs2X::Entities::Data::SFSArray::GetFloatArray ( unsigned long int index )

virtual

Get a float Array element at the provided index

Parameters

index An unsigned long integer

Returns: A float[]

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetHexDump()

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

virtual

Returns a detailed hex-dump of the object that can logged or traced in the console for debugging purposes.

Returns: A string pointer

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetInt()

long int Sfs2X::Entities::Data::SFSArray::GetInt ( unsigned long int index )

virtual

Get an int element at the provided index

Parameters

index An unsigned long integer

Returns: A long integer

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetIntArray()

boost::shared_ptr< vector< long int > > Sfs2X::Entities::Data::SFSArray::GetIntArray ( unsigned long int index )

virtual

Get a int Array element at the provided index

Parameters

index An unsigned long integer

Returns: A int[]

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetLong()

long long Sfs2X::Entities::Data::SFSArray::GetLong ( unsigned long int index )

virtual

Get a long int element at the provided index

Parameters

index An unsigned long integer

Returns: A long

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetLongArray()

boost::shared_ptr< vector< long long > > Sfs2X::Entities::Data::SFSArray::GetLongArray ( unsigned long int index )

virtual

Get a lomg Array element at the provided index

Parameters

index An unsigned long integer

Returns: A long[]

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetSFSArray()

boost::shared_ptr< ISFSArray > Sfs2X::Entities::Data::SFSArray::GetSFSArray ( unsigned long int index )

virtual

Get an SFSArray element at the provided index

Parameters

index An unsigned long integer

Returns: Pointer to a ISFSArray instance

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetSFSObject()

boost::shared_ptr< ISFSObject > Sfs2X::Entities::Data::SFSArray::GetSFSObject ( unsigned long int index )

virtual

Get an SFSObject element at the provided index

Parameters

index An unsigned long integer

Returns: Pointer to a ISFSObject instance

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetShort()

short int Sfs2X::Entities::Data::SFSArray::GetShort ( unsigned long int index )

virtual

Get a short int element at the provided index

Parameters

index An unsigned long integer

Returns: A short integer

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetShortArray()

boost::shared_ptr< vector< short int > > Sfs2X::Entities::Data::SFSArray::GetShortArray ( unsigned long int index )

virtual

Get a short Array element at the provided index

Parameters

index An unsigned long integer

Returns: A short[]

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetText()

boost::shared_ptr< string > Sfs2X::Entities::Data::SFSArray::GetText ( unsigned long int index )

virtual

Returns the element at the specified position as an UTF-8 string, with max length of 2 GBytes.

Parameters

index The position of the element to return.

Returns: The element of this array at the specified index.

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetUtfString()

boost::shared_ptr< string > Sfs2X::Entities::Data::SFSArray::GetUtfString ( unsigned long int index )

virtual

Returns the element at the specified position as an UTF-8 string, with max length of 32 KBytes.

Parameters

index An unsigned long integer

Returns: A string pointer

Implements Sfs2X::Entities::Data::ISFSArray.

◆ GetUtfStringArray()

boost::shared_ptr< vector< string > > Sfs2X::Entities::Data::SFSArray::GetUtfStringArray ( unsigned long int index )

virtual

Get a String Array element at the provided index

Parameters

index An unsigned long integer

Returns: A string[]

Implements Sfs2X::Entities::Data::ISFSArray.

◆ IsNull()

bool Sfs2X::Entities::Data::SFSArray::IsNull ( unsigned long int index )

virtual

Checks if a certain element in the Array is null

Parameters

index An unsigned long integer

Returns: A boolean

Implements Sfs2X::Entities::Data::ISFSArray.

◆ NewFromArray()

boost::shared_ptr< SFSArray > Sfs2X::Entities::Data::SFSArray::NewFromArray ( vector< boost::shared_ptr< SFSDataWrapper > > o )

static

Alternative static constructor that builds an SFSArray populated with the data found in the passed Array

Parameters

o	A vector of SFSDataWrapper pointers

Returns: Pointer to an SFSArray instance

◆ NewFromBinaryData()

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

static

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

Parameters

ba	Pointer to a ByteArray instance

Returns: Pointer to a SFSArray instance

◆ NewInstance()

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

static

Alternative static constructor

Returns: Pointer to a SFSArray instance

◆ RemoveElementAt()

boost::shared_ptr< void > Sfs2X::Entities::Data::SFSArray::RemoveElementAt ( unsigned long int index )

virtual

Remove the element at the specified index

Parameters

index An unsigned long integer

Returns: A void pointer

Implements Sfs2X::Entities::Data::ISFSArray.

◆ Size()

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

virtual

Return the number of elements in the Array

Returns: A long integer

Implements Sfs2X::Entities::Data::ISFSArray.

◆ ToBinary()

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

virtual

Return the binary form of the object

Returns: Pointer to a ByteArray instance

Implements Sfs2X::Entities::Data::ISFSArray.

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ AddBool() [1/2]

◆ AddBool() [2/2]

◆ AddBoolArray()

◆ AddByte() [1/2]

◆ AddByte() [2/2]

◆ AddByteArray()

◆ AddClass()

◆ AddDouble() [1/2]

◆ AddDouble() [2/2]

◆ AddDoubleArray()

◆ AddFloat() [1/2]

◆ AddFloat() [2/2]

◆ AddFloatArray()

◆ AddInt() [1/2]

◆ AddInt() [2/2]

◆ AddIntArray()

◆ AddLong() [1/2]

◆ AddLong() [2/2]

◆ AddLongArray()

◆ AddNull()

◆ AddSFSArray()

◆ AddSFSObject()

◆ AddShort() [1/2]

◆ AddShort() [2/2]

◆ AddShortArray()

◆ AddText() [1/2]

◆ AddText() [2/2]

◆ AddUtfString() [1/2]

◆ AddUtfString() [2/2]

◆ AddUtfStringArray()

◆ Contains()

◆ GetBool()

◆ GetBoolArray()

◆ GetByte()

◆ GetByteArray()

◆ GetClass()

◆ GetDouble()

◆ GetDoubleArray()

◆ GetDump() [1/2]

◆ GetDump() [2/2]

◆ GetElementAt()

◆ GetFloat()

◆ GetFloatArray()

◆ GetHexDump()

◆ GetInt()

◆ GetIntArray()

◆ GetLong()

◆ GetLongArray()

◆ GetSFSArray()

◆ GetSFSObject()

◆ GetShort()

◆ GetShortArray()

◆ GetText()

◆ GetUtfString()

◆ GetUtfStringArray()

◆ IsNull()

◆ NewFromArray()

◆ NewFromBinaryData()

◆ NewInstance()

◆ RemoveElementAt()

◆ Size()

◆ ToBinary()