EMANE  1.2.1
Public Member Functions | List of all members
EMANE::Events::CommEffect Class Reference

A CommEffect entry holds the NEM Id of a transmitter and the link effects to apply to received transmission. More...

#include <commeffect.h>

Public Member Functions

 CommEffect (NEMId nemId, const Microseconds &lattency, const Microseconds &jitter, float fProbabilityLoss, float fProbabilityDuplicate, std::uint64_t u64UnicastBitRate, std::uint64_t u64BroadcastBitRate)
 
NEMId getNEMId () const
 
const Microseconds & getLatency () const
 
const Microseconds & getJitter () const
 
float getProbabilityLoss () const
 
float getProbabilityDuplicate () const
 
std::uint64_t getUnicastBitRate () const
 
std::uint64_t getBroadcastBitRate () const
 

Detailed Description

A CommEffect entry holds the NEM Id of a transmitter and the link effects to apply to received transmission.

Note
Instances are immutable

Definition at line 52 of file commeffect.h.

Constructor & Destructor Documentation

◆ CommEffect()

EMANE::Events::CommEffect::CommEffect ( NEMId  nemId,
const Microseconds &  lattency,
const Microseconds &  jitter,
float  fProbabilityLoss,
float  fProbabilityDuplicate,
std::uint64_t  u64UnicastBitRate,
std::uint64_t  u64BroadcastBitRate 
)
inline

Creates a CommEffect instance

Parameters
nemIdNEM Id of the transmitter
lattencyLatency in microseconds
jitterJitter in microseconds
fProbabilityLossProbability of loss
fProbabilityDuplicateProbability of duplication
u64UnicastBitRateUnicast bitrate in bps
u64BroadcastBitRateBroadcast bitrate in bps

Definition at line 34 of file commeffect.inl.

Member Function Documentation

◆ getBroadcastBitRate()

std::uint64_t EMANE::Events::CommEffect::getBroadcastBitRate ( ) const
inline

Gets the broadcast bitrate in bps

Returns
bitrate

Definition at line 86 of file commeffect.inl.

◆ getJitter()

const EMANE::Microseconds & EMANE::Events::CommEffect::getJitter ( ) const
inline

Gets the jitter in microseconds

Definition at line 62 of file commeffect.inl.

◆ getLatency()

const EMANE::Microseconds & EMANE::Events::CommEffect::getLatency ( ) const
inline

Gets the latency in microseconds

Returns
latency

Definition at line 56 of file commeffect.inl.

◆ getNEMId()

EMANE::NEMId EMANE::Events::CommEffect::getNEMId ( ) const
inline

Gets the NEM id

Returns
NEM Id

Definition at line 50 of file commeffect.inl.

◆ getProbabilityDuplicate()

float EMANE::Events::CommEffect::getProbabilityDuplicate ( ) const
inline

Gets the duplication probability

Returns
probability

Definition at line 74 of file commeffect.inl.

◆ getProbabilityLoss()

float EMANE::Events::CommEffect::getProbabilityLoss ( ) const
inline

Gets the loss probability

Returns
probability

Definition at line 68 of file commeffect.inl.

◆ getUnicastBitRate()

std::uint64_t EMANE::Events::CommEffect::getUnicastBitRate ( ) const
inline

Getst the unicast bitrate in bps

Returns
bitrate

Definition at line 80 of file commeffect.inl.

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