SALOME documentation central

SALOMEDS Namespace Reference

This package contains the interfaces used for creation, management and modification of the Study. More...

Data Structures

exception  NotImplemented
 Exception indicating that this feature hasn't been implemented in SALOME application. More...
interface  Study
 Study Interface More...
interface  StudyBuilder
 Study Builder Interface More...
interface  StudyManager
 Study Manager interface More...
interface  SObject
 SObject interface More...
interface  GenericAttribute
 Generic attribute interface More...
interface  SComponent
 SComponent interface More...
interface  SComponentIterator
 SComponentIterator interface More...
interface  ChildIterator
 ChildIterator interface More...
interface  UseCaseIterator
 Interface of the UseCaseIterator. More...
interface  UseCaseBuilder
 Interface of the UseCaseBuilder. More...
interface  Driver
 Driver interface More...
struct  Color
 This structure stores a set of elements defining the color based on RGB palette. More...
interface  AttributeReal
 Attribute allowing to store a real value. More...
interface  AttributeInteger
 Attribute allowing to store an integer value. More...
interface  AttributeSequenceOfReal
 Attribute - sequence of real values. More...
interface  AttributeSequenceOfInteger
 Attribute - sequence of integer. More...
interface  AttributeName
 Name attribute. More...
interface  AttributeComment
 Comment attribute. More...
interface  AttributeString
 String attribute. More...
interface  AttributeIOR
 IOR attribute. More...
interface  AttributePersistentRef
 Persistent reference attribute. More...
interface  AttributeExternalFileDef
 External File definition. More...
interface  AttributeFileType
 File Type definition. More...
interface  AttributeDrawable
 Drawable flag Attribute. More...
interface  AttributeSelectable
 Selectable flag Attribute. More...
interface  AttributeExpandable
 Expandable flag Attribute. More...
interface  AttributeFlags
 Flags Attribute. More...
interface  AttributeGraphic
 Graphic Attribute. This class is intended for storing information about graphic representation of objects in dirrent views. More...
interface  AttributeOpened
 Opened flag Attribute. More...
interface  AttributeTextColor
 TextColorAttribute. More...
interface  AttributeTextHighlightColor
 TextHighlightColorAttribute. More...
interface  AttributePixMap
 PixMapAttribute. More...
interface  AttributeTreeNode
 TreeNodeAttribute. More...
interface  AttributeLocalID
 LocalID attribute. More...
interface  AttributeUserID
 Attribute storing GUID. More...
interface  AttributeTarget
 AttributeTarget iterface More...
interface  AttributeTableOfInteger
 AttributeTableOfInteger interface More...
interface  AttributeTableOfReal
 AttributeTableOfReal interface More...
interface  AttributeTableOfString
 AttributeTableOfString interface More...
interface  AttributeStudyProperties
 AttributeStudyProperties interface More...
interface  AttributePythonObject
 AttributePythonObject interface More...
interface  AttributeParameter
 AttributeParameter interface More...

Typedefs

typedef string URL
 Name of the file in which the Study is saved.
typedef string ID
 Main identifier of an object in SALOME application.
typedef string PersistentReference
 While saving the data, IOR is transformed into persistent reference.
typedef string SalomeReference
 IOR of the study in SALOME application.
typedef sequence< string > ListOfOpenStudies
 List of the names of studies which are currently open in this SALOME session.
typedef sequence< string > ListOfFileNames
 List of file names.
typedef sequence< string > ListOfDates
 List of modification dates of a study.
typedef sequence< string > ListOfStrings
 An unbounded sequence of strings.
typedef sequence< ListOfStringsListOfListOfStrings
 An unbounded sequence of sequence of strings.
typedef sequence< octet > TMPFile
 A byte stream which is used for binary data transfer between different components.
typedef sequence
< GenericAttribute
ListOfAttributes
 List of attributes of SObjects.
typedef sequence< double > DoubleSeq
 Sequence of double values.
typedef sequence< long > LongSeq
 Sequence of long values.
typedef sequence< string > StringSeq
 Sequence of string values.

Detailed Description

This package contains the interfaces used for creation, management and modification of the Study.


Typedef Documentation

typedef string SALOMEDS::URL

Name of the file in which the Study is saved.

typedef string SALOMEDS::ID

Main identifier of an object in SALOME application.

While saving the data, IOR is transformed into persistent reference.

typedef string SALOMEDS::SalomeReference

IOR of the study in SALOME application.

typedef sequence<string> SALOMEDS::ListOfOpenStudies

List of the names of studies which are currently open in this SALOME session.

Since SALOME is a multi-study application, it allows to open a lot of studies during each working session.

typedef sequence<string> SALOMEDS::ListOfFileNames

List of file names.

typedef sequence<string> SALOMEDS::ListOfDates

List of modification dates of a study.

typedef sequence<string> SALOMEDS::ListOfStrings

An unbounded sequence of strings.

An unbounded sequence of sequence of strings.

typedef sequence<octet> SALOMEDS::TMPFile

A byte stream which is used for binary data transfer between different components.

List of attributes of SObjects.

typedef sequence<double> SALOMEDS::DoubleSeq

Sequence of double values.

typedef sequence<long> SALOMEDS::LongSeq

Sequence of long values.

typedef sequence<string> SALOMEDS::StringSeq

Sequence of string values.


Copyright © 2007-2008 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS