iPcBag Struct Reference

This is a bag of strings property class. More...

#include <propclass/bag.h>

Inheritance diagram for iPcBag:

[legend]

List of all members.

Public Member Functions
virtual void	AddString (const char *str)=0
	Add an string to this bag.
virtual void	Clear ()=0
	Empty the bag.
virtual csSet< csString > ::GlobalIterator	GetIterator ()=0
	Return an iterator iterating over all strings.
virtual bool	HasString (const char *str)=0
	Check if this bag contains the string.
virtual void	RemoveString (const char *str)=0
	Remove a string from this bag.
virtual bool	SendMessage (const char *msgid, iCelParameterBlock *params=0)=0
	Treat the strings in this bag as names of entities and then send this message to all entities in the bag.

---

Detailed Description

This is a bag of strings property class.

This property class supports the following actions (add prefix 'cel.bag.action.' if you want to access this action through a message):

• AddString: parameters 'value' (string).
• RemoveString: parameters 'value' (string).
• Clear: no parameters.
• HasString: parameters 'value' (string), returns bool.
• SendMessage: parameters 'msgid' (string), ...

This property class supports the following properties:

• size (long, read only): the size of the bag.

Definition at line 45 of file bag.h.

---

Member Function Documentation

virtual void iPcBag::AddString

(

const char *

str

)

[pure virtual]

Add an string to this bag.

virtual void iPcBag::Clear

(

)

[pure virtual]

Empty the bag.

virtual csSet<csString>::GlobalIterator iPcBag::GetIterator

(

)

[pure virtual]

Return an iterator iterating over all strings.

virtual bool iPcBag::HasString

(

const char *

str

)

[pure virtual]

Check if this bag contains the string.

virtual void iPcBag::RemoveString

(

const char *

str

)

[pure virtual]

Remove a string from this bag.

virtual bool iPcBag::SendMessage	(	const char *	msgid,
		iCelParameterBlock *	params = 0
	)			[pure virtual]

Treat the strings in this bag as names of entities and then send this message to all entities in the bag.

Returns:

true if at least one of the entities handled the message (returned true).

---

The documentation for this struct was generated from the following file:

• propclass/bag.h