INET Framework for OMNeT++/OMNEST
inet::PimStateRefresh Class Reference

Class generated from inet/routing/pim/PimPacket.msg:196 by opp_msgtool. More...

#include <PimPacket_m.h>

Inheritance diagram for inet::PimStateRefresh:
inet::PimPacket inet::FieldsChunk inet::Chunk inet::IPrintableObject inet::IRegionTaggedObject

Public Member Functions

 PimStateRefresh ()
 
 PimStateRefresh (const PimStateRefresh &other)
 
virtual ~PimStateRefresh ()
 
PimStateRefreshoperator= (const PimStateRefresh &other)
 
virtual PimStateRefreshdup () const override
 
virtual void parsimPack (omnetpp::cCommBuffer *b) const override
 
virtual void parsimUnpack (omnetpp::cCommBuffer *b) override
 
virtual const EncodedGroupAddressgetGroupAddress () const
 
virtual EncodedGroupAddressgetGroupAddressForUpdate ()
 
virtual void setGroupAddress (const EncodedGroupAddress &groupAddress)
 
virtual const EncodedUnicastAddressgetSourceAddress () const
 
virtual EncodedUnicastAddressgetSourceAddressForUpdate ()
 
virtual void setSourceAddress (const EncodedUnicastAddress &sourceAddress)
 
virtual const EncodedUnicastAddressgetOriginatorAddress () const
 
virtual EncodedUnicastAddressgetOriginatorAddressForUpdate ()
 
virtual void setOriginatorAddress (const EncodedUnicastAddress &originatorAddress)
 
virtual bool getR () const
 
virtual void setR (bool R)
 
virtual int getMetricPreference () const
 
virtual void setMetricPreference (int metricPreference)
 
virtual int getMetric () const
 
virtual void setMetric (int metric)
 
virtual short getMaskLen () const
 
virtual void setMaskLen (short maskLen)
 
virtual short getTtl () const
 
virtual void setTtl (short ttl)
 
virtual bool getP () const
 
virtual void setP (bool P)
 
virtual bool getN () const
 
virtual void setN (bool N)
 
virtual bool getO () const
 
virtual void setO (bool O)
 
virtual short getReserved2 () const
 
virtual void setReserved2 (short reserved2)
 
virtual short getInterval () const
 
virtual void setInterval (short interval)
 
- Public Member Functions inherited from inet::PimPacket
 PimPacket ()
 
 PimPacket (const PimPacket &other)
 
virtual ~PimPacket ()
 
PimPacketoperator= (const PimPacket &other)
 
virtual short getVersion () const
 
virtual void setVersion (short version)
 
virtual PimPacketType getType () const
 
virtual void setType (PimPacketType type)
 
virtual short getReserved () const
 
virtual void setReserved (short reserved)
 
virtual uint16_t getCrc () const
 
virtual void setCrc (uint16_t crc)
 
virtual CrcMode getCrcMode () const
 
virtual void setCrcMode (CrcMode crcMode)
 
- Public Member Functions inherited from inet::FieldsChunk
 FieldsChunk ()
 
 FieldsChunk (const FieldsChunk &other)
 
virtual ~FieldsChunk ()
 
virtual void parsimPack (cCommBuffer *buffer) const override
 
virtual void parsimUnpack (cCommBuffer *buffer) override
 
virtual void handleChange () override
 
virtual ChunkType getChunkType () const override
 Returns the type of this chunk as an enum member. More...
 
virtual bool containsSameData (const Chunk &other) const override
 Returns true if the two chunks represent the same binary data. More...
 
virtual b getChunkLength () const override
 Returns the length of data represented by this chunk. More...
 
virtual void setChunkLength (b chunkLength)
 
virtual void addChunkLength (b chunkLength)
 
virtual std::ostream & printFieldsToStream (std::ostream &stream, int level, int evFlags=0) const override
 Prints an optinally formatted human readable string representation of the feilds of this chunk to the given stream. More...
 
- Public Member Functions inherited from inet::Chunk
 Chunk ()
 
 Chunk (const Chunk &other)
 
