objectFilter.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (c) 2012 VT MAK
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <namespace.h>
#include <mtl/configVar.h>
#include <vlpi/entityType.h>

class DtEntityType;

namespace MAKVrExchange
{

   class DT_DLL_BROKER DtObjectFilter
   {
   public:

         enum FilterType
         {
            FilterByEntityName = 0,
            FilterByEntityType = 1,
            FilterByMarkingText = 2
         };

   public:

      DtObjectFilter( FilterType type, DtString filter );

      DtObjectFilter( const DtObjectFilter& filter );

      virtual ~DtObjectFilter();

      virtual DtObjectFilter& operator = ( const DtObjectFilter& filter );

      virtual bool operator == ( const DtObjectFilter& filter ) const;

      inline bool operator != ( const DtObjectFilter& filter ) const
      {
         return !( *this == filter );
      }

      bool operator < ( const DtObjectFilter& filter ) const;

      virtual FilterType type() const;

      virtual DtString string() const;


      static void setObjectValue( DtEnvValueSP obj, const DtString& objectValue );
      static DtString getObjectValue( DtEnvValueSP obj );

      static DtString toString( const DtObjectFilter& filter );
      static DtObjectFilter fromString( const DtString& str );
      static DtEnvValueSP createSchema( DtEnvironment env );
      static void toEnvironment( DtEnvironment env, DtObjectFilter filter );
      static DtObjectFilter fromEnvironment( DtEnvironment env );


   protected:

      FilterType myType;
      DtString myFilter;

   };

}


template <>
struct DT_DLL_BROKER DtVarType<MAKVrExchange::DtObjectFilter>
{
   typedef _NativeTypeToArg<MAKVrExchange::DtObjectFilter>::Type ArgType;

   // Get the native type string.
   static DtString nativeNameOfType();

   // Get the CmdLine ARG type string.
   static DtString argNameOfType();

   // Get the XML schema type string.
   static DtString xsNameOfType();

   // To and from CmdLine Argument types.
   static ArgType convertToArgType( MAKVrExchange::DtObjectFilter value );
   static MAKVrExchange::DtObjectFilter convertFromArgType( ArgType value );

   // To and From String conversions
   static DtString convertToString( MAKVrExchange::DtObjectFilter value );
   static MAKVrExchange::DtObjectFilter convertFromString( const DtString& value );

   // Get Schema Type
   static DtEnvValueSP createSchemaType( DtEnvironment env );

   // To and From Environment Value
   static void convertToEnvironmentValue( DtEnvironment env, MAKVrExchange::DtObjectFilter value );
   static MAKVrExchange::DtObjectFilter convertFromEnvironmentValue( DtEnvironment env );

};