Developer Documentation
Centre for Vision, Speech & Signal Processing
USER IN NAMESPACE AMMA TREE ROOT AMMA SEARCH AMMA HOME
 

  PUBLIC
RCWrapC::RCWrapC(void)
RCWrapC::RCWrapC(BooleanT,BooleanT)
RCWrapC::RCWrapC(const RCWrapC &)
RCWrapC::RCWrapC(const T &)
RCWrapC::RCWrapC(istream &)
RCWrapC::RCWrapC(const RCAbstractC &,BooleanT) throw
RCWrapC::RCWrapC(const RCWrapBaseC &,BooleanT) throw
RCWrapC::IsA(const RCWrapBaseC &)
RCWrapC::Body(void)
RCWrapC::Body(void) const
RCWrapC::Copy(void) const
RCWrapC::Data(void)
RCWrapC::Data(void) const
RCWrapC::operator T &(void)
RCWrapC::operator const T &(void) const
RCWrapBaseC::Body(void)
RCWrapBaseC::Body(void) const
RCWrapBaseC::DataType(void) const
RCWrapBaseC::Save(ostream &) const
RCHandleAC::Abstract(void)
RCHandleAC::IsHandleType(const DT &) const
RCHandleAC::CheckHandleType(const DT &) const
RCHandleAC::Save(ostream &) const
RCHandleAC::Copy(void) const
RCHandleC::IsValid(void) const
RCHandleC::IsValidObject(void) const
RCHandleC::operator=(const RCHandleC &)
RCHandleC::operator==(const RCHandleC &) const
RCHandleC::operator!=(const RCHandleC &) const
RCHandleC::Hash(void) const
RCHandleC::IsConst(void) const
RCHandleC::IsNotConst(void) const
RCHandleC::SetConst(void) const
RCHandleC::Invalidate(void)
RCHandleC::Body(void)
RCHandleC::Body(void) const
RCWrapC<class T>
 
This is a wrapper template to take an unrefrence counted object and make it refrence counted.
 
include "amma/RCWrap.hh"
User Level:Default
Library:MRefC
Example:exBRefC.cc
Section:Basic Types.Refrence Counting
In Scope:std

Parent Classes:

Derived Classes: Methods:
RCWrapC()
Default constructor
Creates an invalid handle. This can be tested for with IsValidObject().

RCWrapC(BooleanT makeBod,BooleanT)
Constructor
Creates an body with the default constructor for the containing object. The double argument is needed to avoid conflicts when RCWrapping a BooleanT.

RCWrapC(const RCWrapC<T> & oth)
Copy constructor.

RCWrapC(const T & oth)
Construct from an actual instance.

RCWrapC(istream & in)
Stream constructor.

RCWrapC(const RCAbstractC & oth,BooleanT mustBeValid = TRUE) throw
Construct from an abstract handle.
Note, if mustBe Valid is true and the object isn't of the appropriate type, an exception will be thrown, otherwise an invalid handle will be generated.

RCWrapC(const RCWrapBaseC & oth,BooleanT mustBeValid) throw
Construct from an abstract handle.
Note, if mustBe Valid is true and the object isn't of the appropriate type, an exception will be thrown, otherwise an invalid handle will be generated.

BooleanT IsA(const RCWrapBaseC & oth)
Test if RCWrapBase is derived from this wrap type.
Returns true if it is.

RCWrapBodyC<T> & Body()
Access data.

const RCWrapBodyC<T> & Body() const
Access data.

RCWrapC<T> Copy() const
Make a copy.

T & Data()
Access data, explicitly

const T & Data() const
Access data, explicitly

operator T &()
Access object.

operator const T &() const
Access object.

RCWrapBaseBodyC & Body()
Access body.

const RCWrapBaseBodyC & Body() const
Const access to body.

const type_info & DataType() const
Type of object held.

BooleanT Save(ostream & sout) const
Write contained object to stream.

#include "amma/RCHandleA.hh"
RCAbstractC Abstract()
Create an abstract handle to this object.

BooleanT IsHandleType(const DT &) const
Is handle of given type ?

void CheckHandleType(const DT & dummy) const
Check handle type. Throw an expception if not.

BooleanT Save(ostream & out) const
Save to ostream.

RCHandleAC<RCWrapBaseBodyC> Copy() const
Creat a deep copy of this object.
protected:

#include "amma/RCHandle.hh"
BooleanT IsValid() const
Check its a valid handle.

BooleanT IsValidObject() const
Check its a valid handle, and that the object is pointed to is also valid.

RCHandleC<RCWrapBaseBodyC> & operator=(const RCHandleC<RCWrapBaseBodyC> & oth)
Assignment.

BooleanT operator==(const RCHandleC<RCWrapBaseBodyC> & oth) const
Comparison operator.

BooleanT operator!=(const RCHandleC<RCWrapBaseBodyC> & oth) const
Comparison operator.

UIntT Hash() const
Hash function.x

BooleanT IsConst() const
Is object constant ?

BooleanT IsNotConst() const
Is object not constant ?

void SetConst(void) const
Lock the object.
This is const as a convience though it actual modified the object, often object you wish to ensure are constant already have const set. protected:

void Invalidate()
Turn this into an invalid handle.

RCWrapBaseBodyC & Body()
Direct access to body.

const RCWrapBaseBodyC & Body() const
Constant access to body.


Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001