virtual const Ptr< ChunkdupShared () const
 Returns a mutable copy of this chunk in a shared pointer. More...
 
virtual void forEachChild (cVisitor *v) override
 
virtual bool isMutable () const
 
virtual bool isImmutable () const
 
virtual void markImmutable ()
 
void markMutableIfExclusivelyOwned ()
 
virtual bool isComplete () const
 
virtual bool isIncomplete () const
 
virtual void markIncomplete ()
 
virtual bool isCorrect () const
 
virtual bool isIncorrect () const
 
virtual void markIncorrect ()
 
virtual bool isProperlyRepresented () const
 
virtual bool isImproperlyRepresented () const
 
virtual void markImproperlyRepresented ()
 
virtual void moveIterator (Iterator &iterator, b length) const
 
virtual void seekIterator (Iterator &iterator, b position) const
 
virtual bool canInsertAtFront (const Ptr< const Chunk > &chunk) const
 Returns true if this chunk is capable of representing the result. More...
 
virtual bool canInsertAtBack (const Ptr< const Chunk > &chunk) const
 Returns true if this chunk is capable of representing the result. More...
 
virtual bool canInsertAt (const Ptr< const Chunk > &chunk, b offset) const
 Returns true if this chunk is capable of representing the result. More...
 
void insertAtFront (const Ptr< const Chunk > &chunk)
 Inserts the provided chunk at the beginning of this chunk. More...
 
void insertAtBack (const Ptr< const Chunk > &chunk)
 Inserts the provided chunk at the end of this chunk. More...
 
void insertAt (const Ptr< const Chunk > &chunk, b offset)
 Inserts the provided chunk into this chunk. More...
 
virtual bool canRemoveAtFront (b length) const
 Returns true if this chunk is capable of representing the result. More...
 
virtual bool canRemoveAtBack (b length) const
 Returns true if this chunk is capable of representing the result. More...
 
virtual bool canRemoveAt (b offset, b length) const
 Returns true if this chunk is capable of representing the result. More...
 
void removeAtFront (b length)
 Removes the requested part from the beginning of this chunk. More...
 
void removeAtBack (b length)
 Removes the requested part from the end of this chunk. More...
 
void removeAt (b offset, b length)
 Removes the requested part from this chunk. More...
 
int getChunkId () const
 Returns the sequentially assigned id. More...
 
virtual bool isEmpty () const
 Returns true if this chunk contains no data. More...
 
const Ptr< Chunksimplify () const
 Returns the simplified representation of this chunk eliminating all potential redundancies. More...
 
const Ptr< Chunkpeek (const Iterator &iterator, b length=unspecifiedLength, int flags=0) const
 Returns the designated part of the data represented by this chunk in its default representation. More...
 
template<typename T >
bool has (const Iterator &iterator, b length=unspecifiedLength) const
 Returns whether if the designated part of the data is available in the requested representation. More...
 
template<typename T >
const Ptr< Tpeek (const Iterator &iterator, b length=unspecifiedLength, int flags=0) const
 Returns the designated part of the data represented by this chunk in the requested representation. More...
 
virtual SharingRegionTagSetgetRegionTags () override
 Returns all region tags. More...
 
int getNumTags () const
 Returns the number of chunk tags. More...
 
const Ptr< const TagBasegetTag (int index) const
 Returns the chunk tag at the given index. More...
 
void clearTags (b offset=b(0), b length=b(-1))
 Clears the set of chunk tags in the given region. More...
 
void copyTags (const Chunk &source, b sourceOffset=b(0), b offset=b(0), b length=b(-1))
 Copies the set of chunk tags from the source region to the provided region. More...
 
template<typename T >
const Ptr< const TfindTag (b offset=b(0), b length=b(-1)) const
 Returns the chunk tag for the provided type and range, or returns nullptr if no such chunk tag is found. More...
 
template<typename T >
const Ptr< const TgetTag (b offset=b(0), b length=b(-1)) const
 Returns the chunk tag for the provided type and range, or throws an exception if no such chunk tag is found. More...
 
template<typename T >
void mapAllTags (b offset, b length, std::function< void(b, b, const Ptr< const T > &)> f) const
 Maps all tags in the provided range to to the function. More...
 
