INET Framework for OMNeT++/OMNEST
inet::rtp::RTPInnerPacket_Base Class Reference

Class generated from inet/transportlayer/rtp/RTPInnerPacket.msg:61 by nedtool. More...

#include <RTPInnerPacket_m.h>

Inheritance diagram for inet::rtp::RTPInnerPacket_Base:
inet::rtp::RTPInnerPacket

Public Member Functions

virtual ~RTPInnerPacket_Base ()
 
virtual RTPInnerPacket_Basedup () const override
 
virtual void parsimPack (omnetpp::cCommBuffer *b) const override
 
virtual void parsimUnpack (omnetpp::cCommBuffer *b) override
 
virtual short getType () const
 
virtual void setType (short type)
 
virtual const char * getCommonName () const
 
virtual void setCommonName (const char *commonName)
 
virtual int getMtu () const
 
virtual void setMtu (int mtu)
 
virtual int getBandwidth () const
 
virtual void setBandwidth (int bandwidth)
 
virtual int getRtcpPercentage () const
 
virtual void setRtcpPercentage (int rtcpPercentage)
 
virtual IPv4AddressgetAddress ()
 
virtual const IPv4AddressgetAddress () const
 
virtual void setAddress (const IPv4Address &address)
 
virtual int getPort () const
 
virtual void setPort (int port)
 
virtual uint32_t getSsrc () const
 
virtual void setSsrc (uint32_t ssrc)
 
virtual int getPayloadType () const
 
virtual void setPayloadType (int payloadType)
 
virtual const char * getFileName () const
 
virtual void setFileName (const char *fileName)
 
virtual int getClockRate () const
 
virtual void setClockRate (int clockRate)
 
virtual int getTimeStampBase () const
 
virtual void setTimeStampBase (int timeStampBase)
 
virtual int getSequenceNumberBase () const
 
virtual void setSequenceNumberBase (int sequenceNumberBase)
 

Protected Member Functions

bool operator== (const RTPInnerPacket_Base &)
 
 RTPInnerPacket_Base (const char *name=nullptr, short kind=0)
 
 RTPInnerPacket_Base (const RTPInnerPacket_Base &other)
 
RTPInnerPacket_Baseoperator= (const RTPInnerPacket_Base &other)
 

Protected Attributes

short type
 
::omnetpp::opp_string commonName
 
int mtu
 
int bandwidth
 
int rtcpPercentage
 
IPv4Address address
 
int port
 
uint32_t ssrc
 
int payloadType
 
::omnetpp::opp_string fileName
 
int clockRate
 
int timeStampBase
 
int sequenceNumberBase
 

Private Member Functions

void copy (const RTPInnerPacket_Base &other)
 

Detailed Description

Class generated from inet/transportlayer/rtp/RTPInnerPacket.msg:61 by nedtool.

//
// This class is used for communication between submodules of the RTP layer module.
//
packet RTPInnerPacket
{
    @customize(true);  // see the generated C++ header for more info
    // The type of this ~RTPInnerPacket.
    short type @enum(RTP_INP_TYPE) = RTP_INP_UNDEF;
    // The CNAME
    string commonName;
    // The MTU
    int mtu;
    // The Bandwidth
    int bandwidth;
    // The RTCP percentage
    int rtcpPercentage;
    // The IPv4 address
    IPv4Address address = IPv4Address::UNSPECIFIED_ADDRESS;
    // The port number
    int port = PORT_UNDEF;
    // The SSRC identifier
    uint32 ssrc;
    // The payload type
    int payloadType;
    // The file name
    string fileName;
    // The clock rate
    int clockRate;
    // The RTP time stamp base
    int timeStampBase;
    // The RTP sequence number base
    int sequenceNumberBase;
}

RTPInnerPacket_Base is only useful if it gets subclassed, and RTPInnerPacket is derived from it. The minimum code to be written for RTPInnerPacket is the following:

class INET_API RTPInnerPacket : public RTPInnerPacket_Base
{
  private:
    void copy(const RTPInnerPacket& other) { ... }
  public:
    RTPInnerPacket(const char *name=nullptr, short kind=0) : RTPInnerPacket_Base(name,kind) {}
    RTPInnerPacket(const RTPInnerPacket& other) : RTPInnerPacket_Base(other) {copy(other);}
    RTPInnerPacket& operator=(const RTPInnerPacket& other) {if (this==&other) return *this; RTPInnerPacket_Base::operator=(other); copy(other); return *this;}
    virtual RTPInnerPacket *dup() const override {return new RTPInnerPacket(*this);}
    // ADD CODE HERE to redefine and implement pure virtual functions from RTPInnerPacket_Base
};

The following should go into a .cc (.cpp) file:

Register_Class(RTPInnerPacket)

Constructor & Destructor Documentation

