The PTupleSpace Class

Derived from: None

Declared in: PTupleSpace.h


Overview

This class is useful for storing items of various types into a space consisting of tuples. Each tuple in the space has a unique name, and can contain any number of items. In addition, each tuple can contain items of various types. Using the PTupleSpace class provides a very powerful way of storing, and at the same time, grouping items of various types in the same space.

The PTupleSpace is not thread safe as it is. If you have more than one thread to access the list, you can use any of the synchronize classes to do that.


Constructor and Destructor


PTupleSpace()

          PTupleSpace(void);

The constructor creates an empty tuple space, which is ready to be used.


~PTupleSpace()

          virtual ~PTupleSpace(void);

The destructor will empty the tuple space and destroy it.


Member Functions


AddBool()

          void AddBool(PString name, bool aBool);

This function adds a bool value to the tail of the tuple entry associated with the specified name. If no tuple entry exist with the specified name, then a new tuple entry will be created with the specified name, which the bool will be added into.


AddDouble()

          void AddDouble(PString name, double aDouble);

This function adds a double value to the tail of the tuple entry associated with the specified name. If no tuple entry exist with the specified name, then a new tuple entry will be created with the specified name, which the double will be added into.


AddFloat()

          void AddFloat(PString name, float aFloat);

This function adds a float value to the tail of the tuple entry associated with the specified name. If no tuple entry exist with the specified name, then a new tuple entry will be created with the specified name, which the float will be added into.


AddInt8()

          void AddInt8(PString name, int8 aInt8);

This function adds an int8 value to the tail of the tuple entry associated with the specified name. If no tuple entry exist with the specified name, then a new tuple entry will be created with the specified name, which the int8 will be added into.


AddInt16()

          void AddInt16(PString name, int16 aInt16);

This function adds an int16 value to the tail of the tuple entry associated with the specified name. If no tuple entry exist with the specified name, then a new tuple entry will be created with the specified name, which the int16 will be added into.


AddInt32()

          void AddInt32(PString name, int32 aInt32);

This function adds an int32 value to the tail of the tuple entry associated with the specified name. If no tuple entry exist with the specified name, then a new tuple entry will be created with the specified name, which the int32 will be added into.


AddInt64()

          void AddInt64(PString name, int64 aInt64);

This function adds an int64 value to the tail of the tuple entry associated with the specified name. If no tuple entry exist with the specified name, then a new tuple entry will be created with the specified name, which the int64 will be added into.


AddPointer()

          void AddPointer(PString name, const void *aPointer);

This function adds a void pointer to the tail of the tuple entry associated with the specified name. If no tuple entry exist with the specified name, then a new tuple entry will be created with the specified name, which the void pointer will be added into.


CountNames()

          uint32 CountNames(void) const;

This function returns the number of tuple entry names, which the tuple space currently contains.