template<typename T >
void mapAllTagsForUpdate (b offset, b length, std::function< void(b, b, const Ptr< T > &)> f)
 Maps all tags in the provided range to to the function. More...
 
template<typename T >
std::vector< SharingRegionTagSet::RegionTag< const T > > getAllTags (b offset=b(0), b length=b(-1)) const
 Returns all chunk tags for the provided type and range in a detached vector of region tags. More...
 
template<typename T >
std::vector< SharingRegionTagSet::RegionTag< T > > getAllTagsForUpdate (b offset=b(0), b length=b(-1))
 Returns all chunk tags for the provided type and range in a detached vector of region tags. More...
 
template<typename T >
const Ptr< TaddTag (b offset=b(0), b length=b(-1))
 Returns a newly added chunk tag for the provided type and range, or throws an exception if such a chunk tag is already present. More...
 
template<typename T >
const Ptr< TaddTagIfAbsent (b offset=b(0), b length=b(-1))
 Returns a newly added chunk tag for the provided type and range if absent, or returns the chunk tag that is already present. More...
 
template<typename T >
std::vector< SharingRegionTagSet::RegionTag< T > > addTagsWhereAbsent (b offset=b(0), b length=b(-1))
 Returns the newly added chunk tags for the provided type and range where the tag is absent. More...
 
template<typename T >
const Ptr< TremoveTag (b offset, b length)
 Removes the chunk tag for the provided type and range, or throws an exception if no such chunk tag is found. More...
 
template<typename T >
const Ptr< TremoveTagIfPresent (b offset, b length)
 Removes the chunk tag for the provided type and range if present, or returns nullptr if no such chunk tag is found. More...
 
template<typename T >
std::vector< SharingRegionTagSet::RegionTag< T > > removeTagsWherePresent (b offset, b length)
 Removes and returns all chunk tags for the provided type and range. More...
 
virtual std::ostream & printToStream (std::ostream &stream, int level, int evFlags=0) const override
 Prints an optinally formatted human readable string representation of the data present in this chunk to the given stream. More...
 
virtual std::string str () const override
 Returns a human readable string representation of the data present in this chunk. More...
 
- Public Member Functions inherited from inet::IPrintableObject
virtual ~IPrintableObject ()
 
virtual std::string printToString () const
 
virtual std::string printToString (int level, int evFlags=0) const
 
virtual std::string getInfoStringRepresentation (int evFlags=0) const
 
virtual std::string getDetailStringRepresentation (int evFlags=0) const
 
virtual std::string getDebugStringRepresentation (int evFlags=0) const
 
virtual std::string getTraceStringRepresentation (int evFlags=0) const
 
virtual std::string getCompleteStringRepresentation (int evFlags=0) const
 

Protected Member Functions

bool operator== (const PimStateRefresh &)=delete
 
- Protected Member Functions inherited from inet::PimPacket
bool operator== (const PimPacket &)=delete
 
- Protected Member Functions inherited from inet::FieldsChunk
const std::vector< uint8_t > * getSerializedBytes () const
 
void setSerializedBytes (const std::vector< uint8_t > *bytes) const
 
virtual const Ptr< ChunkpeekUnchecked (PeekPredicate predicate, PeekConverter converter, const Iterator &iterator, b length, int flags) const override
 
- Protected Member Functions inherited from inet::Chunk
int getBinDumpNumLines () const
 
int getHexDumpNumLines () const
 
const char * getBinDumpLine (int index)
 
const char * getHexDumpLine (int index)
 
const SharingRegionTagSet::RegionTag< TagBase > & _getTag (int index) const
 
void checkMutable () const
 
virtual void doInsertAtFront (const Ptr< const Chunk > &chunk)
 
virtual void doInsertAtBack (const Ptr< const Chunk > &chunk)
 
virtual void doInsertAt (const Ptr< const Chunk > &chunk, b offset)
 
virtual void doRemoveAtFront (b length)
 
virtual void doRemoveAtBack (b length)
 
virtual void doRemoveAt (b offset, b length)
 
