This interface is used to cache various intermediate computation results related to the communication on the medium. More...

#include <ICommunicationCache.h>

Inheritance diagram for inet::physicallayer::ICommunicationCache:

Public Member Functions
Medium state change notifications
virtual void	addRadio (const IRadio *radio)=0

virtual void	removeRadio (const IRadio *radio)=0

virtual void	addTransmission (const ITransmission *transmission)=0

virtual void	removeTransmission (const ITransmission *transmission)=0

Interference cache
virtual std::vector< const ITransmission * > *	computeInterferingTransmissions (const IRadio *radio, const simtime_t startTime, const simtime_t endTime)=0

virtual void	removeNonInterferingTransmissions ()=0

Transmission cache
virtual const simtime_t	getCachedInterferenceEndTime (const ITransmission *transmission)=0

virtual void	setCachedInterferenceEndTime (const ITransmission *transmission, const simtime_t interferenceEndTime)=0

virtual void	removeCachedInterferenceEndTime (const ITransmission *transmission)=0

virtual const IRadioFrame *	getCachedFrame (const ITransmission *transmission)=0

virtual void	setCachedFrame (const ITransmission transmission, const IRadioFrame radioFrame)=0

virtual void	removeCachedFrame (const ITransmission *transmission)=0

Reception Cache
virtual const IArrival *	getCachedArrival (const IRadio receiver, const ITransmission transmission)=0

virtual void	setCachedArrival (const IRadio receiver, const ITransmission transmission, const IArrival *arrival)=0

virtual void	removeCachedArrival (const IRadio receiver, const ITransmission transmission)=0

virtual const Interval *	getCachedInterval (const IRadio receiver, const ITransmission transmission)=0

virtual void	setCachedInterval (const IRadio receiver, const ITransmission transmission, const Interval *interval)=0

virtual void	removeCachedInterval (const IRadio receiver, const ITransmission transmission)=0

virtual const IListening *	getCachedListening (const IRadio receiver, const ITransmission transmission)=0

virtual void	setCachedListening (const IRadio receiver, const ITransmission transmission, const IListening *listening)=0

virtual void	removeCachedListening (const IRadio receiver, const ITransmission transmission)=0

virtual const IReception *	getCachedReception (const IRadio receiver, const ITransmission transmission)=0

virtual void	setCachedReception (const IRadio receiver, const ITransmission transmission, const IReception *reception)=0

virtual void	removeCachedReception (const IRadio receiver, const ITransmission transmission)=0

virtual const IInterference *	getCachedInterference (const IRadio receiver, const ITransmission transmission)=0

virtual void	setCachedInterference (const IRadio receiver, const ITransmission transmission, const IInterference *interference)=0

virtual void	removeCachedInterference (const IRadio receiver, const ITransmission transmission)=0

virtual const INoise *	getCachedNoise (const IRadio receiver, const ITransmission transmission)=0

virtual void	setCachedNoise (const IRadio receiver, const ITransmission transmission, const INoise *noise)=0

virtual void	removeCachedNoise (const IRadio receiver, const ITransmission transmission)=0

virtual const ISNIR *	getCachedSNIR (const IRadio receiver, const ITransmission transmission)=0

virtual void	setCachedSNIR (const IRadio receiver, const ITransmission transmission, const ISNIR *snir)=0

virtual void	removeCachedSNIR (const IRadio receiver, const ITransmission transmission)=0

virtual const IReceptionDecision *	getCachedReceptionDecision (const IRadio receiver, const ITransmission transmission, IRadioSignal::SignalPart part)=0

virtual void	setCachedReceptionDecision (const IRadio receiver, const ITransmission transmission, IRadioSignal::SignalPart part, const IReceptionDecision *receptionDecision)=0

virtual void	removeCachedReceptionDecision (const IRadio receiver, const ITransmission transmission, IRadioSignal::SignalPart part)=0

virtual const IReceptionResult *	getCachedReceptionResult (const IRadio receiver, const ITransmission transmission)=0

virtual void	setCachedReceptionResult (const IRadio receiver, const ITransmission transmission, const IReceptionResult *receptionResult)=0

