Main Page Modules Class Hierarchy Compound List File List Compound Members

# cChannel Class Reference

`#include <cchannel.h>`

Inheritance diagram for cChannel::

List of all members.

## Public Methods

Constructors, destructor, assignment
| cChannel (const cChannel &ch)
| cChannel (const char *name=NULL, cLinkType *l=NULL)
virtual | ~cChannel ()
cChannel& | operator= (const cChannel &msg)
Redefined cObject functions.
virtual cObject* | dup () const
virtual void | info (char *buf)
virtual void | forEach (ForeachFunc do_fn)
virtual void | writeContents (ostream &os)
virtual int | netPack ()
virtual int | netUnpack ()
Channel information.
cGate* | fromGate () const
cLinkType* | link () const
Parameter list. FIXME needs remove, etc. operators too!
virtual cPar& | addPar (const char *s)
virtual cPar& | addPar (cPar *p)
virtual cPar& | par (int n)
virtual cPar& | par (const char *s)
virtual int | findPar (const char *s) const
virtual bool | hasPar (const char *s) const
virtual cArray& | parList ()
Internally used methods.
virtual void | deliver (cMessage *msg, simtime_t at)

## Detailed Description

Base class for channels. This channel doesn't delay or change messages. One can attach parameters (e.g. "cost").

## Constructor & Destructor Documentation

cChannel::cChannel ( | const cChannel & ch )

| Copy constructor.

cChannel::cChannel ( | const char * name = NULL,
| cLinkType * l = NULL )`[explicit]`

| Constructor.

cChannel::~cChannel ( | )`[virtual]`

| Destructor.

## Member Function Documentation

cPar & cChannel::addPar ( | cPar * p )`[inline, virtual]`

| Add a parameter to the channel's parameter list. Reimplemented in cSimpleChannel.

cPar & cChannel::addPar ( | const char * s )`[inline, virtual]`

| Add a parameter to the channel's parameter list. Reimplemented in cSimpleChannel.

void cChannel::deliver ( | cMessage * msg,
| simtime_t at )`[virtual]`

| This function is called internally by the simulation kernel for transmission modelling. Reimplemented in cSimpleChannel.

cObject * cChannel::dup ( | ) const`[inline, virtual]`

| Creates and returns an exact copy of this object. See cObject for more details. Reimplemented from cObject. Reimplemented in cSimpleChannel.

int cChannel::findPar ( | const char * s ) const`[virtual]`

| Returns the index of the parameter with the given name in the channel's parameter list, or -1 if it could not be found.

void cChannel::forEach ( | ForeachFunc do_fn )`[virtual]`

| Call the passed function for each contained object. See cObject for more details. Reimplemented from cObject. Reimplemented in cSimpleChannel.

cGate * cChannel::fromGate ( | ) const`[inline]`

| Returns the gate this channel is attached to.

bool cChannel::hasPar ( | const char * s ) const`[inline, virtual]`

| Check if a parameter exists.

void cChannel::info ( | char * buf )`[virtual]`

| Produces a one-line description of object contents into the buffer passed as argument. See cObject for more details. Reimplemented from cObject. Reimplemented in cSimpleChannel.

cLinkType * cChannel::link ( | ) const`[inline]`

| Returns the link type of the gate, if it has one.

int cChannel::netPack ( | )`[virtual]`

| Serializes the object into a PVM or MPI send buffer Used by the simulation kernel for parallel execution. See cObject for more details. Reimplemented from cObject. Reimplemented in cSimpleChannel.

int cChannel::netUnpack ( | )`[virtual]`

| Deserializes the object from a PVM or MPI receive buffer Used by the simulation kernel for parallel execution. See cObject for more details. Reimplemented from cObject. Reimplemented in cSimpleChannel.

cChannel & cChannel::operator= ( | const cChannel & msg )

| Assignment operator. Duplication and the assignment operator work all right with cChannel. The name member doesn't get copied; see cObject's operator=() for more details.

cPar & cChannel::par ( | const char * s )`[virtual]`

| Returns the object with the given name in the channel's parameter list, converting it to a cPar.

cPar & cChannel::par ( | int n )`[virtual]`

| Returns the nth object in the channel's parameter list, converting it to a cPar.

cArray & cChannel::parList ( | )`[virtual]`

| Returns the cArray member of the message which holds the parameters and other attached objects. Parameters can be inserted, retrieved, looked up or deleted through cArray's member functions.

void cChannel::writeContents ( | ostream & os )`[virtual]`

| Writes textual information about this object to the stream. See cObject for more details. Reimplemented from cObject. Reimplemented in cSimpleChannel.

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

- cchannel.h