environment.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 1992-2010 MAK Technologies, Inc
** All rights reserved.
******************************************************************************/



#ifndef environment_H_
#define environment_H_

#include "envObject.h"
#include "nativeValue.h"
#include <list>

#include <ostream>

#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif

class DT_DLL_MTL DtEnvironment
{
public:
   DtEnvironment();

   explicit DtEnvironment(const DtString& name);

   explicit DtEnvironment(DtEnvValueSP root);

   virtual ~DtEnvironment();

   void sync();
   void sync(DtEnvValueSP value);

   DtEnvValueSP root() const;

   void setRoot(DtEnvValueSP root);

   void rootToParent();

   DtEnvValueSP getTopParent();

   DtEnvValueSP getTopParent(DtEnvValueSP value);

   void reparent( DtEnvValueSP value, DtEnvValueSP parent );

   DtEnvValueSP addComment(const DtString& comment,DtEnvValueSP parent);
   DtEnvValueSP addComment(const DtString& comment);

   DtEnvValueSP addNativeValue(DtNativeValueSP nativeValue,DtEnvValueSP parent);
   DtEnvValueSP getNativeValue(DtEnvValueSP parent) const;

   DtEnvValueSP addAttribute(const DtString& name,const DtString& value);
   DtEnvValueSP addAttribute(const DtString& name,const DtString& value,DtEnvValueSP parent);

   DtEnvValueSP addNamedList(const DtString& name);
   DtEnvValueSP addNamedList(const DtString& name,DtEnvValueSP parent);

   DtEnvValueSP addObject(const DtString& objectType);  
   DtEnvValueSP addObject(const DtString& objectType,DtEnvValueSP parent);
   DtEnvValueSP addObject(const DtString& objectName,const DtString& objectType);  
   DtEnvValueSP addObject(const DtString& objectName,const DtString& objectType, DtEnvValueSP parent);

   DtEnvValueSP getAttribute(const DtString& name);
   DtEnvValueSP getAttribute(const DtString& name,DtEnvValueSP parent);

   void getNamedListsByName(const DtString& objectName,std::list<DtEnvValueSP>& list);
   void getObjectsByName(const DtString& objectName,std::list<DtEnvValueSP>& list);
   void getObjectsByType(const DtString& objectType,std::list<DtEnvValueSP>& list);

   void getNamedListsByName(const DtString& objectName,std::list<DtEnvValueSP>& list,DtEnvValueSP parent);
   void getObjectsByName(const DtString& objectName,std::list<DtEnvValueSP>& list,DtEnvValueSP parent);
   void getObjectsByType(const DtString& objectType,std::list<DtEnvValueSP>& list,DtEnvValueSP parent);

   DtEnvValueSP getNamedList(const DtString& name) const;
   DtEnvValueSP getNamedList(const DtString& name,DtEnvValueSP root) const;


   DtEnvValueSP getObject(const DtString& name,const DtString& type) const;
   DtEnvValueSP getObject(const DtString& name,const DtString& type,DtEnvValueSP root) const;

   DtEnvObjectSync* getObjectSync(const DtString& name,const DtString& type) const;
   DtEnvObjectSync* getObjectSync(const DtString& name,const DtString& type,DtEnvValueSP root) const;


   DtEnvValueSP copy(DtEnvValueSP original);

   DtEnvValueSP copy(DtEnvValueSP original,DtEnvValueSP parent);

   void remove(DtEnvValueSP  value);

   bool contains(DtEnvValueSP value);

   int level(DtEnvValueSP value);

   void print(std::ostream& output, const DtString& indent ,
              bool printComments = true) const;

   void print(std::ostream& output,DtEnvValueSP root,
              const DtString& indent ,bool printComments = true) const;

protected:

   DtEnvValueSP myRoot;
};

DT_DLL_MTL std::ostream & operator<<(std::ostream &str, const DtEnvironment &env);

#ifdef DtUSE_UTILITIES_NAMESPACE
}
#endif


#endif