SALOMEDS_Attributes.idl

Go to the documentation of this file.

// Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
//
// Copyright (C) 2003-2007  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, or (at your option) any later version.
//
// 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_Attributes.idl
//  Author : Yves FRICAUD
//  $Header$
//
#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 AttributeString : 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);
  };

  //==========================================================================
  // Presentation attributes (parameters of the object displaying in the Object 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 flags);
    boolean Get(in long flags);
    void    Set(in long flags, in boolean value);
  };

  //==========================================================================
  //==========================================================================
  interface AttributeGraphic : GenericAttribute
  {
    void     SetVisibility(in long viewId, in boolean value);
    boolean  GetVisibility(in long viewId);
  };  

  //==========================================================================
  //==========================================================================
  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 father);
    boolean           HasFather();
    AttributeTreeNode GetFather();
    void              SetPrevious(in AttributeTreeNode sibling);
    boolean           HasPrevious();
    AttributeTreeNode GetPrevious();
    void              SetNext(in AttributeTreeNode sibling);
    boolean           HasNext();
    AttributeTreeNode GetNext();
    void              SetFirst(in AttributeTreeNode child);
    boolean           HasFirst();
    AttributeTreeNode GetFirst();
    void              SetTreeID(in string ID);
    string            GetTreeID();
    void              Append(in AttributeTreeNode child);
    void              Prepend(in AttributeTreeNode child);
    void              InsertBefore(in AttributeTreeNode child);
    void              InsertAfter(in AttributeTreeNode child);
    void              Remove();
    long              Depth();
    boolean           IsRoot();
    boolean           IsDescendant(in AttributeTreeNode other);
    boolean           IsFather(in AttributeTreeNode other);
    boolean           IsChild(in AttributeTreeNode other);
    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 refobj);
    SALOMEDS::Study::ListOfSObject Get();
    void          Remove(in SObject anObject);
  };
  
  //==========================================================================
  //==========================================================================

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

    enum SortOrder { 
      AscendingOrder,  
      DescendingOrder  
    };

    enum SortPolicy {
      EmptyLowest,     
      EmptyHighest,    
      EmptyFirst,      
      EmptyLast,       
      EmptyIgnore      
    };

    void SetTitle(in string title);
    string GetTitle();
    void SetRowTitle(in long row, in string title) raises(IncorrectIndex);
    string GetRowTitle(in long row) raises(IncorrectIndex);
    void SetRowTitles(in StringSeq titles) raises(IncorrectArgumentLength);
    StringSeq GetRowTitles();
    void SetColumnTitle(in long column, in string title) raises(IncorrectIndex);
    string GetColumnTitle(in long column) raises(IncorrectIndex);
    void SetColumnTitles(in StringSeq titles) raises(IncorrectArgumentLength);
    StringSeq GetColumnTitles();
    void SetRowUnit(in long row, in string unit) raises(IncorrectIndex);
    string GetRowUnit(in long row) raises(IncorrectIndex);
    void SetRowUnits(in StringSeq units) raises(IncorrectArgumentLength);
    StringSeq GetRowUnits();
    long GetNbRows();
    long GetNbColumns();
    boolean HasValue(in long row, in long column);
    void RemoveValue(in long row, in long column) raises(IncorrectIndex);
    void SetNbColumns(in long columns);
    LongSeq GetRowSetIndices(in long row) raises(IncorrectIndex);
    LongSeq SortRow(in long row, in SortOrder order, in SortPolicy policy) raises(IncorrectIndex);
    LongSeq SortColumn(in long column, in SortOrder order, in SortPolicy policy) raises(IncorrectIndex);
    LongSeq SortByRow(in long row, in SortOrder order, in SortPolicy policy) raises(IncorrectIndex);
    LongSeq SortByColumn(in long column, in SortOrder order, in SortPolicy policy) raises(IncorrectIndex);
    void SwapCells(in long row1, in long column1, in long row2, in long column2) raises(IncorrectIndex);
    void SwapRows(in long row1, in long row2) raises(IncorrectIndex);
    void SwapColumns(in long column1, in long column2) raises(IncorrectIndex);
    boolean ReadFromFile(in SALOMEDS::TMPFile fileStream);
    SALOMEDS::TMPFile SaveToFile();
  };

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

  interface AttributeTableOfInteger : AttributeTable
  {
    void AddRow(in LongSeq data) raises(IncorrectArgumentLength);
    void SetRow(in long row, in LongSeq data) raises(IncorrectArgumentLength, IncorrectIndex);
    LongSeq GetRow(in long row) raises(IncorrectIndex);
    void AddColumn(in LongSeq data) raises(IncorrectArgumentLength);
    void SetColumn(in long column, in LongSeq data) raises(IncorrectArgumentLength, IncorrectIndex);
    LongSeq GetColumn(in long column) raises(IncorrectIndex);
    void PutValue(in long value, in long row, in long column) raises(IncorrectIndex);
    long GetValue(in long row, in long column) raises(IncorrectIndex);
  };

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

  interface AttributeTableOfReal : AttributeTable
  {
    void AddRow(in DoubleSeq data) raises(IncorrectArgumentLength);
    void SetRow(in long row, in DoubleSeq data) raises(IncorrectArgumentLength, IncorrectIndex);
    DoubleSeq GetRow(in long row) raises(IncorrectIndex);
    void AddColumn(in DoubleSeq data) raises(IncorrectArgumentLength);
    void SetColumn(in long column, in DoubleSeq data) raises(IncorrectArgumentLength, IncorrectIndex);
    DoubleSeq GetColumn(in long column) raises(IncorrectIndex);
    void PutValue(in double value, in long row, in long volumn) raises(IncorrectIndex);
    double GetValue(in long row, in long column) raises(IncorrectIndex);
  };

  //==========================================================================
  //==========================================================================
  interface AttributeTableOfString : AttributeTable
  {
    void AddRow(in StringSeq data) raises(IncorrectArgumentLength);
    void SetRow(in long row, in StringSeq data) raises(IncorrectArgumentLength, IncorrectIndex);
    StringSeq GetRow(in long row) raises(IncorrectIndex);
    void AddColumn(in StringSeq data) raises(IncorrectArgumentLength);
    void SetColumn(in long column, in StringSeq data) raises(IncorrectArgumentLength, IncorrectIndex);
    StringSeq GetColumn(in long column) raises(IncorrectIndex);
    void PutValue(in string value, in long row, in long column) raises(IncorrectIndex);
    string GetValue(in long row, in long column) raises(IncorrectIndex);
  };

  //==========================================================================
  //==========================================================================
  interface AttributeStudyProperties : GenericAttribute
  {
    void SetUserName(in string author);
    string GetUserName();
    void SetCreationDate(in long minute, in long hour, in long day, in long month, in long year);
    boolean GetCreationDate(out long minute, out long hour, out long day, out long month, out long year);
    void SetCreationMode(in string mode);
    string GetCreationMode();
    void SetModified(in long modified);
    boolean IsModified();
    long GetModified();
    void SetLocked(in boolean lock);
    boolean IsLocked();
    void SetModification(in string author, in long minute, in long hour, in long day, in long month, in long year);
    void GetModificationsList(out StringSeq authors, out LongSeq minutes, out LongSeq hours, out LongSeq days, out LongSeq months, out LongSeq years, in boolean withCreator);

    void SetComment(in string comment);

    string GetComment();

    void SetUnits(in string units);

    string GetUnits();

    StringSeq GetStoredComponents();

    string GetComponentVersion( in string comp );

    StringSeq GetComponentVersions( in string comp );
  };

  //==========================================================================
  //==========================================================================
  interface AttributePythonObject : GenericAttribute
  {
    void SetObject(in string pyObject, in boolean isScript);
    string GetObject();
    boolean IsScript();
  };

  //==========================================================================
  //==========================================================================
  interface AttributeParameter : GenericAttribute
  {
    exception InvalidIdentifier {};

    void SetInt(in string ID, in long value);
    long GetInt(in string ID) raises(InvalidIdentifier);
    void SetReal(in string ID, in double value);
    double GetReal(in string ID) raises(InvalidIdentifier);
    void SetString(in string ID, in string value);
    string GetString(in string ID) raises(InvalidIdentifier);
    void SetBool(in string ID, in boolean value);
    boolean GetBool(in string ID) raises(InvalidIdentifier);
    void SetRealArray(in string ID, in DoubleSeq value);
    DoubleSeq GetRealArray(in string ID) raises(InvalidIdentifier);
    void SetIntArray(in string ID, in LongSeq value);
    LongSeq GetIntArray(in string ID) raises(InvalidIdentifier);
    void SetStrArray(in string ID, in StringSeq value);
    StringSeq GetStrArray(in string ID) raises(InvalidIdentifier);
    boolean IsSet(in string ID, in long ptype);
    boolean RemoveID(in string ID, in long ptype);
    AttributeParameter GetFather();
    boolean HasFather();
    boolean IsRoot();
    void Clear();
    StringSeq GetIDs(in long ptype);
  };
};
#endif