OMNeT++ API 6.1
Discrete Event Simulation Library
cDelayChannel Class Reference

Description

Channel with propagation delay.

Inheritance diagram for cDelayChannel:
[legend]

Public Member Functions

Redefined cChannel member functions.
virtual bool isTransmissionChannel () const override
 
virtual double getNominalDatarate () const override
 
virtual simtime_t calculateDuration (cMessage *msg) const override
 
virtual simtime_t getTransmissionFinishTime () const override
 
virtual bool isBusy () const override
 
Setting and getting channel parameters.
virtual void setDelay (double d)
 
virtual void setDisabled (bool d)
 
virtual simtime_t getDelay () const
 
virtual bool isDisabled () const override
 
Implementation methods
virtual void initialize () override
 
virtual Result processMessage (cMessage *msg, const SendOptions &options, simtime_t t) override
 
- Public Member Functions inherited from cChannel
virtual void finalizeParameters () override
 
 cChannel (const char *name=nullptr)
 
virtual ~cChannel ()
 
virtual std::string str () const override
 
virtual void callInitialize () override
 
virtual bool callInitialize (int stage) override
 
virtual void callFinish () override
 
virtual ComponentKind getComponentKind () const override
 
virtual cModulegetParentModule () const override
 
cChannelTypegetChannelType () const
 
virtual cPropertiesgetProperties () const override
 
virtual cGategetSourceGate () const
 
virtual void forceTransmissionFinishTime (simtime_t t)
 
- Public Member Functions inherited from cComponent
 cComponent (const char *name=nullptr)
 
virtual ~cComponent ()
 
virtual void forEachChild (cVisitor *v) override
 
const cComponentgetThisPtr () const
 
virtual void setDisplayName (const char *name)
 
virtual const char * getDisplayName () const
 
virtual cComponentTypegetComponentType () const
 
cSimulationgetSimulation () const
 
int getId () const
 
virtual const char * getNedTypeName () const
 
virtual std::string getNedTypeAndFullName () const
 
virtual std::string getNedTypeAndFullPath () const
 
bool isModule () const
 
bool isChannel () const
 
virtual cModulegetSystemModule () const
 
virtual cModulegetModuleByPath (const char *path) const
 
virtual cModulefindModuleByPath (const char *path) const
 
virtual int getNumParams () const
 
virtual cParpar (int k)
 
const cParpar (int k) const
 
virtual cParpar (const char *parname)
 
const cParpar (const char *parname) const
 
virtual int findPar (const char *parname) const
 
bool hasPar (const char *s) const
 
virtual cRNGgetRNG (int k) const
 
virtual uint32_t intrand (uint32_t r, int rng=0) const
 
virtual double dblrand (int rng=0) const
 
virtual double uniform (double a, double b, int rng=0) const
 
virtual SimTime uniform (SimTime a, SimTime b, int rng=0) const
 
virtual double exponential (double mean, int rng=0) const
 
virtual SimTime exponential (SimTime mean, int rng=0) const
 
virtual double normal (double mean, double stddev, int rng=0) const
 
virtual SimTime normal (SimTime mean, SimTime stddev, int rng=0) const
 
virtual double truncnormal (double mean, double stddev, int rng=0) const
 
virtual SimTime truncnormal (SimTime mean, SimTime stddev, int rng=0) const
 
virtual double gamma_d (double alpha, double theta, int rng=0) const
 
virtual double beta (double alpha1, double alpha2, int rng=0) const
 
virtual double erlang_k (unsigned int k, double mean, int rng=0) const
 
virtual double chi_square (unsigned int k, int rng=0) const
 
virtual double student_t (unsigned int i, int rng=0) const
 
virtual double cauchy (double a, double b, int rng=0) const
 
virtual double triang (double a, double b, double c, int rng=0) const
 
virtual double lognormal (double m, double w, int rng=0) const
 
virtual double weibull (double a, double b, int rng=0) const
 
virtual double pareto_shifted (double a, double b, double c, int rng=0) const
 
