rwsf::HandleBase

• Local Index
• Header File
• Description
• Public Member Functions
• Public Operators
• Protected Constructors
• Protected Destructor
• Protected Operators

Members

body() HandleBase()

isValid() operator!=()

operator=() operator==()

~HandleBase()

#include <rwsf/core/HandleBase.h>

rwsf::HandleBase is the base class for handle Classes. Each time an instance of this class is bound to an instance of rwsf::BodyBase class, it increments the reference count maintained by that body. Each time an instance of this class detaches from a body instance, it decrements the body's reference count, until the last handle detaches, reaching zero, whereupon it deletes the body instance.

The reference counting relieves clients of the burden of keeping track of when it is safe to delete a body instance.

When a handle is copy-constructed, the new handle attaches to the same body as the original. When one handle is assigned to another handle, the handle on the left side detaches from its current body and attaches to the body pointed to by the handle on the right side.

bool
isValid(void) const;

Returns true if this handle points to a valid body instance, and false otherwise.

bool 
operator==(const HandleBase& second) const;

Returns true if the handle points to the same body instance, if any, as pointed to by a second handle, and false otherwise. Two empty handles are equal. Throws no exceptions.

bool
operator!=(const HandleBase& second) const;

Returns true if the handle points to different body instance, if any, than pointed to by a second handle, and otherwise false. Throws no exceptions.

HandleBase(void);

Default constructor. Constructs an empty, invalid, handle instance.

HandleBase(StaticCtor);

constructs a global static handle instance. (May be used prior to construction.)

HandleBase(BodyBase* body);

Binds a new handle instance to a body instance.

HandleBase(const HandleBase& second);

Binds a new handle instance to the same body instance, if any, that is pointed to by a second handle instance.

virtual 
~HandleBase(void);

virtual destructor.

BodyBase&
body(void) const;

Gets a areference for the body instance, if any; otherwise, throws an rwsf::ExternalException exception.

HandleBase&
operator=(const HandleBase& second);

Binds this handle instance to the same body instance, if any, that is pointed to by a second handle instance.

©2004-2007 Copyright Quovadx, Inc. All Rights Reserved.
Quovadx and Rogue Wave are registered trademarks and HydraSDO is a trademark of Quovadx, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.