template<typename T >
const Ptr< TpeekConverted (const Iterator &iterator, b length, int flags) const
 
template<typename T >
const Ptr< TcheckPeekResult (const Ptr< T > &chunk, int flags) const
 

Protected Attributes

EncodedGroupAddress groupAddress
 
EncodedUnicastAddress sourceAddress
 
EncodedUnicastAddress originatorAddress
 
bool R = false
 
int metricPreference = 0
 
int metric = 0
 
short maskLen = 0
 
short ttl = 0
 
bool P = false
 
bool N = false
 
bool O = false
 
short reserved2 = 0
 
short interval = 0
 
- Protected Attributes inherited from inet::PimPacket
short version = 2
 
PimPacketType type = static_cast<inet::PimPacketType>(-1)
 
short reserved = 0
 
uint16_t crc = 0
 
CrcMode crcMode = CRC_MODE_UNDEFINED
 
- Protected Attributes inherited from inet::FieldsChunk
b chunkLength
 
const std::vector< uint8_t > * serializedBytes
 The serialized representation of this chunk or nullptr if not available. More...
 
- Protected Attributes inherited from inet::Chunk
int id
 The id is automatically assigned sequentially during construction. More...
 
int flags
 The boolean chunk flags are merged into a single integer. More...
 
SharingRegionTagSet regionTags
 The set of region tags attached to the data represented by this chunk. More...
 
const typedef Ptr< Chunk >(* PeekConverter )(const Ptr< Chunk > &chunk, const Chunk::Iterator &iterator, b length, int flags)
 

Private Member Functions

void copy (const PimStateRefresh &other)
 

Additional Inherited Members

- Public Types inherited from inet::Chunk
enum  ChunkType {
  CT_EMPTY, CT_BITCOUNT, CT_BITS, CT_BYTECOUNT,
  CT_BYTES, CT_SLICE, CT_ENCRYPTED, CT_CPACKET,
  CT_SEQUENCE, CT_FIELDS
}
 This enum is used to avoid std::dynamic_cast and dynamicPtrCast. More...
 
enum  PeekFlag {
  PF_ALLOW_NULLPTR = (1 << 0), PF_ALLOW_EMPTY = (1 << 1), PF_ALLOW_INCOMPLETE = (1 << 2), PF_ALLOW_INCORRECT = (1 << 3),
  PF_ALLOW_IMPROPERLY_REPRESENTED = (1 << 4), PF_ALLOW_SERIALIZATION = (1 << 5), PF_ALLOW_ALL = -1
}
 This enum specifies bitmasks for the flags argument of various peek functions. More...
 
- Public Types inherited from inet::IPrintableObject
enum  PrintLevel {
  PRINT_LEVEL_TRACE, PRINT_LEVEL_DEBUG, PRINT_LEVEL_DETAIL, PRINT_LEVEL_INFO,
  PRINT_LEVEL_COMPLETE = INT_MIN
}
 
enum  PrintFlag { PRINT_FLAG_FORMATTED = (1 << 0), PRINT_FLAG_MULTILINE = (1 << 1) }
 
- Static Public Member Functions inherited from inet::Chunk
static void serialize (MemoryOutputStream &stream, const Ptr< const Chunk > &chunk, b offset=b(0), b length=b(-1))
 Serializes a chunk into the given stream. More...
 
static const Ptr< Chunkdeserialize (MemoryInputStream &stream, const std::type_info &typeInfo)
 Deserializes a chunk from the given stream. More...
 
- Static Public Attributes inherited from inet::Chunk
static const b unspecifiedLength = b(-std::numeric_limits<int64_t>::max())
 
static bool enableImplicitChunkSerialization = false
 Peeking some part into a chunk that requires automatic serialization will throw an exception when implicit chunk serialization is disabled. More...
 
static int nextId = 0
 
- Protected Types inherited from inet::Chunk
enum  ChunkFlag { CF_IMMUTABLE = (1 << 0), CF_INCOMPLETE = (1 << 1), CF_INCORRECT = (1 << 2), CF_IMPROPERLY_REPRESENTED = (1 << 3) }
 This enum specifies bitmasks for the flags field of Chunk. More...
 