GetAndRemoveBool()

          bool GetAndRemoveBool(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns a bool from a tuple entry in the tuple space associated with the specified name. This bool is removed from the tuple entry in the tuple space. If no bool exists at the tuple entry associated with the specified name, then a PKeyException will be thrown. If the tuple entry will be empty, when the bool is removed, then the tuple entry will be removed from the tuple space.

The index specify the bool type's location at the tuple entry, where index 0 specify the first bool value, index 1 specify the second bool value and so forth. If no index is specified, then the first bool value is returned. If no bool type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetAndRemoveDouble()

          double GetAndRemoveDouble(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns a double from a tuple entry in the tuple space associated with the specified name. This double is removed from the tuple entry in the tuple space. If no double exists at the tuple entry associated with the specified name, then a PKeyException will be thrown. If the tuple entry will be empty, when the double is removed, then the tuple entry will be removed from the tuple space.

The index specify the double type's location at the tuple entry, where index 0 specify the first double value, index 1 specify the second double value and so forth. If no index is specified, then the first double value is returned. If no double type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetAndRemoveFloat()

          float GetAndRemoveFloat(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns a float from a tuple entry in the tuple space associated with the specified name. This float is removed from the tuple entry in the tuple space. If no float exists at the tuple entry associated with the specified name, then a PKeyException will be thrown. If the tuple entry will be empty, when the float is removed, then the tuple entry will be removed from the tuple space.

The index specify the float type's location at the tuple entry, where index 0 specify the first float value, index 1 specify the second float value and so forth. If no index is specified, then the first float value is returned. If no float type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetAndRemoveInt8()

          int8 GetAndRemoveInt8(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns an int8 from a tuple entry in the tuple space associated with the specified name. This int8 is removed from the tuple entry in the tuple space. If no int8 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown. If the tuple entry will be empty, when the int8 is removed, then the tuple entry will be removed from the tuple space.

The index specify the int8 type's location at the tuple entry, where index 0 specify the first int8 value, index 1 specify the second int8 value and so forth. If no index is specified, then the first int8 value is returned. If no int8 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetAndRemoveInt16()

          int16 GetAndRemoveInt16(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns an int16 from a tuple entry in the tuple space associated with the specified name. This int16 is removed from the tuple entry in the tuple space. If no int16 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown. If the tuple entry will be empty, when the int16 is removed, then the tuple entry will be removed from the tuple space.

The index specify the int16 type's location at the tuple entry, where index 0 specify the first int16 value, index 1 specify the second int16 value and so forth. If no index is specified, then the first int16 value is returned. If no int16 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetAndRemoveInt32()

          int32 GetAndRemoveInt32(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns an int32 from a tuple entry in the tuple space associated with the specified name. This int32 is removed from the tuple entry in the tuple space. If no int32 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown. If the tuple entry will be empty, when the int32 is removed, then the tuple entry will be removed from the tuple space.

The index specify the int32 type's location at the tuple entry, where index 0 specify the first int32 value, index 1 specify the second int32 value and so forth. If no index is specified, then the first int32 value is returned. If no int32 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetAndRemoveInt64()

          int64 GetAndRemoveInt64(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns an int64 from a tuple entry in the tuple space associated with the specified name. This int64 is removed from the tuple entry in the tuple space. If no int64 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown. If the tuple entry will be empty, when the int64 is removed, then the tuple entry will be removed from the tuple space.

The index specify the int64 type's location at the tuple entry, where index 0 specify the first int64 value, index 1 specify the second int64 value and so forth. If no index is specified, then the first int64 value is returned. If no int64 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetAndRemovePointer()

          const void *GetAndRemovePointer(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns a void pointer from a tuple entry in the tuple space associated with the specified name. This void pointer is removed from the tuple entry in the tuple space. If no void pointer exists at the tuple entry associated with the specified name, then a PKeyException will be thrown. If the tuple entry will be empty, when the void pointer is removed, then the tuple entry will be removed from the tuple space.

The index specify the void pointer type's location at the tuple entry, where index 0 specify the first void pointer, index 1 specify the second void pointer and so forth. If no index is specified, then the first void pointer is returned. If no void pointer type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetAndSetBool()

          bool GetAndSetBool(PString name, bool newBool, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns a bool from a tuple entry in the tuple space associated with the specified name. This bool is set to a new value in the tuple entry in the tuple space. If no bool exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the bool type's location at the tuple entry, where index 0 specify the first bool value, index 1 specify the second bool value and so forth. If no index is specified, then the first bool value is returned. If no bool type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetAndSetDouble()

          double GetAndSetDouble(PString name, double newDouble, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns a double from a tuple entry in the tuple space associated with the specified name. This double is set to a new value in the tuple entry in the tuple space. If no double exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the double type's location at the tuple entry, where index 0 specify the first double value, index 1 specify the second double value and so forth. If no index is specified, then the first double value is returned. If no double type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetAndSetFloat()

          float GetAndSetInt8(PString name, float newFloat, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns a float from a tuple entry in the tuple space associated with the specified name. This float is set to a new value in the tuple entry in the tuple space. If no float exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the float type's location at the tuple entry, where index 0 specify the first float value, index 1 specify the second float value and so forth. If no index is specified, then the first float value is returned. If no float type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetAndSetInt8()

          int8 GetAndSetInt8(PString name, int8 newInt8, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns an int8 from a tuple entry in the tuple space associated with the specified name. This int8 is set to a new value in the tuple entry in the tuple space. If no int8 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the int8 type's location at the tuple entry, where index 0 specify the first int8 value, index 1 specify the second int8 value and so forth. If no index is specified, then the first int8 value is returned. If no int8 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetAndSetInt16()

          int16 GetAndSetInt16(PString name, int16 newInt16, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns an int16 from a tuple entry in the tuple space associated with the specified name. This int16 is set to a new value in the tuple entry in the tuple space. If no int16 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the int16 type's location at the tuple entry, where index 0 specify the first int16 value, index 1 specify the second int16 value and so forth. If no index is specified, then the first int16 value is returned. If no int16 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetAndSetInt32()

          int32 GetAndSetInt32(PString name, int32 newInt32, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns an int32 from a tuple entry in the tuple space associated with the specified name. This int32 is set to a new value in the tuple entry in the tuple space. If no int32 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the int32 type's location at the tuple entry, where index 0 specify the first int32 value, index 1 specify the second int32 value and so forth. If no index is specified, then the first int32 value is returned. If no int32 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetAndSetInt64()

          int64 GetAndSetInt64(PString name, int64 newInt64, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns an int64 from a tuple entry in the tuple space associated with the specified name. This int64 is set to a new value in the tuple entry in the tuple space. If no int64 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the int64 type's location at the tuple entry, where index 0 specify the first int64 value, index 1 specify the second int64 value and so forth. If no index is specified, then the first int64 value is returned. If no int64 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetAndSetPointer()

          const void *GetAndSetPointer(PString name, const void *newPointer, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns a void pointer from a tuple entry in the tuple space associated with the specified name. This void pointer is set to a new value in the tuple entry in the tuple space. If no void pointer exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the void pointer type's location at the tuple entry, where index 0 specify the first void pointer, index 1 specify the second void pointer and so forth. If no index is specified, then the first void pointer is returned. If no void pointer type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetBool()

          bool GetBool(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns a bool from a tuple entry in the tuple space associated with the specified name. If no bool exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the bool type's location at the tuple entry, where index 0 specify the first bool value, index 1 specify the second bool value and so forth. If no index is specified, then the first bool value is returned. If no bool type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetDouble()

          double GetDouble(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns a double from a tuple entry in the tuple space associated with the specified name. If no double exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the double type's location at the tuple entry, where index 0 specify the first double value, index 1 specify the second double value and so forth. If no index is specified, then the first double value is returned. If no double type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetFloat()

          float GetFloat(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns a float from a tuple entry in the tuple space associated with the specified name. If no float exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the float type's location at the tuple entry, where index 0 specify the first float value, index 1 specify the second float value and so forth. If no index is specified, then the first float value is returned. If no float type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetInt8()

          int8 GetInt8(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns an int8 from a tuple entry in the tuple space associated with the specified name. If no int8 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the int8 type's location at the tuple entry, where index 0 specify the first int8 value, index 1 specify the second int8 value and so forth. If no index is specified, then the first int8 value is returned. If no int8 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetInt16()

          int16 GetInt16(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns an int16 from a tuple entry in the tuple space associated with the specified name. If no int16 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the int16 type's location at the tuple entry, where index 0 specify the first int16 value, index 1 specify the second int16 value and so forth. If no index is specified, then the first int16 value is returned. If no int16 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetInt32()

          int32 GetInt32(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns an int32 from a tuple entry in the tuple space associated with the specified name. If no int32 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the int32 type's location at the tuple entry, where index 0 specify the first int32 value, index 1 specify the second int32 value and so forth. If no index is specified, then the first int32 value is returned. If no int32 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetInt64()

          int64 GetInt64(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns an int64 from a tuple entry in the tuple space associated with the specified name. If no int64 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the int64 type's location at the tuple entry, where index 0 specify the first int64 value, index 1 specify the second int64 value and so forth. If no index is specified, then the first int64 value is returned. If no int64 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


GetPointer()

          const void *GetPointer(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function returns a void pointer from a tuple entry in the tuple space associated with the specified name. If no void pointer exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the void pointer type's location at the tuple entry, where index 0 specify the first void pointer, index 1 specify the second void pointer and so forth. If no index is specified, then the first void pointer is returned. If no void pointer type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


IsEmpty()

          virtual bool IsEmpty(void) const;

This function will test if the tuple space is empty. If the tuple space is empty, it will return true. Otherwise it will return false.


MakeEmpty()

          virtual void MakeEmpty(void);

This function removes all tuple entries and the items they contain from the tuple space.


RemoveBool()

          void RemoveBool(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function removes a bool from a tuple entry in the tuple space associated with the specified name. If no bool exists at the tuple entry associated with the specified name, then a PKeyException will be thrown. If the tuple entry will be empty, when the bool is removed, then the tuple entry will be removed from the tuple space.

The index specify the bool type's location at the tuple entry, where index 0 specify the first bool value, index 1 specify the second bool value and so forth. If no index is specified, then the first bool value is removed. If no bool type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


RemoveDouble()

          void RemoveDouble(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function removes a double from a tuple entry in the tuple space associated with the specified name. If no double exists at the tuple entry associated with the specified name, then a PKeyException will be thrown. If the tuple entry will be empty, when the double is removed, then the tuple entry will be removed from the tuple space.

The index specify the double type's location at the tuple entry, where index 0 specify the first double value, index 1 specify the second double value and so forth. If no index is specified, then the first double value is removed. If no double type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


RemoveFloat()

          void RemoveFloat(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function removes a float from a tuple entry in the tuple space associated with the specified name. If no float exists at the tuple entry associated with the specified name, then a PKeyException will be thrown. If the tuple entry will be empty, when the float is removed, then the tuple entry will be removed from the tuple space.

The index specify the float type's location at the tuple entry, where index 0 specify the first float value, index 1 specify the second float value and so forth. If no index is specified, then the first float value is removed. If no float type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


RemoveInt8()

          void RemoveInt8(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function removes a int8 from a tuple entry in the tuple space associated with the specified name. If no int8 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown. If the tuple entry will be empty, when the int8 is removed, then the tuple entry will be removed from the tuple space.

The index specify the int8 type's location at the tuple entry, where index 0 specify the first int8 value, index 1 specify the second int8 value and so forth. If no index is specified, then the first int8 value is removed. If no int8 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


RemoveInt16()

          void RemoveInt16(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function removes a int16 from a tuple entry in the tuple space associated with the specified name. If no int16 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown. If the tuple entry will be empty, when the int16 is removed, then the tuple entry will be removed from the tuple space.

The index specify the int16 type's location at the tuple entry, where index 0 specify the first int16 value, index 1 specify the second int16 value and so forth. If no index is specified, then the first int16 value is removed. If no int16 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


RemoveInt32()

          void RemoveInt32(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function removes a int32 from a tuple entry in the tuple space associated with the specified name. If no int32 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown. If the tuple entry will be empty, when the int32 is removed, then the tuple entry will be removed from the tuple space.

The index specify the int32 type's location at the tuple entry, where index 0 specify the first int32 value, index 1 specify the second int32 value and so forth. If no index is specified, then the first int32 value is removed. If no int32 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


RemoveInt64()

          void RemoveInt64(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function removes a int64 from a tuple entry in the tuple space associated with the specified name. If no int64 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown. If the tuple entry will be empty, when the int64 is removed, then the tuple entry will be removed from the tuple space.

The index specify the int64 type's location at the tuple entry, where index 0 specify the first int64 value, index 1 specify the second int64 value and so forth. If no index is specified, then the first int64 value is removed. If no int64 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


RemovePointer()

          void RemovePointer(PString name, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function removes a void pointer from a tuple entry in the tuple space associated with the specified name. If no void pointer exists at the tuple entry associated with the specified name, then a PKeyException will be thrown. If the tuple entry will be empty, when the void pointer is removed, then the tuple entry will be removed from the tuple space.

The index specify the void pointer type's location at the tuple entry, where index 0 specify the first void pointer, index 1 specify the second void pointer and so forth. If no index is specified, then the first void pointer is removed. If no void pointer type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


RemoveName()

          void RemoveName(PString name);
             throw(PKeyException);

This function removes a tuple entry from the tuple space associated with the specified name. All the items stored in this tuple entry are removed too. If no tuple entry associated with the specified name exists, then a PKeyException will be thrown.


SetBool()

          void SetBool(PString name, bool newBool, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function sets a bool to a new value at a tuple entry in the tuple space associated with the specified name. If no bool exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the bool type's location at the tuple entry, where index 0 specify the first bool value, index 1 specify the second bool value and so forth. If no index is specified, then the first bool value is set. If no bool type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


SetDouble()

          void SetDouble(PString name, double newDouble, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function sets a double to a new value at a tuple entry in the tuple space associated with the specified name. If no double exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the double type's location at the tuple entry, where index 0 specify the first double value, index 1 specify the second double value and so forth. If no index is specified, then the first double value is set. If no double type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


SetFloat()

          void SetFloat(PString name, float newFloat, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function sets a float to a new value at a tuple entry in the tuple space associated with the specified name. If no float exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the float type's location at the tuple entry, where index 0 specify the first float value, index 1 specify the second float value and so forth. If no index is specified, then the first float value is set. If no float type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


SetInt8()

          void SetInt8(PString name, int8 newInt8, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function sets an int8 to a new value at a tuple entry in the tuple space associated with the specified name. If no int8 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the int8 type's location at the tuple entry, where index 0 specify the first int8 value, index 1 specify the second int8 value and so forth. If no index is specified, then the first int8 value is set. If no int8 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


SetInt16()

          void SetInt16(PString name, int16 newInt16, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function sets an int16 to a new value at a tuple entry in the tuple space associated with the specified name. If no int16 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the int16 type's location at the tuple entry, where index 0 specify the first int16 value, index 1 specify the second int16 value and so forth. If no index is specified, then the first int16 value is set. If no int16 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


SetInt32()

          void SetInt32(PString name, int32 newInt32, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function sets an int32 to a new value at a tuple entry in the tuple space associated with the specified name. If no int32 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the int32 type's location at the tuple entry, where index 0 specify the first int32 value, index 1 specify the second int32 value and so forth. If no index is specified, then the first int32 value is set. If no int32 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


SetInt64()

          void SetInt64(PString name, int64 newInt64, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function sets an int64 to a new value at a tuple entry in the tuple space associated with the specified name. If no int64 exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the int64 type's location at the tuple entry, where index 0 specify the first int64 value, index 1 specify the second int64 value and so forth. If no index is specified, then the first int64 value is set. If no int64 type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


SetPointer()

          void SetPointer(PString name, const void *newPointer, int32 index = 0);
             throw(PKeyException);
             throw(PBoundException);

This function sets an void pointer to a new value at a tuple entry in the tuple space associated with the specified name. If no void pointer exists at the tuple entry associated with the specified name, then a PKeyException will be thrown.

The index specify the void pointer type's location at the tuple entry, where index 0 specify the first void pointer, index 1 specify the second void pointer and so forth. If no index is specified, then the first void pointer is set. If no void pointer type can be found at the specified index at the tuple entry, then a PBoundsException will be thrown.


The PolyKit developer documentation.
This documentation was written by Flemming N. Larsen.
© Copyright 1998-1999 by PolyCode.