GU_ConstDetailHandle Class Reference

#include <GU_DetailHandle.h>

List of all members.

Public Member Functions
	GU_ConstDetailHandle ()
	GU_ConstDetailHandle (const GU_ConstDetailHandle &handle)
	GU_ConstDetailHandle (const GU_DetailHandle &handle)
	~GU_ConstDetailHandle ()
const GU_ConstDetailHandle &	operator= (const GU_ConstDetailHandle &handle)
const GU_ConstDetailHandle &	operator= (const GU_DetailHandle &handle)
bool	operator== (const GU_ConstDetailHandle &handle) const
bool	operator!= (const GU_ConstDetailHandle &handle) const
const GU_Detail *	readLock ()
void	unlock (const GU_Detail *gdp)
bool	isNull () const
void	addPreserveRequest ()
void	removePreserveRequest ()
int	getPreserveRequest () const

---

Detailed Description

A GU_ConstDetailHandle uses a GU_DetailHandle to provide const-only access to a GU_Detail. It uses a GU_DetailHandle member variable to do all the actual work, and simply hides any functionality that is unsafe or inappropriate for a const GU_Detail.

Examples:

SIM/SIM_SolverSNOW.C, and SIM/SIM_SolverSNOW.h.

Definition at line 123 of file GU_DetailHandle.h.

---

Constructor & Destructor Documentation

GU_ConstDetailHandle::GU_ConstDetailHandle

(

)

[inline]

Definition at line 126 of file GU_DetailHandle.h.

GU_ConstDetailHandle::GU_ConstDetailHandle

(

const GU_ConstDetailHandle &

handle

)

[inline]

Definition at line 128 of file GU_DetailHandle.h.

GU_ConstDetailHandle::GU_ConstDetailHandle

(

const GU_DetailHandle &

handle

)

[inline]

Definition at line 130 of file GU_DetailHandle.h.

GU_ConstDetailHandle::~GU_ConstDetailHandle

(

)

[inline]

Definition at line 133 of file GU_DetailHandle.h.

---

Member Function Documentation

void GU_ConstDetailHandle::addPreserveRequest

(

)

[inline]

Preserve Requests: A preserve request is a request that people create a new GU_DetailHandle rather than editting the current one. It is used by SOPs to determine if it is safe to do an in place cook.

Definition at line 176 of file GU_DetailHandle.h.

int GU_ConstDetailHandle::getPreserveRequest

(

)

const [inline]

Definition at line 180 of file GU_DetailHandle.h.

bool GU_ConstDetailHandle::isNull

(

)

const [inline]

Determine if this is a null handle. This means it points to a null handle, or the handle's gdp is null.

Examples:

SIM/SIM_SolverHair.C, and SIM/SIM_SolverSNOW.C.

Definition at line 168 of file GU_DetailHandle.h.

bool GU_ConstDetailHandle::operator!=

(

const GU_ConstDetailHandle &

handle

)

const [inline]

Definition at line 149 of file GU_DetailHandle.h.

const GU_ConstDetailHandle& GU_ConstDetailHandle::operator=

(

const GU_DetailHandle &

handle

)

[inline]

Definition at line 141 of file GU_DetailHandle.h.

const GU_ConstDetailHandle& GU_ConstDetailHandle::operator=

(

const GU_ConstDetailHandle &

handle

)

[inline]

Definition at line 136 of file GU_DetailHandle.h.

bool GU_ConstDetailHandle::operator==

(

const GU_ConstDetailHandle &

handle

)

const [inline]

Definition at line 147 of file GU_DetailHandle.h.

const GU_Detail* GU_ConstDetailHandle::readLock

(

)

[inline]

This will acquire a read lock on the GU_Detail. The result is 0 if no lock can be acquired, or no underlying detail exists. The returned detail should be passed to unlock(). (Technically, no locking occurs on error, but unlock is a no-op with a 0 gdp)

Definition at line 156 of file GU_DetailHandle.h.

void GU_ConstDetailHandle::removePreserveRequest

(

)

[inline]

Definition at line 178 of file GU_DetailHandle.h.

void GU_ConstDetailHandle::unlock

(

const GU_Detail *

gdp

)

[inline]

This will unlock one layer of locking. If the passed in gdp is null, no unlocking occurs. Otherwise, the passed in gdp is asserted to match the one which myHandle points to.

Definition at line 163 of file GU_DetailHandle.h.

---

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

• GU/GU_DetailHandle.h