virtual void	removeCachedReceptionResult (const IRadio receiver, const ITransmission transmission)=0

virtual const IRadioFrame *	getCachedFrame (const IRadio receiver, const ITransmission transmission)=0

virtual void	setCachedFrame (const IRadio receiver, const ITransmission transmission, const IRadioFrame *radioFrame)=0

virtual void	removeCachedFrame (const IRadio receiver, const ITransmission transmission)=0

Public Member Functions inherited from inet::physicallayer::IPrintableObject
virtual	~IPrintableObject ()

virtual std::ostream &	printToStream (std::ostream &stream, int level) const
	Prints this object to the provided output stream. More...

virtual std::string	getInfoStringRepresentation () const

virtual std::string	getDetailStringRepresentation () const

virtual std::string	getDebugStringRepresentation () const

virtual std::string	getTraceStringRepresentation () const

virtual std::string	getCompleteStringRepresentation () const

Additional Inherited Members
Public Types inherited from inet::physicallayer::IPrintableObject
enum	PrintLevel { PRINT_LEVEL_TRACE, PRINT_LEVEL_DEBUG, PRINT_LEVEL_DETAIL, PRINT_LEVEL_INFO, PRINT_LEVEL_COMPLETE = INT_MIN }

Detailed Description

This interface is used to cache various intermediate computation results related to the communication on the medium.

Member Function Documentation

virtual void inet::physicallayer::ICommunicationCache::addRadio ( const IRadio * radio )

pure virtual

Implemented in inet::physicallayer::VectorCommunicationCache, inet::physicallayer::MapCommunicationCache, and inet::physicallayer::ReferenceCommunicationCache.

Referenced by inet::physicallayer::RadioMedium::addRadio().

virtual void inet::physicallayer::ICommunicationCache::addTransmission ( const ITransmission * transmission )

pure virtual

Implemented in inet::physicallayer::VectorCommunicationCache, inet::physicallayer::MapCommunicationCache, and inet::physicallayer::ReferenceCommunicationCache.

Referenced by inet::physicallayer::RadioMedium::addTransmission().

