ZCom_Replicate_Bool Class Reference

Inheritance diagram for ZCom_Replicate_Bool:

[legend]Collaboration diagram for ZCom_Replicate_Bool:

[legend]List of all members.

---

Detailed Description

Replicator for bool.

Public Member Functions
bool	getValue ()
	get value
	operator bool ()
	casting operator for accessing the class as the value it contains
bool &	operator= (bool _data)
	assignment operator for accessing the class as the value it contains
void	setValue (bool _val)
	set value
	ZCom_Replicate_Bool (bool _data, zU8 _flags, zU8 _rules, zU8 _intercept_id=0, zS16 _mindelay=-1, zS16 _maxdelay=-1)
	constructor, builds the replicatorsetup automatically
	ZCom_Replicate_Bool (bool _data, ZCom_ReplicatorSetup *_setup)
	constructor, taking a ZCom_ReplicatorSetup pointer
Protected Attributes
zU8	m_flags
	Additional replicator flags. ZCom_Replicator() c'tor will set this to 0. (ZCOM_REPLICATOR_*).
ZCom_ReplicatorSetup *	m_setup
	pointing to an instance of the setup class - all replication parameters are stored here

---

Constructor & Destructor Documentation

ZCom_Replicate_Bool::ZCom_Replicate_Bool (  bool  _data, ZCom_ReplicatorSetup *  _setup )  [inline]

constructor, taking a ZCom_ReplicatorSetup pointer

ZCom_Replicate_Bool::ZCom_Replicate_Bool (  bool  _data, zU8  _flags, zU8  _rules, zU8  _intercept_id = 0, zS16  _mindelay = -1, zS16  _maxdelay = -1 )

constructor, builds the replicatorsetup automatically

---

Member Function Documentation

ZCom_Replicate_Bool::operator bool (   )  [inline]

casting operator for accessing the class as the value it contains

bool& ZCom_Replicate_Bool::operator= (  bool  _data  )  [inline]

assignment operator for accessing the class as the value it contains

bool ZCom_Replicate_Bool::getValue (   )  [inline]

get value

void ZCom_Replicate_Bool::setValue (  bool  _val  )  [inline]

set value

void* ZCom_Replicator::operator new (  size_t  _size  )  [inherited]

Overloaded memory operator ensuring that always Zoidcom's new gets called. Attention: Don't overload this unless you are 100% sure what you are doing.

void ZCom_Replicator::operator delete (  void *  _p  )  [inherited]

Overloaded memory operator ensuring that always Zoidcom's delete gets called. Attention: Don't overload this unless you are 100% sure what you are doing.

ZCom_BitStream* ZCom_Replicator::getPeekStream (   )  const [protected, inherited]

Get stream currently processed for peeking the data. Returns: Pointer to current ZCom_BitStream. As you might have noticed, peekData() does not have a ZCom_BitStream parameter. That's the case because peekData() must be called from inside ZCom_NodeReplicationInterceptor::inPreUpdateItem(), and this interceptor callback has no access to the currently processed stream. Use this method to get a pointer to the currently processed stream instead. This will only return a valid result when called from inside the above mentioned interceptor callback.

void ZCom_Replicator::peekDataStore (  void *  _ptr  )  [protected, inherited]

Store pointer to allocated peekbuffer, so it can be deleted again. Parameters: _ptr  Pointer to the allocated memory. The pointer will get stored in a global Thread Local Storage, so that multiple ZCom_Controls can safely operate simultaneously in different threads. When a replicator's peekData() makes use of this method, expect to get a call to clearPeekData() sometime soon, which is supposed to free the allocated memory again. When you call peekDataStore() more than once with a pointer != NULL, clearPeekData() will get called automatically. Thread Local Storage means, there is one variable for each thread of the program. Replicators could as well declare a member variable used for that purpose instead, but that would waste a lot of memory when peeking interceptors are not used.

void* ZCom_Replicator::peekDataRetrieve (   )  [protected, inherited]

Retrieve the peekbuffer pointer currently stored. Returns: Pointer previously stored with peekDataStore().

---

Member Data Documentation

zU8 ZCom_Replicator::m_flags [protected, inherited]

Additional replicator flags. ZCom_Replicator() c'tor will set this to 0. (ZCOM_REPLICATOR_*).

ZCom_ReplicatorSetup* ZCom_Replicator::m_setup [protected, inherited]

pointing to an instance of the setup class - all replication parameters are stored here

---