typedef bool(* PeekPredicate) (const Ptr< Chunk > &)
 
- Static Protected Member Functions inherited from inet::FieldsChunk
static const Ptr< ChunkconvertChunk (const std::type_info &typeInfo, const Ptr< Chunk > &chunk, b offset, b length, int flags)
 
- Static Protected Member Functions inherited from inet::Chunk
static const Ptr< ChunkconvertChunk (const std::type_info &typeInfo, const Ptr< Chunk > &chunk, b offset, b length, int flags)
 Creates a new chunk of the given type that represents the designated part of the provided chunk. More...
 

Detailed Description

Class generated from inet/routing/pim/PimPacket.msg:196 by opp_msgtool.

// State Refresh message
// DM
class PimStateRefresh extends PimPacket
{
    type = StateRefresh;
    EncodedGroupAddress groupAddress;
    EncodedUnicastAddress sourceAddress;
    EncodedUnicastAddress originatorAddress;
    bool R;
    int metricPreference;
    int metric;
    short maskLen;
    short ttl;
    bool P;
    bool N;
    bool O;
    short reserved2;
    short interval;
}

Constructor & Destructor Documentation

◆ PimStateRefresh() [1/2]

inet::PimStateRefresh::PimStateRefresh ( )

◆ PimStateRefresh() [2/2]

inet::PimStateRefresh::PimStateRefresh ( const PimStateRefresh other)

◆ ~PimStateRefresh()

virtual inet::PimStateRefresh::~PimStateRefresh ( )
virtual

Member Function Documentation

◆ copy()

void inet::PimStateRefresh::copy ( const PimStateRefresh other)
private

◆ dup()

virtual PimStateRefresh* inet::PimStateRefresh::dup ( ) const
inlineoverridevirtual

Reimplemented from inet::PimPacket.

833 {return new PimStateRefresh(*this);}

◆ getGroupAddress()

virtual const EncodedGroupAddress& inet::PimStateRefresh::getGroupAddress ( ) const
virtual

◆ getGroupAddressForUpdate()

virtual EncodedGroupAddress& inet::PimStateRefresh::getGroupAddressForUpdate ( )
inlinevirtual
838 { handleChange();return const_cast<EncodedGroupAddress&>(const_cast<PimStateRefresh*>(this)->getGroupAddress());}

◆ getInterval()

virtual short inet::PimStateRefresh::getInterval ( ) const
virtual

◆ getMaskLen()

virtual short inet::PimStateRefresh::getMaskLen ( ) const
virtual

◆ getMetric()

virtual int inet::PimStateRefresh::getMetric ( ) const
virtual

◆ getMetricPreference()

virtual int inet::PimStateRefresh::getMetricPreference ( ) const
virtual

◆ getN()

virtual bool inet::PimStateRefresh::getN ( ) const
virtual

◆ getO()

virtual bool inet::PimStateRefresh::getO ( ) const
virtual

◆ getOriginatorAddress()

virtual const EncodedUnicastAddress& inet::PimStateRefresh::getOriginatorAddress ( ) const
virtual

◆ getOriginatorAddressForUpdate()

virtual EncodedUnicastAddress& inet::PimStateRefresh::getOriginatorAddressForUpdate ( )
inlinevirtual
846 { handleChange();return const_cast<EncodedUnicastAddress&>(const_cast<PimStateRefresh*>(this)->getOriginatorAddress());}

◆ getP()

virtual bool inet::PimStateRefresh::getP ( ) const
virtual

◆ getR()

virtual bool inet::PimStateRefresh::getR ( ) const
virtual

◆ getReserved2()

virtual short inet::PimStateRefresh::getReserved2 ( ) const
virtual

◆ getSourceAddress()

virtual const EncodedUnicastAddress& inet::PimStateRefresh::getSourceAddress ( ) const
virtual

◆ getSourceAddressForUpdate()

virtual EncodedUnicastAddress& inet::PimStateRefresh::getSourceAddressForUpdate ( )
inlinevirtual
842 { handleChange();return const_cast<EncodedUnicastAddress&>(const_cast<PimStateRefresh*>(this)->getSourceAddress());}

