inet::ieee80211::OptionalFs Class Reference

#include <GenericFrameSequences.h>

Inheritance diagram for inet::ieee80211::OptionalFs:

Public Member Functions
virtual	~OptionalFs ()
	OptionalFs (IFrameSequence *element, std::function< bool(OptionalFs *, FrameSequenceContext *)> predicate=nullptr)
virtual int	getStep ()
virtual bool	isSequenceApply (FrameSequenceContext *context)
virtual void	startSequence (FrameSequenceContext *context, int firstStep) override
virtual IFrameSequenceStep *	prepareStep (FrameSequenceContext *context) override
virtual bool	completeStep (FrameSequenceContext *context) override
virtual std::string	getHistory () const override
Public Member Functions inherited from inet::ieee80211::IFrameSequence
virtual	~IFrameSequence ()

Protected Attributes
int	firstStep = -1
int	step = -1
bool	apply = false
IFrameSequence *	element
std::function< bool(OptionalFs *, FrameSequenceContext *)>	predicate

Constructor & Destructor Documentation

~OptionalFs()

virtual inet::ieee80211::OptionalFs::~OptionalFs ( )

inlinevirtual

{ delete element; }

OptionalFs()

inet::ieee80211::OptionalFs::OptionalFs	(	IFrameSequence *	element,
		std::function< bool(OptionalFs *, FrameSequenceContext *)>	predicate = nullptr
	)

                                                                                                                 :
    element(element),
    predicate(predicate)
{
}

Member Function Documentation

completeStep()

bool inet::ieee80211::OptionalFs::completeStep ( FrameSequenceContext *  context )

overridevirtual

Implements inet::ieee80211::IFrameSequence.

{
    ASSERT(apply);
    step++;
    return element->completeStep(context);
}

getHistory()

std::string inet::ieee80211::OptionalFs::getHistory ( ) const

overridevirtual

Implements inet::ieee80211::IFrameSequence.

{
    ASSERT(step != -1);
    return apply ? "[" + element->getHistory() + "]" : "";
}

getStep()

virtual int inet::ieee80211::OptionalFs::getStep ( )

inlinevirtual

{ return firstStep + step; }

isSequenceApply()

virtual bool inet::ieee80211::OptionalFs::isSequenceApply ( FrameSequenceContext *  context )

inlinevirtual

{ return predicate(this, context); }

Referenced by startSequence().

prepareStep()

IFrameSequenceStep * inet::ieee80211::OptionalFs::prepareStep ( FrameSequenceContext *  context )

overridevirtual

Implements inet::ieee80211::IFrameSequence.

{
    return apply ? element->prepareStep(context) : nullptr;
}

startSequence()

void inet::ieee80211::OptionalFs::startSequence ( FrameSequenceContext *  context, int  firstStep  )

overridevirtual

Implements inet::ieee80211::IFrameSequence.

{
    this->firstStep = firstStep;
    step = 0;
    apply = isSequenceApply(context);
    if (apply)
        element->startSequence(context, firstStep);
}

Member Data Documentation

apply

bool inet::ieee80211::OptionalFs::apply = false

protected

Referenced by completeStep(), getHistory(), prepareStep(), and startSequence().

element

IFrameSequence* inet::ieee80211::OptionalFs::element

protected

Referenced by completeStep(), getHistory(), prepareStep(), and startSequence().

firstStep

int inet::ieee80211::OptionalFs::firstStep = -1

protected

Referenced by startSequence().

predicate

std::function<bool(OptionalFs *, FrameSequenceContext *)> inet::ieee80211::OptionalFs::predicate

protected

step

int inet::ieee80211::OptionalFs::step = -1

protected

Referenced by completeStep(), getHistory(), and startSequence().

---

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

• GenericFrameSequences.h
• GenericFrameSequences.cc