scenarioEventController.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2013 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#pragma once

#include "vrfmodel/vrfmodelDefines.h"
#include "vrfobjcore/singleTaskControllerComponent.h"
#include <vrfutil/rwScenarioEvent.h>

class DT_DLL_vrfmodel DtScenarioEventController : public DtSingleTaskControllerComponent
{
private:
   //Not Implemented.
   DtScenarioEventController();
   //Not Implemented.
   DtScenarioEventController(const DtScenarioEventController& orig);
   //Not Implemented.
   DtScenarioEventController& operator=(const DtScenarioEventController& orig);

public:

   //\copydoc DtSimComponent(const DtString&,DtVrfObject*,DtSimManager*,
   //DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)
   DtScenarioEventController(const DtString& name, 
      DtVrfObject* owner,
      DtSimManager* simManager, 
      DtComponentDescriptor* desc = NULL,
      DtReaderWriterRegistry* parentRegistry = NULL);

   virtual ~DtScenarioEventController();

   //\copydoc DtSimComponent::type()
   //\return DtScriptedMovementControllerType.
   virtual const char* type() const;

   //Main processing for component.
   virtual void tick();

public:

   //\copydoc DtSimComponent(const DtString&,DtVrfObject*,DtSimManager*,
   //DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)
   //\return New instance of this class.
   static DtSimComponent * creator(const DtString& name, 
      DtVrfObject* owner,
      DtSimManager* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

protected:
   virtual void preFirstTickInit();
   virtual void setupEventIfNeeded();

   virtual bool timeToStartFromTimeOfDay() const;

   virtual bool timeToStartFromScenarioTime() const;

   virtual bool timeToEndFromTimeOfDay() const;

   virtual bool timeToEndFromScenarioTime() const;

   virtual bool allLinkConditionsMet(bool& allConditionsMet) const;


protected:
   DtRwScenarioEvent myEvent;
   DtString myScenarioEventXmlRep;

   mutable bool myWaitForNextStartDay;
   mutable bool myWaitForNextEndDay;
};