#include <ISFSArray.h>

Inheritance diagram for Sfs2X::Entities::Data::ISFSArray:

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

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

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

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

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

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

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

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

virtual void	AddNull ()=0
	Add a null element More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Detailed Description

SFSArray interface

Member Function Documentation

◆ AddBool() [1/2]

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

pure virtual

Add a Boolean value

Parameters

val A boolean

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddBool() [2/2]

virtual void Sfs2X::Entities::Data::ISFSArray::AddBool ( bool val )

pure virtual

Add a Boolean value

Parameters

val A boolean

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddBoolArray()

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

pure virtual

Add an array of Booleans

Parameters

val A bool[]

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddByte() [1/2]

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

pure virtual

Add a byte value (8 bit)

Parameters

val	An unsigned char

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddByte() [2/2]

virtual void Sfs2X::Entities::Data::ISFSArray::AddByte ( unsigned char val )

pure virtual

Add a byte value (8 bit)

Parameters

val	An unsigned char

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddByteArray()

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

pure virtual

Add an array of bytes

Parameters

val	Pointer to a ByteArray instance

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddClass()

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

pure 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

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddDouble() [1/2]

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

pure virtual

Add a dobule value (64 bit)

Parameters

val A double

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddDouble() [2/2]

virtual void Sfs2X::Entities::Data::ISFSArray::AddDouble ( double val )

pure virtual

Add a dobule value (64 bit)

Parameters

val A double

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddDoubleArray()

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

pure virtual

Add an array of doubles

Parameters

val	A double[]

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddFloat() [1/2]

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

pure virtual

Add a float value (32 bit)

Parameters

val A float

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddFloat() [2/2]

virtual void Sfs2X::Entities::Data::ISFSArray::AddFloat ( float val )

pure virtual

Add a float value (32 bit)

Parameters

val A float

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddFloatArray()

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

pure virtual

Add an array of floats

Parameters

val A float[]

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddInt() [1/2]

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

pure virtual

Add an int value (32 bit)

Parameters

val	A long integer

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddInt() [2/2]

virtual void Sfs2X::Entities::Data::ISFSArray::AddInt ( long int val )

pure virtual

Add an int value (32 bit)

Parameters

val	A long integer

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddIntArray()

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

pure virtual

Add an array of ints

Parameters

val A int[]

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddLong() [1/2]

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

pure virtual

Add a long int value (64 bit)

Parameters

val A long

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddLong() [2/2]

virtual void Sfs2X::Entities::Data::ISFSArray::AddLong ( long long val )

pure virtual

Add a long int value (64 bit)

Parameters

val A long

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddLongArray()

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

pure virtual

Add an array of long ints

Parameters

val A long[]

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddNull()

virtual void Sfs2X::Entities::Data::ISFSArray::AddNull ( )

pure virtual

Add a null element

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddSFSArray()

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

pure virtual

Add an SFSArray

Parameters

val	Pointer to a ISFSArray instance

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddSFSObject()

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

pure virtual

Add an SFSObject

Parameters

val	Pointer to a ISFSObject instance

See also: SFSObject

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddShort() [1/2]

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

pure virtual

Add a short int value (16 bit)

Parameters

val	A short integer

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddShort() [2/2]

virtual void Sfs2X::Entities::Data::ISFSArray::AddShort ( short int val )

pure virtual

Add a short int value (16 bit)

Parameters

val	A short integer

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddShortArray()

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

pure virtual

Add an array of short ints

Parameters

val A short[]

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddText() [1/2]

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

pure 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.

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddText() [2/2]

virtual void Sfs2X::Entities::Data::ISFSArray::AddText ( string val )

pure 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.

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddUtfString() [1/2]

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

pure virtual

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

Parameters

val	A string pointer

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddUtfString() [2/2]

virtual void Sfs2X::Entities::Data::ISFSArray::AddUtfString ( string val )

pure virtual

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

Parameters

val	A string pointer

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ AddUtfStringArray()

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