virtual int intuniform (int a, int b, int rng=0) const
 
virtual int intuniformexcl (int a, int b, int rng=0) const
 
virtual int bernoulli (double p, int rng=0) const
 
virtual int binomial (int n, double p, int rng=0) const
 
virtual int geometric (double p, int rng=0) const
 
virtual int negbinomial (int n, double p, int rng=0) const
 
virtual int poisson (double lambda, int rng=0) const
 
virtual void subscribe (simsignal_t signalID, cIListener *listener)
 
virtual void subscribe (const char *signalName, cIListener *listener)
 
virtual void unsubscribe (simsignal_t signalID, cIListener *listener)
 
virtual void unsubscribe (const char *signalName, cIListener *listener)
 
virtual bool isSubscribed (simsignal_t signalID, cIListener *listener) const
 
virtual bool isSubscribed (const char *signalName, cIListener *listener) const
 
virtual std::vector< simsignal_tgetLocalListenedSignals () const
 
virtual std::vector< cIListener * > getLocalSignalListeners (simsignal_t signalID) const
 
virtual bool hasGUI () const
 
virtual cDisplayStringgetDisplayString () const
 
virtual void setDisplayString (const char *dispstr)
 
virtual void bubble (const char *text) const
 
virtual std::string resolveResourcePath (const char *fileName) const
 
virtual void recordScalar (const char *name, double value, const char *unit=nullptr)
 
virtual void recordScalar (const char *name, SimTime value, const char *unit=nullptr)
 
virtual void recordStatistic (cStatistic *stats, const char *unit=nullptr)
 
virtual void recordStatistic (const char *name, cStatistic *stats, const char *unit=nullptr)
 
virtual void emit (simsignal_t signalID, bool b, cObject *details=nullptr)
 
virtual void emit (simsignal_t signalID, double d, cObject *details=nullptr)
 
virtual void emit (simsignal_t signalID, const SimTime &t, cObject *details=nullptr)
 
virtual void emit (simsignal_t signalID, const char *s, cObject *details=nullptr)
 
virtual void emit (simsignal_t signalID, cObject *obj, cObject *details=nullptr)
 
virtual void emit (simsignal_t signalID, const cObject *obj, cObject *details=nullptr)
 
virtual void emit (simsignal_t signalID, char c, cObject *details=nullptr)
 
virtual void emit (simsignal_t signalID, unsigned char c, cObject *details=nullptr)
 
virtual void emit (simsignal_t signalID, short i, cObject *details=nullptr)
 
virtual void emit (simsignal_t signalID, unsigned short i, cObject *details=nullptr)
 
virtual void emit (simsignal_t signalID, int i, cObject *details=nullptr)
 
virtual void emit (simsignal_t signalID, unsigned int i, cObject *details=nullptr)
 
virtual void emit (simsignal_t signalID, long i, cObject *details=nullptr)
 
virtual void emit (simsignal_t signalID, unsigned long i, cObject *details=nullptr)
 
virtual void emit (simsignal_t signalID, long long i, cObject *details=nullptr)
 
virtual void emit (simsignal_t signalID, unsigned long long i, cObject *details=nullptr)
 
virtual void emit (simsignal_t signalID, float f, cObject *details=nullptr)
 
virtual void emit (simsignal_t signalID, long double d, cObject *details=nullptr)
 
bool mayHaveListeners (simsignal_t signalID) const
 
bool hasListeners (simsignal_t signalID) const
 
- Public Member Functions inherited from cSoftOwner
 cSoftOwner (const char *name=nullptr, bool namepooling=true)
 
virtual ~cSoftOwner ()
 
virtual bool isSoftOwner () const override
 
int getNumOwnedObjects () const
 
cOwnedObjectgetOwnedObject (int k)
 
- 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 const char * getFullName () const
 
virtual std::string getFullPath () const
 
virtual std::string getClassAndFullName () const
 
virtual std::string getClassAndFullPath () const
 
const cObjectgetThisPtr () const
 
virtual std::ostream & printOn (std::ostream &os) const
 
