conditionalExpression.h

Go to the documentation of this file.

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

#pragma once

#include "vrfutil/simCondExpr.h"
#include "vrfutil/condExprTypes.h"
#include "vrfutil/readerWriter.h"
#include "vrfutil/rwString.h"
#include "vrfutil/rwUUID.h"

namespace vrfAddConditionalExample
{
   //This is the integer type which represents MyConditionalExpression on
   //the network. By starting conditional expression types from 
   //MIN_USER_CONDITIONAL_EXPRESSION_TYPE, defined in condExprTypes.h, conflicts
   //with existing VR-Forces types can be avoided.
   const int DtCondExprFacingNorthType = MIN_USER_CONDITIONAL_EXPRESSION_TYPE + 1;

   //This is the string type which represents MyConditionalExpression in
   //plan files. It must not contain any spaces.
   const char DtCeFacingNorthTypeName[] = "FacingNorth";

   class MyConditionalExpression : public DtSimCondExpr
   {
   public:

      //default constructor
   MyConditionalExpression();

      //real constructor
   MyConditionalExpression(DtReaderWriterRegistry* parentRegistry);

      //copy constructor
   MyConditionalExpression(const MyConditionalExpression& orig,
      DtReaderWriterRegistry* parentRegistry = NULL);

      //destructor
   virtual ~MyConditionalExpression();

      //assignment operator
   MyConditionalExpression& operator=(const MyConditionalExpression& orig);

      //clone operator
   virtual DtSimCondExpr* clone(DtReaderWriterRegistry* parentRegistry = NULL) const;

      //Returns DtNetCeFacingNorthType (defined above).
   virtual int type() const;

      //Set the entity
   virtual void setEntity(const DtUUID& name);
      //Returns the entity
   virtual const DtUUID& entity() const;

      //Set the test modifier.
      //  If it is an empty string, checks only the specified entity. 
      //  If it is the string "ANY", checks all subordinate entities to see if 
      //  any of them match the test,
      //  If it is neither of the above, it requires that all specified entities 
      //  match.
   virtual void setModifier(const DtString& arg);
      //Returns the modifier
   virtual const DtString& modifier() const;

      //Get a readable string representation of this level of this expression.
      //
      //The subExprIndex argument indicates which stringRep to get if this
      //expression can have sub-expressions.  Since the facing north test has
      //no sub-expressions, it only returns a string representation if passed an
      //index of DtSimCondExpr::DtSR_EXPR.
      //
      //See the documentation for DtSimCondExpr::stringRep for more
      //information.
   virtual DtString stringRep(int subExprIndex = DtSR_EXPR) const;

      //returns the size of the full network representation 
      //padded to an 8-byte boundary.
   virtual int netRepSize() const;

      //Fills in the expression from the network buffer
   virtual bool setFromNet(const char* contentBuffer, 
      unsigned contentSize);

      //Fills in the network buffer (created by base class conditional 
      //expression) with the conditional expression contents.
   virtual bool setToNet();

      //Returns a new MyConditionalExpression
   static DtSimCondExpr * creator();

   protected:
      //The name of the entity to evaluate
   DtRwUUID myEntity;

      //The modifier (set via the "Any" checkbox in the GUI)
   DtRwString myModifier;
   };

}