Geddei::SignalTypeRefs Class Reference
[Geddei's core classes.]

Array-like class for containing SignalTypePtr objects. More...

#include <signaltyperefs.h>

Collaboration diagram for Geddei::SignalTypeRefs:

Collaboration graph
[legend]
List of all members.

Public Member Functions

const bool allSame () const
const uint count () const
SignalTypeRefsoperator= (const SignalType &src)
SignalTypeRefsoperator= (const SignalTypeRef &src)
SignalTypeRefsoperator= (const SignalTypeRefs &src)
SignalTypeRef operator[] (const uint i)
const SignalTypeRef operator[] (const uint i) const
 ~SignalTypeRefs ()

Friends

class Combination
class DomProcessor
class DRCoupling
class Processor
class RSCoupling
class SubProcessor
class xSCoupling

Detailed Description

Array-like class for containing SignalTypePtr objects.

Author:
Gav Wood <gav@cs.york.ac.uk>
Though this class uses pointers in its storage mechanism (hence SignalTypeRefs) it DOES own all data it points at. It will be deleted with this class, so don't try to delete any of the pointers you get from it data.

Its really a no-brainer: Just set it and forget about it. Copy methods can be used if you want to keep ownership of the data.

None of the data is ever shared either implicitly or explicitly.

Note:
The class contains an assignment operator; this copies all data deeply.


Constructor & Destructor Documentation

Geddei::SignalTypeRefs::~SignalTypeRefs (  ) 

Default destructor.


Member Function Documentation

const uint Geddei::SignalTypeRefs::count (  )  const [inline]

Get the amount of SignalTypePtr spaces currently allocated.

Returns:
The number of spaces allocated.

const bool Geddei::SignalTypeRefs::allSame (  )  const

Check if all SignalType objects contained in this object are actually equivalent.

Returns:
true if all SignalTypeRefs contained here point to equivalent types. If any are null, returns false. If fewer than two objects are contained it returns true.

SignalTypeRefs & Geddei::SignalTypeRefs::operator= ( const SignalTypeRefs src  ) 

Assignment operator. Makes an identical copy of the list given by src .

Note:
For internal development: This is a deep copy - none of the data is shared. This functionality can be overridden by setting implicitCopying to false in the constructor, though memory management issues make it somewhat dangerous.
Parameters:
src The SignalTypeRefs object to make a copy of.
Returns:
A reference to this object.

SignalTypeRefs & Geddei::SignalTypeRefs::operator= ( const SignalTypeRef src  ) 

Assignment operator. Copies one of src into each slot.

Parameters:
src The SignalTypeRef to use for the copy.
Returns:
A reference to this object.

SignalTypeRefs & Geddei::SignalTypeRefs::operator= ( const SignalType src  ) 

Assignment operator. Copies one of src into each slot.

Parameters:
src The SignalType object to make copies of.
Returns:
A reference to this object.


The documentation for this class was generated from the following files:
Generated on Thu Jul 13 06:56:45 2006 for Exscalibar by  doxygen 1.4.7