cObjectfindObject (const char *name, bool deep=true)
 
virtual cClassDescriptorgetDescriptor () const
 
void copyNotSupported () const
 

Protected Member Functions

virtual void handleParameterChange (const char *parname) override
 
- Protected Member Functions inherited from cComponent
virtual void initialize (int stage)
 
virtual int numInitStages () const
 
virtual void finish ()
 
virtual void refreshDisplay () const
 
virtual void preDelete (cComponent *root)
 
- Protected Member Functions inherited from cSoftOwner
virtual void take (cOwnedObject *obj) override
 
virtual void drop (cOwnedObject *obj) override
 
- Protected Member Functions inherited from cObject
void dropAndDelete (cOwnedObject *obj)
 

Constructors, destructor

 cDelayChannel (const char *name=nullptr)
 
virtual ~cDelayChannel ()
 
static cDelayChannelcreate (const char *name)
 

Additional Inherited Members

- Static Public Member Functions inherited from cComponent
static simsignal_t registerSignal (const char *name)
 
static const char * getSignalName (simsignal_t signalID)
 
- Static Public Member Functions inherited from cOwnedObject
static long getTotalObjectCount ()
 
static long getLiveObjectCount ()
 
static void resetObjectCounters ()
 
static cSoftOwnergetOwningContext ()
 

Constructor & Destructor Documentation

◆ cDelayChannel()

cDelayChannel ( const char *  name = nullptr)
inlineexplicit

Constructor. This is only for internal purposes, and should not be used when creating channels dynamically; use the create() factory method instead.

◆ ~cDelayChannel()

virtual ~cDelayChannel ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ handleParameterChange()

virtual void handleParameterChange ( const char *  parname)
overrideprotectedvirtual

Called back when a parameter changes. Redefined from cComponent.

Reimplemented from cComponent.

◆ create()

static cDelayChannel* create ( const char *  name)
static

Utility function for dynamic channel creation. Equivalent to cChannelType::getDelayChannelType()->create(name).

◆ isTransmissionChannel()

virtual bool isTransmissionChannel ( ) const
inlineoverridevirtual

The cDelayChannel implementation of this method always returns false.

Implements cChannel.

◆ getNominalDatarate()

virtual double getNominalDatarate ( ) const
inlineoverridevirtual

The cDelayChannel implementation of this method always returns zero.

Implements cChannel.

◆ calculateDuration()

virtual simtime_t calculateDuration ( cMessage msg) const
inlineoverridevirtual

The cDelayChannel implementation of this method always returns zero.

Implements cChannel.

◆ getTransmissionFinishTime()

virtual simtime_t getTransmissionFinishTime ( ) const
inlineoverridevirtual

The cDelayChannel implementation of this method always returns zero.

Implements cChannel.

References SIMTIME_ZERO.

◆ isBusy()

virtual bool isBusy ( ) const
inlineoverridevirtual

The cDelayChannel implementation of this method always returns false.

Reimplemented from cChannel.

◆ setDelay()

virtual void setDelay ( double  d)
virtual

Sets the propagation delay of the channel, in seconds.

◆ setDisabled()

virtual void setDisabled ( bool  d)
virtual

Disables or enables the channel.

◆ getDelay()

virtual simtime_t getDelay ( ) const
inlinevirtual

Returns the propagation delay of the channel, in seconds. This method is equivalent to reading the "delay" parameter, via par("delay").

◆ isDisabled()

virtual bool isDisabled ( ) const
inlineoverridevirtual

Returns whether the channel is disabled. This method is equivalent to reading the "disabled" parameter, via par("disabled"). A disabled channel discards all messages sent on it.

Reimplemented from cChannel.

◆ initialize()

virtual void initialize ( )
overridevirtual

Initialization.

Reimplemented from cComponent.

◆ processMessage()

virtual Result processMessage ( cMessage msg,
const SendOptions options,
simtime_t  t 
)
overridevirtual

This implementation delivers the message to the opposite gate with a delay.

Implements cChannel.


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