inet::rtp::RTPInnerPacket_Base::RTPInnerPacket_Base ( const char *  name = nullptr,
short  kind = 0 
)
protected
inet::rtp::RTPInnerPacket_Base::RTPInnerPacket_Base ( const RTPInnerPacket_Base other)
protected
virtual inet::rtp::RTPInnerPacket_Base::~RTPInnerPacket_Base ( )
virtual

Member Function Documentation

void inet::rtp::RTPInnerPacket_Base::copy ( const RTPInnerPacket_Base other)
private
virtual RTPInnerPacket_Base* inet::rtp::RTPInnerPacket_Base::dup ( ) const
inlineoverridevirtual

Reimplemented in inet::rtp::RTPInnerPacket.

198 {throw omnetpp::cRuntimeError("You forgot to manually add a dup() function to class RTPInnerPacket");}
virtual IPv4Address& inet::rtp::RTPInnerPacket_Base::getAddress ( )
virtual
virtual const IPv4Address& inet::rtp::RTPInnerPacket_Base::getAddress ( ) const
inlinevirtual

Referenced by getAddress().

214 {return const_cast<RTPInnerPacket_Base*>(this)->getAddress();}
virtual IPv4Address & getAddress()
RTPInnerPacket_Base(const char *name=nullptr, short kind=0)
virtual int inet::rtp::RTPInnerPacket_Base::getBandwidth ( ) const
virtual
virtual int inet::rtp::RTPInnerPacket_Base::getClockRate ( ) const
virtual
virtual const char* inet::rtp::RTPInnerPacket_Base::getCommonName ( ) const
virtual
virtual const char* inet::rtp::RTPInnerPacket_Base::getFileName ( ) const
virtual
virtual int inet::rtp::RTPInnerPacket_Base::getMtu ( ) const
virtual
virtual int inet::rtp::RTPInnerPacket_Base::getPayloadType ( ) const
virtual
virtual int inet::rtp::RTPInnerPacket_Base::getPort ( ) const
virtual
virtual int inet::rtp::RTPInnerPacket_Base::getRtcpPercentage ( ) const
virtual
virtual int inet::rtp::RTPInnerPacket_Base::getSequenceNumberBase ( ) const
virtual
virtual int inet::rtp::RTPInnerPacket_Base::getTimeStampBase ( ) const
virtual
RTPInnerPacket_Base& inet::rtp::RTPInnerPacket_Base::operator= ( const RTPInnerPacket_Base other)
protected
bool inet::rtp::RTPInnerPacket_Base::operator== ( const RTPInnerPacket_Base )
protected
virtual void inet::rtp::RTPInnerPacket_Base::parsimPack ( omnetpp::cCommBuffer *  b) const
overridevirtual
virtual void inet::rtp::RTPInnerPacket_Base::parsimUnpack ( omnetpp::cCommBuffer *  b)
overridevirtual
virtual void inet::rtp::RTPInnerPacket_Base::setAddress ( const IPv4Address address)
virtual
virtual void inet::rtp::RTPInnerPacket_Base::setBandwidth ( int  bandwidth)
virtual
virtual void inet::rtp::RTPInnerPacket_Base::setClockRate ( int  clockRate)
virtual
virtual void inet::rtp::RTPInnerPacket_Base::setCommonName ( const char *  commonName)
virtual
virtual void inet::rtp::RTPInnerPacket_Base::setFileName ( const char *  fileName)
virtual
virtual void inet::rtp::RTPInnerPacket_Base::setMtu ( int  mtu)
virtual
virtual void inet::rtp::RTPInnerPacket_Base::setPayloadType ( int  payloadType)
virtual
virtual void inet::rtp::RTPInnerPacket_Base::setPort ( int  port)
virtual
virtual void inet::rtp::RTPInnerPacket_Base::setRtcpPercentage ( int  rtcpPercentage)
virtual
virtual void inet::rtp::RTPInnerPacket_Base::setSequenceNumberBase ( int  sequenceNumberBase)
virtual
virtual void inet::rtp::RTPInnerPacket_Base::setSsrc ( uint32_t  ssrc)
virtual
virtual void inet::rtp::RTPInnerPacket_Base::setTimeStampBase ( int  timeStampBase)
virtual
virtual void inet::rtp::RTPInnerPacket_Base::setType ( short  type)
virtual

Member Data Documentation

int inet::rtp::RTPInnerPacket_Base::bandwidth
protected
int inet::rtp::RTPInnerPacket_Base::clockRate
protected
::omnetpp::opp_string inet::rtp::RTPInnerPacket_Base::commonName
protected
::omnetpp::opp_string inet::rtp::RTPInnerPacket_Base::fileName
protected
int inet::rtp::RTPInnerPacket_Base::sequenceNumberBase
protected
int inet::rtp::RTPInnerPacket_Base::timeStampBase
protected

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