◆ getTtl()

virtual short inet::PimStateRefresh::getTtl ( ) const
virtual

◆ operator=()

PimStateRefresh& inet::PimStateRefresh::operator= ( const PimStateRefresh other)

◆ operator==()

bool inet::PimStateRefresh::operator== ( const PimStateRefresh )
protecteddelete

◆ parsimPack()

virtual void inet::PimStateRefresh::parsimPack ( omnetpp::cCommBuffer *  b) const
overridevirtual

Reimplemented from inet::PimPacket.

Referenced by inet::doParsimPacking().

◆ parsimUnpack()

virtual void inet::PimStateRefresh::parsimUnpack ( omnetpp::cCommBuffer *  b)
overridevirtual

Reimplemented from inet::PimPacket.

Referenced by inet::doParsimUnpacking().

◆ setGroupAddress()

virtual void inet::PimStateRefresh::setGroupAddress ( const EncodedGroupAddress groupAddress)
virtual

◆ setInterval()

virtual void inet::PimStateRefresh::setInterval ( short  interval)
virtual

◆ setMaskLen()

virtual void inet::PimStateRefresh::setMaskLen ( short  maskLen)
virtual

◆ setMetric()

virtual void inet::PimStateRefresh::setMetric ( int  metric)
virtual

◆ setMetricPreference()

virtual void inet::PimStateRefresh::setMetricPreference ( int  metricPreference)
virtual

◆ setN()

virtual void inet::PimStateRefresh::setN ( bool  N)
virtual

◆ setO()

virtual void inet::PimStateRefresh::setO ( bool  O)
virtual

◆ setOriginatorAddress()

virtual void inet::PimStateRefresh::setOriginatorAddress ( const EncodedUnicastAddress originatorAddress)
virtual

◆ setP()

virtual void inet::PimStateRefresh::setP ( bool  P)
virtual

◆ setR()

virtual void inet::PimStateRefresh::setR ( bool  R)
virtual

◆ setReserved2()

virtual void inet::PimStateRefresh::setReserved2 ( short  reserved2)
virtual

◆ setSourceAddress()

virtual void inet::PimStateRefresh::setSourceAddress ( const EncodedUnicastAddress sourceAddress)
virtual

◆ setTtl()

virtual void inet::PimStateRefresh::setTtl ( short  ttl)
virtual

Member Data Documentation

◆ groupAddress

EncodedGroupAddress inet::PimStateRefresh::groupAddress
protected

◆ interval

short inet::PimStateRefresh::interval = 0
protected

◆ maskLen

short inet::PimStateRefresh::maskLen = 0
protected

◆ metric

int inet::PimStateRefresh::metric = 0
protected

◆ metricPreference

int inet::PimStateRefresh::metricPreference = 0
protected

◆ N

bool inet::PimStateRefresh::N = false
protected

◆ O

bool inet::PimStateRefresh::O = false
protected

◆ originatorAddress

EncodedUnicastAddress inet::PimStateRefresh::originatorAddress
protected

◆ P

bool inet::PimStateRefresh::P = false
protected

◆ R

bool inet::PimStateRefresh::R = false
protected

◆ reserved2

short inet::PimStateRefresh::reserved2 = 0
protected

◆ sourceAddress

EncodedUnicastAddress inet::PimStateRefresh::sourceAddress
protected

◆ ttl

short inet::PimStateRefresh::ttl = 0
protected

The documentation for this class was generated from the following file:
inet::PimStateRefresh::getGroupAddress
virtual const EncodedGroupAddress & getGroupAddress() const
inet::PimStateRefresh::PimStateRefresh
PimStateRefresh()
inet::FieldsChunk::handleChange
virtual void handleChange() override
Definition: FieldsChunk.cc:50
inet::PimStateRefresh::getSourceAddress
virtual const EncodedUnicastAddress & getSourceAddress() const
inet::PimStateRefresh::getOriginatorAddress
virtual const EncodedUnicastAddress & getOriginatorAddress() const