pure virtual

Add an array of UTF-8 String

Parameters

val	A string[]

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ Contains()

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

pure virtual

Returns true if the passed object is contained in the Array

Parameters

obj	A void pointer

Returns: A boolean

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetBool()

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

pure virtual

Get a Boolean element at the provided index

Parameters

index An unsigned long integer

Returns: A boolean

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetBoolArray()

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

pure virtual

Get a Boolean Array element at the provided index

Parameters

index An unsigned long integer

Returns: A bool[]

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetByte()

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

pure virtual

Get a byte element at the provided index

Parameters

index An unsigned long integer

Returns: An unsigned char

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetByteArray()

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

pure virtual

Get a byte Array element at the provided index

Parameters

index An unsigned long integer

Returns: Pointer to a ByteArray instance

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetClass()

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

pure virtual

Get a class instance at the provided index.

Parameters

index An unsigned long integer

Returns: A void pointer

See also: AddClass

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetDouble()

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

pure virtual

Get a double element at the provided index

Parameters

index An unsigned long integer

Returns: A double

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetDoubleArray()

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

pure virtual

Get a double Array element at the provided index

Parameters

index An unsigned long integer

Returns: A double[]

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetDump() [1/2]

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

pure 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

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetDump() [2/2]

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

pure virtual

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

Returns: A string pointer

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetElementAt()

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

pure virtual

Returns the element at the specified index

Parameters

index A long integer

Returns: A void pointer

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetFloat()

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

pure virtual

Get a float element at the provided index

Parameters

index An unsigned long integer

Returns: A float

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetFloatArray()

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

pure virtual

Get a float Array element at the provided index

Parameters

index An unsigned long integer

Returns: A float[]

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetHexDump()

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

pure virtual

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

Returns: A string pointer

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetInt()

virtual long int Sfs2X::Entities::Data::ISFSArray::GetInt ( unsigned long int index )

pure virtual

Get an int element at the provided index

Parameters

index An unsigned long integer

Returns: A long integer

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetIntArray()

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

pure virtual

Get a int Array element at the provided index

Parameters

index An unsigned long integer

Returns: A int[]

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetLong()

virtual long long Sfs2X::Entities::Data::ISFSArray::GetLong ( unsigned long int index )

pure virtual

Get a long int element at the provided index

Parameters

index An unsigned long integer

Returns: A long

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetLongArray()

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

pure virtual

Get a lomg Array element at the provided index

Parameters

index An unsigned long integer

Returns: A long[]

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetSFSArray()

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

pure virtual

Get an SFSArray element at the provided index

Parameters

index An unsigned long integer

Returns: Pointer to a ISFSArray instance

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetSFSObject()

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

pure virtual

Get an SFSObject element at the provided index

Parameters

index An unsigned long integer

Returns: Pointer to a ISFSObject instance

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetShort()

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

pure virtual

Get a short int element at the provided index

Parameters

index An unsigned long integer

Returns: A short integer

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetShortArray()

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

pure virtual

Get a short Array element at the provided index

Parameters

index An unsigned long integer

Returns: A short[]

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetText()

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

pure 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.

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetUtfString()

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

pure 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

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ GetUtfStringArray()

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

pure virtual

Get a String Array element at the provided index

Parameters

index An unsigned long integer

Returns: A string[]

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ IsNull()

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

pure virtual

Checks if a certain element in the Array is null

Parameters

index An unsigned long integer

Returns: A boolean

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ RemoveElementAt()

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

pure virtual

Remove the element at the specified index

Parameters

index An unsigned long integer

Returns: A void pointer

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ Size()

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

pure virtual

Return the number of elements in the Array

Returns: A long integer

Implemented in Sfs2X::Entities::Data::SFSArray.

◆ ToBinary()

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

pure virtual

Return the binary form of the object

Returns: Pointer to a ByteArray instance

Implemented in Sfs2X::Entities::Data::SFSArray.

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()

◆ RemoveElementAt()

◆ Size()

◆ ToBinary()