Back to index

salome-kernel  6.5.0
SALOMEDSClient_StudyBuilder.hxx
Go to the documentation of this file.
00001 // Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
00002 //
00003 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
00004 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
00005 //
00006 // This library is free software; you can redistribute it and/or
00007 // modify it under the terms of the GNU Lesser General Public
00008 // License as published by the Free Software Foundation; either
00009 // version 2.1 of the License.
00010 //
00011 // This library is distributed in the hope that it will be useful,
00012 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00013 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014 // Lesser General Public License for more details.
00015 //
00016 // You should have received a copy of the GNU Lesser General Public
00017 // License along with this library; if not, write to the Free Software
00018 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
00019 //
00020 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
00021 //
00022 
00023 //  File   : SALOMEDSClient_StudyBuilder.hxx
00024 //  Author : Sergey RUIN
00025 //  Module : SALOME
00026 //
00027 #ifndef __SALOMEDSClient_STUDYBUILDER_H__
00028 #define __SALOMEDSClient_STUDYBUILDER_H__
00029 
00030 #include "SALOMEDSClient_definitions.hxx"
00031 #include "SALOMEDSClient_SObject.hxx"
00032 #include "SALOMEDSClient_SComponent.hxx"
00033 #include "SALOMEDSClient_GenericAttribute.hxx"
00034 #include <string> 
00035 
00036 class SALOMEDSClient_StudyBuilder
00037 {
00038 public:
00039   virtual ~SALOMEDSClient_StudyBuilder() {}
00040 
00041   virtual _PTR(SComponent) NewComponent(const std::string& ComponentDataType) = 0;
00042   virtual void DefineComponentInstance (const _PTR(SComponent)&, const std::string& ComponentIOR) = 0;
00043   virtual void RemoveComponent(const _PTR(SComponent)& theSCO) = 0;
00044   virtual _PTR(SObject) NewObject(const _PTR(SObject)& theFatherObject) = 0;
00045   virtual _PTR(SObject) NewObjectToTag(const _PTR(SObject)& theFatherObject, int theTag) = 0;
00046   virtual void AddDirectory(const std::string& thePath) = 0;
00047   virtual void LoadWith(const _PTR(SComponent)& theSCO, const std::string& theIOR) = 0;
00048   virtual void Load(const _PTR(SObject)& theSCO) = 0;
00049   virtual void RemoveObject(const _PTR(SObject)& theSO) = 0;
00050   virtual void RemoveObjectWithChildren(const _PTR(SObject)& theSO) = 0;
00051   virtual _PTR(GenericAttribute) FindOrCreateAttribute(const _PTR(SObject)& theSO, const std::string& aTypeOfAttribute) = 0;
00052   virtual bool FindAttribute(const _PTR(SObject)& theSO, 
00053                              _PTR(GenericAttribute)& theAttribute, 
00054                              const std::string& aTypeOfAttribute) = 0;
00055   virtual void RemoveAttribute(const _PTR(SObject)& theSO, const std::string& aTypeOfAttribute) = 0;
00056   virtual void Addreference(const _PTR(SObject)& me, const _PTR(SObject)& thereferencedObject) = 0;
00057   virtual void RemoveReference(const _PTR(SObject)& me) = 0;
00058   virtual void SetGUID(const _PTR(SObject)& theSO, const std::string& theGUID) = 0;
00059   virtual bool IsGUID(const _PTR(SObject)& theSO, const std::string& theGUID) = 0;
00060   virtual void NewCommand() = 0;
00061   virtual void CommitCommand()= 0;
00062   virtual bool HasOpenCommand() = 0;
00063   virtual void AbortCommand() = 0;
00064   virtual void Undo() = 0;
00065   virtual void Redo() = 0;
00066   virtual bool GetAvailableUndos() = 0;
00067   virtual bool GetAvailableRedos() = 0;
00068   virtual int UndoLimit() = 0;
00069   virtual void UndoLimit(int theLimit) = 0;
00070   virtual void SetName(const _PTR(SObject)& theSO, const std::string& theValue) = 0;
00071   virtual void SetComment(const _PTR(SObject)& theSO, const std::string& theValue) = 0;
00072   virtual void SetIOR(const _PTR(SObject)& theSO, const std::string& theValue) = 0;
00073 };
00074 
00075 #endif