cChannelType Class Reference

API: cChannelType Class Reference
API
cChannelType Class Referenceabstract
Inheritance diagram for cChannelType:
[legend]

Public Member Functions

Constructors, destructor, assignment
 cChannelType (const char *qname=nullptr)
Public Member Functions inherited from cComponentType
 cComponentType (const char *qname=nullptr)
virtual ~cComponentType ()
virtual const char * getFullName () const override
virtual std::string getNedSource () const =0
virtual std::string getDocumentation () const =0
Public Member Functions inherited from cNoncopyableOwnedObject
 cNoncopyableOwnedObject (const char *name=nullptr, bool namepooling=true)
virtual cNoncopyableOwnedObjectdup () const override
Public Member Functions inherited from cOwnedObject
 cOwnedObject ()
 cOwnedObject (const char *name, bool namepooling=true)
 cOwnedObject (const cOwnedObject &obj)
virtual ~cOwnedObject ()
cOwnedObjectoperator= (const cOwnedObject &o)
virtual cObjectgetOwner () const override
virtual bool isOwnedObject () const override
Public Member Functions inherited from cNamedObject
 cNamedObject ()
 cNamedObject (const char *name, bool namepooling=true)
 cNamedObject (const cNamedObject &obj)
virtual ~cNamedObject ()
cNamedObjectoperator= (const cNamedObject &o)
virtual void setName (const char *s)
virtual const char * getName () const override
virtual void setNamePooling (bool b)
virtual bool getNamePooling ()
Public Member Functions inherited from cObject
 cObject ()
 cObject (const cObject &other)=default
virtual ~cObject ()
virtual const char * getClassName () const
bool isName (const char *s) const
virtual std::string getFullPath () const
virtual std::string getClassAndFullName () const
virtual std::string getClassAndFullPath () const
const cObjectgetThisPtr () const
virtual std::string str () const
virtual std::ostream & printOn (std::ostream &os) const
virtual bool isSoftOwner () const
virtual void forEachChild (cVisitor *v)
cObjectfindObject (const char *name, bool deep=true)
virtual cClassDescriptorgetDescriptor () const
void copyNotSupported () const

Channel object creation

virtual cChannelcreate (const char *name)
static cChannelTypefind (const char *qname)
static cChannelTypeget (const char *qname)
static cChannelTypegetIdealChannelType ()
static cChannelTypegetDelayChannelType ()
static cChannelTypegetDatarateChannelType ()
static cIdealChannelcreateIdealChannel (const char *name)
static cDelayChannelcreateDelayChannel (const char *name)
static cDatarateChannelcreateDatarateChannel (const char *name)

Additional Inherited Members

static cComponentTypefind (const char *qname)
static cComponentTypeget (const char *qname)
Static Public Member Functions inherited from cOwnedObject
static long getTotalObjectCount ()
static long getLiveObjectCount ()
static void resetObjectCounters ()
static cSoftOwnergetOwningContext ()
Protected Member Functions inherited from cObject
virtual void take (cOwnedObject *obj)
virtual void drop (cOwnedObject *obj)
void dropAndDelete (cOwnedObject *obj)

Description

Abstract base class for creating a channel of a given type.

Constructor & Destructor Documentation

◆ cChannelType()

cChannelType ( const char * qname = nullptr)

Member Function Documentation

◆ create()

virtual cChannel * create ( const char * name)
virtual

Factory method to create a channel object with the given name.

If the name is nullptr, a default name will be taken from the @defaultname NED property of the channel type; or if there is no such property, "channel" will be used.

In addition to creating an object of the correct type, this methods inserts it into the simulation's data structure, and adds the parameters specified in the NED declaration.

◆ find()

cChannelType * find ( const char * qname)
static

Finds a channel type by fully qualified NED type name. Returns nullptr if not found.

References cChannelType().

◆ get()

cChannelType * get ( const char * qname)
static

Finds a channel type by fully qualified NED type name. Throws an error if not found.

References cChannelType().

◆ getIdealChannelType()

cChannelType * getIdealChannelType ( )
static

Equivalent to cChannelType::get("ned.IdealChannel"), but more efficient.

References cChannelType().

◆ getDelayChannelType()

cChannelType * getDelayChannelType ( )
static

Equivalent to cChannelType::get("ned.DelayChannel"), but more efficient.

References cChannelType().

◆ getDatarateChannelType()

cChannelType * getDatarateChannelType ( )
static

Equivalent to cChannelType::get("ned.DatarateChannel"), but more efficient.

References cChannelType().

◆ createIdealChannel()

cIdealChannel * createIdealChannel ( const char * name)
static

Creates an IdealChannel via getIdealChannelType()->create(name).

◆ createDelayChannel()

cDelayChannel * createDelayChannel ( const char * name)
static

Creates a DelayChannel via getDelayChannelType()->create(name).

◆ createDatarateChannel()

cDatarateChannel * createDatarateChannel ( const char * name)
static

Creates a DatarateChannel via getDatarateChannelType()->create(name).