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

  PUBLIC
BGraphEdgeC::BGraphEdgeC(BGraphTypesC::NodeHandleT,BGraphTypesC::NodeHandleT,const ET &)
BGraphEdgeC::Source(void) const
BGraphEdgeC::Target(void) const
BGraphEdgeC::Data(void)
BGraphEdgeC::Data(void) const
BGraphEdgeC::NodeH(Dir) const
BGraphEdgeC::operator==(const BGraphEdgeC &) const
BGraphEdgeC::Hash(void) const
BGraphEdgeBaseC::Node(Dir) const
BGraphEdgeBaseC::NextEdge(Dir)
BGraphEdgeBaseC::Dump(ostream &)
BGraphEdgeBaseC::Hash(void) const
BodyRefCounterC::AddReference(void)
BodyRefCounterC::RemoveReference(void)
BodyRefCounterC::SetConst(void) const
BodyRefCounterC::SetConst(void)
BodyRefCounterC::IsConst(void) const
BodyRefCounterC::IsNotConst(void) const
BodyRefCounterC::ToBeDeleted(void) const
BodyRefCounterC::ToBeDeletedRemoveIgnoreNoRemove(void)
BodyRefCounterC::ToBeDeletedRemove(void)
BodyRefCounterC::BodyMightBeDeleted(void) const
BodyRefCounterC::IsCountZero(void) const
BodyRefCounterC::BRCPtrCanDeleteObject(void) const
BodyRefCounterC::Count(void) const
BodyRefCounterC::operator=(const BodyRefCounterC &)
BodyRefCounterC::IsValidObject(void) const
BodyRefCounterC::UserBitTest(IntT) const
BodyRefCounterC::UserBitSet(IntT,BooleanT)
BodyRefCounterC::UserBitZero(IntT)
BodyRefCounterC::ReportBRCError(char *)
BodyRefCounterC::Hash(void) const
RefCounterBaseC::Label(void) const
BGraphEdgeC<class NT,class ET>
 
BGraph Edge.
 
include "amma/BGraphEdge.hh"
User Level:Default
Library:Branch
Example:exBiHash.cc
Section:Containers.Graphs.Branching
In Scope:std

Parent Classes:

Variables:
Methods:
BGraphEdgeC(BGraphTypesC::NodeHandleT From,BGraphTypesC::NodeHandleT To,const ET & nDat)
Constructor.

BGraphTypesC::NodeHandleT Source() const
Source of edge. inline const BGraphNodeC &Source() const; Source of edge.

BGraphTypesC::NodeHandleT Target() const
Target of edge. inline const BGraphNodeC &Target() const ; Target of edge.

ET & Data()
Access edge data.

const ET & Data() const
Constant access to edge data.

NodeHandleT NodeH(Dir Way) const
Get nodes at ends of edge.

BooleanT operator==(const BGraphEdgeC & oth) const
Are they the same edge ?

UIntT Hash() const
Get a hash value of this edge

#include "amma/BGraphBase.hh"
NodeHandleT Node(Dir Way) const
Get nodes at ends of edge.

BGraphEdgeBaseC & NextEdge(Dir Way)
Get edges.

void Dump(ostream & out)
Dump to stream.

UIntT Hash() const
Get hash value.

#include "amma/BRefCnt.hh"
void AddReference()
Another reference to the object has been created.

void RemoveReference()
One reference to the object was deleted.
Locking scheme -------------- The object is possible to lock (to make constant). The scheme assumes that the object is created, it can be locked, after that it can only be destroyed. The locked object cannot be unlocked. This locking scheme is very useful during debugging, using assert() function, when it is necassary to check that object is treated as constant and the constancy is not violated by any casting or passing through the copy constructor of shared objects.

void SetConst(void) const
This locks the object.
Often objects you wish to lock are already const.

void SetConst(void)
This locks the object.

BooleanT IsConst(void) const
Returns TRUE if the object is locked, ie. it is assumed to be constant.

BooleanT IsNotConst(void) const
Returns TRUE if the object is unlocked.
ie. there is no special information if the object is constant or not. Counter state information -------------------------

BooleanT ToBeDeleted() const
Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.

BooleanT ToBeDeletedRemoveIgnoreNoRemove()
Decrement refrence by 1 return true if this leaves no refrences to the object.

BooleanT ToBeDeletedRemove()
Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.

BooleanT BodyMightBeDeleted() const
Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .

BooleanT IsCountZero() const
Are there any refrences left ?

BooleanT BRCPtrCanDeleteObject() const
Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.

IntT Count() const
Returns the current state of the counter, ie. how many references to this object exist.

const BodyRefCounterC & operator=(const BodyRefCounterC & b)
It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.

BooleanT IsValidObject() const
Test if object is valid.
When amma check is disabled this always returns true.

BooleanT UserBitTest(IntT x) const
Test user flag.

void UserBitSet(IntT x,BooleanT setit = TRUE)
Test user flag.

void UserBitZero(IntT x)
Set bit to zero.

void ReportBRCError(char * Msg)
Report error, used in BRCPtrC.

UIntT Hash() const
Hash on address of object.

#include "amma/RefCBase.hh"
LabelT Label() const
Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.


Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001