virtual std::vector<const ITransmission > inet::physicallayer::ICommunicationCache::computeInterferingTransmissions	(	const IRadio *	radio,
		const simtime_t	startTime,
		const simtime_t	endTime
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase, and inet::physicallayer::ReferenceCommunicationCache.

Referenced by inet::physicallayer::RadioMedium::computeInterferingReceptions().

virtual const IArrival* inet::physicallayer::ICommunicationCache::getCachedArrival	(	const IRadio *	receiver,
		const ITransmission *	transmission
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

Referenced by inet::physicallayer::RadioMedium::getArrival().

virtual const IRadioFrame* inet::physicallayer::ICommunicationCache::getCachedFrame ( const ITransmission * transmission )

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

Referenced by inet::physicallayer::RadioMedium::receiveSignal(), inet::physicallayer::RadioMedium::removeNonInterferingTransmissions(), and inet::physicallayer::RadioMedium::~RadioMedium().

virtual const IRadioFrame* inet::physicallayer::ICommunicationCache::getCachedFrame	(	const IRadio *	receiver,
		const ITransmission *	transmission
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

virtual const IInterference* inet::physicallayer::ICommunicationCache::getCachedInterference	(	const IRadio *	receiver,
		const ITransmission *	transmission
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase, and inet::physicallayer::ReferenceCommunicationCache.

Referenced by inet::physicallayer::RadioMedium::getInterference().

virtual const simtime_t inet::physicallayer::ICommunicationCache::getCachedInterferenceEndTime ( const ITransmission * transmission )

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

Referenced by inet::physicallayer::RadioMedium::addTransmission(), inet::visualizer::MediumVisualizerBase::isSignalPropagationInProgress(), and inet::physicallayer::RadioMedium::removeNonInterferingTransmissions().

virtual const Interval* inet::physicallayer::ICommunicationCache::getCachedInterval	(	const IRadio *	receiver,
		const ITransmission *	transmission
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

virtual const IListening* inet::physicallayer::ICommunicationCache::getCachedListening	(	const IRadio *	receiver,
		const ITransmission *	transmission
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

Referenced by inet::physicallayer::RadioMedium::getInterference(), inet::physicallayer::RadioMedium::getListening(), inet::physicallayer::RadioMedium::getNoise(), inet::physicallayer::RadioMedium::receivePacket(), and inet::physicallayer::RadioMedium::receiveSignal().

virtual const INoise* inet::physicallayer::ICommunicationCache::getCachedNoise	(	const IRadio *	receiver,
		const ITransmission *	transmission
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase, and inet::physicallayer::ReferenceCommunicationCache.

Referenced by inet::physicallayer::RadioMedium::getNoise().

virtual const IReception* inet::physicallayer::ICommunicationCache::getCachedReception	(	const IRadio *	receiver,
		const ITransmission *	transmission
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase, and inet::physicallayer::ReferenceCommunicationCache.

Referenced by inet::physicallayer::RadioMedium::getReception().

virtual const IReceptionDecision* inet::physicallayer::ICommunicationCache::getCachedReceptionDecision	(	const IRadio *	receiver,
		const ITransmission *	transmission,
		IRadioSignal::SignalPart	part
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase, and inet::physicallayer::ReferenceCommunicationCache.

Referenced by inet::physicallayer::RadioMedium::getReceptionDecision().

virtual const IReceptionResult* inet::physicallayer::ICommunicationCache::getCachedReceptionResult	(	const IRadio *	receiver,
		const ITransmission *	transmission
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

Referenced by inet::physicallayer::RadioMedium::getReceptionResult().

virtual const ISNIR* inet::physicallayer::ICommunicationCache::getCachedSNIR	(	const IRadio *	receiver,
		const ITransmission *	transmission
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase, and inet::physicallayer::ReferenceCommunicationCache.

Referenced by inet::physicallayer::RadioMedium::getSNIR().

virtual void inet::physicallayer::ICommunicationCache::removeCachedArrival	(	const IRadio *	receiver,
		const ITransmission *	transmission
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

virtual void inet::physicallayer::ICommunicationCache::removeCachedFrame ( const ITransmission * transmission )

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

Referenced by inet::physicallayer::RadioMedium::removeNonInterferingTransmissions().

virtual void inet::physicallayer::ICommunicationCache::removeCachedFrame	(	const IRadio *	receiver,
		const ITransmission *	transmission
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

virtual void inet::physicallayer::ICommunicationCache::removeCachedInterference	(	const IRadio *	receiver,
		const ITransmission *	transmission
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

virtual void inet::physicallayer::ICommunicationCache::removeCachedInterferenceEndTime ( const ITransmission * transmission )

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

virtual void inet::physicallayer::ICommunicationCache::removeCachedInterval	(	const IRadio *	receiver,
		const ITransmission *	transmission
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

virtual void inet::physicallayer::ICommunicationCache::removeCachedListening	(	const IRadio *	receiver,
		const ITransmission *	transmission
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

virtual void inet::physicallayer::ICommunicationCache::removeCachedNoise	(	const IRadio *	receiver,
		const ITransmission *	transmission
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

virtual void inet::physicallayer::ICommunicationCache::removeCachedReception	(	const IRadio *	receiver,
		const ITransmission *	transmission
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

virtual void inet::physicallayer::ICommunicationCache::removeCachedReceptionDecision	(	const IRadio *	receiver,
		const ITransmission *	transmission,
		IRadioSignal::SignalPart	part
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

virtual void inet::physicallayer::ICommunicationCache::removeCachedReceptionResult	(	const IRadio *	receiver,
		const ITransmission *	transmission
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

Referenced by inet::physicallayer::RadioMedium::receivePacket().

virtual void inet::physicallayer::ICommunicationCache::removeCachedSNIR	(	const IRadio *	receiver,
		const ITransmission *	transmission
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

virtual void inet::physicallayer::ICommunicationCache::removeNonInterferingTransmissions ( )

pure virtual

Implemented in inet::physicallayer::VectorCommunicationCache, inet::physicallayer::MapCommunicationCache, and inet::physicallayer::ReferenceCommunicationCache.

Referenced by inet::physicallayer::RadioMedium::removeNonInterferingTransmissions().

virtual void inet::physicallayer::ICommunicationCache::removeRadio ( const IRadio * radio )

pure virtual

Implemented in inet::physicallayer::VectorCommunicationCache, inet::physicallayer::MapCommunicationCache, and inet::physicallayer::ReferenceCommunicationCache.

Referenced by inet::physicallayer::RadioMedium::removeRadio().

virtual void inet::physicallayer::ICommunicationCache::removeTransmission ( const ITransmission * transmission )

pure virtual

Implemented in inet::physicallayer::VectorCommunicationCache, inet::physicallayer::MapCommunicationCache, and inet::physicallayer::ReferenceCommunicationCache.

Referenced by inet::physicallayer::RadioMedium::removeNonInterferingTransmissions().

virtual void inet::physicallayer::ICommunicationCache::setCachedArrival	(	const IRadio *	receiver,
		const ITransmission *	transmission,
		const IArrival *	arrival
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

Referenced by inet::physicallayer::RadioMedium::addRadio(), and inet::physicallayer::RadioMedium::addTransmission().

virtual void inet::physicallayer::ICommunicationCache::setCachedFrame	(	const ITransmission *	transmission,
		const IRadioFrame *	radioFrame
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

Referenced by inet::physicallayer::RadioMedium::receiveSignal(), inet::physicallayer::RadioMedium::sendToRadio(), and inet::physicallayer::RadioMedium::transmitPacket().

virtual void inet::physicallayer::ICommunicationCache::setCachedFrame	(	const IRadio *	receiver,
		const ITransmission *	transmission,
		const IRadioFrame *	radioFrame
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

virtual void inet::physicallayer::ICommunicationCache::setCachedInterference	(	const IRadio *	receiver,
		const ITransmission *	transmission,
		const IInterference *	interference
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

Referenced by inet::physicallayer::RadioMedium::getInterference().

virtual void inet::physicallayer::ICommunicationCache::setCachedInterferenceEndTime	(	const ITransmission *	transmission,
		const simtime_t	interferenceEndTime
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

Referenced by inet::physicallayer::RadioMedium::addTransmission().

virtual void inet::physicallayer::ICommunicationCache::setCachedInterval	(	const IRadio *	receiver,
		const ITransmission *	transmission,
		const Interval *	interval
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

Referenced by inet::physicallayer::RadioMedium::addTransmission().

virtual void inet::physicallayer::ICommunicationCache::setCachedListening	(	const IRadio *	receiver,
		const ITransmission *	transmission,
		const IListening *	listening
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

Referenced by inet::physicallayer::RadioMedium::addRadio(), inet::physicallayer::RadioMedium::addTransmission(), and inet::physicallayer::RadioMedium::receiveSignal().

virtual void inet::physicallayer::ICommunicationCache::setCachedNoise	(	const IRadio *	receiver,
		const ITransmission *	transmission,
		const INoise *	noise
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

Referenced by inet::physicallayer::RadioMedium::getNoise().

virtual void inet::physicallayer::ICommunicationCache::setCachedReception	(	const IRadio *	receiver,
		const ITransmission *	transmission,
		const IReception *	reception
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

Referenced by inet::physicallayer::RadioMedium::getReception().

virtual void inet::physicallayer::ICommunicationCache::setCachedReceptionDecision	(	const IRadio *	receiver,
		const ITransmission *	transmission,
		IRadioSignal::SignalPart	part,
		const IReceptionDecision *	receptionDecision
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

Referenced by inet::physicallayer::RadioMedium::getReceptionDecision().

virtual void inet::physicallayer::ICommunicationCache::setCachedReceptionResult	(	const IRadio *	receiver,
		const ITransmission *	transmission,
		const IReceptionResult *	receptionResult
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

Referenced by inet::physicallayer::RadioMedium::getReceptionResult().

virtual void inet::physicallayer::ICommunicationCache::setCachedSNIR	(	const IRadio *	receiver,
		const ITransmission *	transmission,
		const ISNIR *	snir
	)

pure virtual

Implemented in inet::physicallayer::CommunicationCacheBase.

Referenced by inet::physicallayer::RadioMedium::getSNIR().

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

ICommunicationCache.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation