General KERNEL Documentation

End User KERNEL Services

---

idl/SALOMEDS_Attributes.idl

Go to the documentation of this file.

//  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
// 
//  This library is free software; you can redistribute it and/or 
//  modify it under the terms of the GNU Lesser General Public 
//  License as published by the Free Software Foundation; either 
//  version 2.1 of the License. 
// 
//  This library is distributed in the hope that it will be useful, 
//  but WITHOUT ANY WARRANTY; without even the implied warranty of 
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
//  Lesser General Public License for more details. 
// 
//  You should have received a copy of the GNU Lesser General Public 
//  License along with this library; if not, write to the Free Software 
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
// 
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
//
//
//  File   : SALOMEDS.idl
//  Author : Yves FRICAUD
//  $Header: /home/server/cvs/KERNEL/KERNEL_SRC/idl/SALOMEDS_Attributes.idl,v 1.8.2.1 2006/09/07 07:08:55 mkr Exp $

#ifndef _SALOMEDS_AttributesIDL_
#define _SALOMEDS_AttributesIDL_

#include "SALOMEDS.idl"

module SALOMEDS
{
  typedef sequence <double> DoubleSeq;
  typedef sequence <long>   LongSeq;
  typedef sequence <string> StringSeq;
  struct Color {
   double R;
   double G;
   double B;
  };
  //==========================================================================
 //==========================================================================

  interface AttributeReal : GenericAttribute
  {
    double Value();
    void   SetValue(in double value);

  };
  //==========================================================================
  //==========================================================================
  interface AttributeInteger : GenericAttribute
  {
    long   Value();
    void   SetValue(in long value);
  };
  //==========================================================================
  //==========================================================================
  interface AttributeSequenceOfReal : GenericAttribute
  {
    void      Assign (in DoubleSeq other);
    DoubleSeq CorbaSequence();
    void      Add (in double value);
    void      Remove(in long index);
    void      ChangeValue(in long index, in double value);
    double    Value(in short index);
    long      Length();
  };
  //==========================================================================
  //==========================================================================
  interface AttributeSequenceOfInteger : GenericAttribute
  {
    void      Assign (in LongSeq other);
    LongSeq CorbaSequence();
    void      Add (in long value);
    void      Remove(in long index);
    void      ChangeValue(in long index, in long value);
    long      Value(in short index);
    long      Length();
  };

  //==========================================================================
  //==========================================================================

  interface AttributeName : GenericAttribute
  {
    string Value();
    void   SetValue(in string value);
  };

  //==========================================================================
  //==========================================================================
  interface AttributeComment : GenericAttribute
  {
    string Value();
    void   SetValue(in string value);
  };
  //==========================================================================
 //==========================================================================
  interface AttributeIOR : GenericAttribute
  {
    string Value();
    void   SetValue(in string value);
  };

  //==========================================================================
  //==========================================================================
  interface AttributePersistentRef : GenericAttribute
  {
    string Value();
    void   SetValue(in string value);
  };

  //==========================================================================
  //==========================================================================
  interface AttributeExternalFileDef: GenericAttribute
  {
    string Value();
    void   SetValue(in string value);
  };

  //==========================================================================
  //==========================================================================
  interface AttributeFileType: GenericAttribute
  {
    string Value();
    void   SetValue(in string value);
  };

  //==========================================================================
  //Below the list of presentation attributes for display study tree in browser
  //==========================================================================


  //==========================================================================
  //==========================================================================
  interface AttributeDrawable : GenericAttribute
  {
    boolean IsDrawable();
    void   SetDrawable(in boolean value);
  };

  //==========================================================================
  //==========================================================================
  interface AttributeSelectable : GenericAttribute
  {
    boolean IsSelectable();
    void   SetSelectable(in boolean value);
  };

  //==========================================================================
  //==========================================================================
  interface AttributeExpandable : GenericAttribute
  {
    boolean IsExpandable();
    void   SetExpandable(in boolean value);
  };

  //==========================================================================
  //==========================================================================

  interface AttributeFlags : GenericAttribute
  {
    long    GetFlags();
    void    SetFlags( in long theFlags );

    boolean Get( in long theFlag );
    void    Set( in long theFlag, in boolean theValue );
  };

  //==========================================================================
  //==========================================================================

  interface AttributeGraphic : GenericAttribute
  {
    void     SetVisibility( in long theViewId, in boolean theValue );
    boolean  GetVisibility( in long theViewId );
  };  

  //==========================================================================
  //==========================================================================
  interface AttributeOpened : GenericAttribute
  {
    boolean IsOpened();
    void   SetOpened(in boolean value);
  };
  //==========================================================================
  //==========================================================================
  interface AttributeTextColor : GenericAttribute
  {
    Color TextColor();
    void   SetTextColor(in Color value);
  };

  //==========================================================================
  //==========================================================================
  interface AttributeTextHighlightColor : GenericAttribute
  {
    Color TextHighlightColor();
    void   SetTextHighlightColor(in Color value);
  };
  //==========================================================================
  //==========================================================================
  interface AttributePixMap : GenericAttribute
  {
    boolean HasPixMap();
    string  GetPixMap();
    void    SetPixMap(in string value);
  };

  //==========================================================================
  //==========================================================================
  interface AttributeTreeNode : GenericAttribute
  {
    void              SetFather(in AttributeTreeNode value);
    boolean           HasFather();
    AttributeTreeNode GetFather();
    void              SetPrevious(in AttributeTreeNode value);
    boolean           HasPrevious();
    AttributeTreeNode GetPrevious();
    void              SetNext(in AttributeTreeNode value);
    boolean           HasNext();
    AttributeTreeNode GetNext();
    void              SetFirst(in AttributeTreeNode value);
    boolean           HasFirst();
    AttributeTreeNode GetFirst();
    void              SetTreeID(in string value);
    string            GetTreeID();

    void              Append(in AttributeTreeNode value);
    void              Prepend(in AttributeTreeNode value);
    void              InsertBefore(in AttributeTreeNode value);
    void              InsertAfter(in AttributeTreeNode value);
    void              Remove();

    long              Depth();
    boolean           IsRoot();
    boolean           IsDescendant(in AttributeTreeNode value);
    boolean           IsFather(in AttributeTreeNode value);
    boolean           IsChild(in AttributeTreeNode value);
    string            Label();
  };
  //==========================================================================
  //==========================================================================
  interface AttributeLocalID : GenericAttribute
  {
    long   Value();
    void   SetValue(in long value);
  };

  //==========================================================================
  //==========================================================================
  interface AttributeUserID : GenericAttribute
  {
    string Value();
    void   SetValue(in string value);
  };

  //==========================================================================
  //==========================================================================

  interface AttributeTarget : GenericAttribute
  {
    void          Add(in SObject anObject);
    SALOMEDS::Study::ListOfSObject Get();
    void          Remove(in SObject anObject);
  };
  //==========================================================================
  //==========================================================================

  interface AttributeTableOfInteger : GenericAttribute
  {
    exception IncorrectIndex {};
    exception IncorrectArgumentLength {};

    // titles: for table, for each row, for each column
    void SetTitle(in string theTitle);
    string GetTitle();
    void SetRowTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
    void SetRowTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
    StringSeq GetRowTitles();
    void SetColumnTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
    void SetColumnTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
    StringSeq GetColumnTitles();

    //Rows units
    void SetRowUnit(in long theIndex, in string theUnit) raises(IncorrectIndex);
    void SetRowUnits(in StringSeq theUnits) raises(IncorrectArgumentLength);
    StringSeq GetRowUnits();

    // table information
    long GetNbRows();
    long GetNbColumns();

    // operations with rows
    void AddRow(in LongSeq theData) raises(IncorrectArgumentLength);
    void SetRow(in long theRow, in LongSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
    LongSeq GetRow(in long theRow) raises(IncorrectIndex);

    // operations with columns
    void AddColumn(in LongSeq theData) raises(IncorrectArgumentLength);
    void SetColumn(in long theColumn, in LongSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
    LongSeq GetColumn(in long theColumn) raises(IncorrectIndex);

    // operations with elements
    void PutValue(in long theValue, in long theRow, in long theColumn) raises(IncorrectIndex);
    boolean HasValue(in long theRow, in long theColumn);
    long GetValue(in long theRow, in long theColumn) raises(IncorrectIndex);

    void SetNbColumns(in long theNbColumns);

    LongSeq GetRowSetIndices(in long theRow) raises(IncorrectIndex);
    // operations with files
    boolean ReadFromFile(in SALOMEDS::TMPFile theStream);
    SALOMEDS::TMPFile SaveToFile();
  };

  //==========================================================================
  //==========================================================================

  interface AttributeTableOfReal : GenericAttribute
  {
    exception IncorrectIndex {};
    exception IncorrectArgumentLength {};

    // titles: for table, for each row, for each column
    void SetTitle(in string theTitle);
    string GetTitle();
    void SetRowTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
    void SetRowTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
    StringSeq GetRowTitles();
    void SetColumnTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
    void SetColumnTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
    StringSeq GetColumnTitles();

    //Rows units
    void SetRowUnit(in long theIndex, in string theUnit) raises(IncorrectIndex);
    void SetRowUnits(in StringSeq theUnits) raises(IncorrectArgumentLength);
    StringSeq GetRowUnits();

    // table information
    long GetNbRows();
    long GetNbColumns();

    // operations with rows
    void AddRow(in DoubleSeq theData) raises(IncorrectArgumentLength);
    void SetRow(in long theRow, in DoubleSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
    DoubleSeq GetRow(in long theRow) raises(IncorrectIndex);

    // operations with columns
    void AddColumn(in DoubleSeq theData) raises(IncorrectArgumentLength);
    void SetColumn(in long theColumn, in DoubleSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
    DoubleSeq GetColumn(in long theColumn) raises(IncorrectIndex);

    // operations with elements
    void PutValue(in double theValue, in long theRow, in long theColumn) raises(IncorrectIndex);
    boolean HasValue(in long theRow, in long theColumn);
    double GetValue(in long theRow, in long theColumn) raises(IncorrectIndex);

    void SetNbColumns(in long theNbColumns);

    LongSeq GetRowSetIndices(in long theRow) raises(IncorrectIndex);
    // operations with files
    boolean ReadFromFile(in SALOMEDS::TMPFile theStream);
    SALOMEDS::TMPFile SaveToFile();
  };



  //==========================================================================
  //==========================================================================

  interface AttributeTableOfString : GenericAttribute
  {
    exception IncorrectIndex {};
    exception IncorrectArgumentLength {};

    // titles: for table, for each row, for each column
    void SetTitle(in string theTitle);
    string GetTitle();
    void SetRowTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
    void SetRowTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
    StringSeq GetRowTitles();
    void SetColumnTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
    void SetColumnTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
    StringSeq GetColumnTitles();

    //Rows units
    void SetRowUnit(in long theIndex, in string theUnit) raises(IncorrectIndex);
    void SetRowUnits(in StringSeq theUnits) raises(IncorrectArgumentLength);
    StringSeq GetRowUnits();

    // table information
    long GetNbRows();
    long GetNbColumns();

    // operations with rows
    void AddRow(in StringSeq theData) raises(IncorrectArgumentLength);
    void SetRow(in long theRow, in StringSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
    StringSeq GetRow(in long theRow) raises(IncorrectIndex);

    // operations with columns
    void AddColumn(in StringSeq theData) raises(IncorrectArgumentLength);
    void SetColumn(in long theColumn, in StringSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
    StringSeq GetColumn(in long theColumn) raises(IncorrectIndex);

    // operations with elements
    void PutValue(in string theValue, in long theRow, in long theColumn) raises(IncorrectIndex);
    boolean HasValue(in long theRow, in long theColumn);
    string GetValue(in long theRow, in long theColumn) raises(IncorrectIndex);

    void SetNbColumns(in long theNbColumns);

    LongSeq GetRowSetIndices(in long theRow) raises(IncorrectIndex);
    // operations with files
    boolean ReadFromFile(in SALOMEDS::TMPFile theStream);
    SALOMEDS::TMPFile SaveToFile();
  };


  //==========================================================================
  //==========================================================================

  interface AttributeStudyProperties : GenericAttribute
  {
    void SetUserName(in string theName);
    string GetUserName();
    void SetCreationDate(in long theMinute, in long theHour, in long theDay, in long theMonth, in long theYear);
    boolean GetCreationDate(out long theMinute, out long theHour, out long theDay, out long theMonth, out long theYear);
    void SetCreationMode(in string theMode);
    string GetCreationMode();
    void SetModified(in long theModified);
    boolean IsModified();
    long GetModified();
    void SetLocked(in boolean theLocked);
    boolean IsLocked();
    void SetModification(in string theName, in long theMinute, in long theHour, in long theDay, in long theMonth, in long theYear);
    void GetModificationsList(out StringSeq theNames, out LongSeq theMinutes, out LongSeq theHours, out LongSeq theDays, out LongSeq theMonths, out LongSeq theYears, in boolean theWithCreator);
  };
  //==========================================================================
  //==========================================================================

  interface AttributePythonObject : GenericAttribute
  {
    void SetObject(in string theSequence, in boolean IsScript);
    string GetObject();
    boolean IsScript();
  };
  //==========================================================================
  //==========================================================================
  interface AttributeParameter : GenericAttribute
  {
    void SetInt(in string theID, in long theValue);
    long GetInt(in string theID);

    void SetReal(in string theID, in double theValue);
    double GetReal(in string theID);

    void SetString(in string theID, in string theValue);
    string GetString(in string theID);
  
    void SetBool(in string theID, in boolean theValue);
    boolean GetBool(in string theID);
  
    void SetRealArray(in string theID, in DoubleSeq theArray);
    DoubleSeq GetRealArray(in string theID);

    void SetIntArray(in string theID, in LongSeq theArray);
    LongSeq GetIntArray(in string theID);

    void SetStrArray(in string theID, in StringSeq theArray);
    StringSeq GetStrArray(in string theID);
    boolean IsSet(in string theID, in long theType);
    boolean RemoveID(in string theID, in long theType);
    AttributeParameter GetFather();
    boolean HasFather();
    boolean IsRoot();
    void Clear();
    StringSeq GetIDs(in long theType);
  };
};
#endif

---

General KERNEL Documentation

End User KERNEL Services

Generated on Mon Sep 18 14:18:45 2006 for SALOME v.3.2.2 by  1.4.6