Back to index

salome-kernel  6.5.0
Classes | Typedefs | Functions
SALOMEDS Namespace Reference

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

Classes

interface  Observer
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
 Represents 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 allowing to store a sequence of real values. More...
interface  AttributeSequenceOfInteger
 Attribute allowing to store a sequence of integer values. 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
 External 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. More...
interface  AttributeOpened
 Opened flag Attribute. More...
interface  AttributeTextColor
 Text color attribute. More...
interface  AttributeTextHighlightColor
 Text highlight color attribute. More...
interface  AttributePixMap
 Icon attribute. More...
interface  AttributeTreeNode
 Tree node attribute. More...
interface  AttributeLocalID
 Local identifier attribute. More...
interface  AttributeUserID
 Attribute storing GUID. More...
interface  AttributeTarget
 Back references attribute. More...
interface  AttributeTable
 Generic table attribute. More...
interface  AttributeTableOfInteger
 Table of integer values. More...
interface  AttributeTableOfReal
 Table of real values. More...
interface  AttributeTableOfString
 Table of string values. More...
interface  AttributeStudyProperties
 Study properties attribute More...
interface  AttributePythonObject
 Python object attribute. More...
interface  AttributeParameter
 Parameter attribute. More...
protocol  SALOMEDS_EXPORT

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.

Functions

void lock ()
void unlock ()
PortableServer::ServantBase_var GetServant (CORBA::Object_ptr theObject, PortableServer::POA_ptr thePOA)

Detailed Description

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


Class Documentation

exception SALOMEDS::NotImplemented

Exception indicating that this feature hasn't been implemented in SALOME application.

Definition at line 106 of file SALOMEDS.idl.

struct SALOMEDS::Color

Represents the color based on RGB palette.

Used by different interfaces to specify the color attributes of different items.

Definition at line 50 of file SALOMEDS_Attributes.idl.

Class Members
double B Blue component of the color.
double G Green component of the color.
double R Red component of the color.

Typedef Documentation

typedef sequence<double> SALOMEDS::DoubleSeq

Sequence of double values.

Definition at line 39 of file SALOMEDS_Attributes.idl.

typedef string SALOMEDS::ID

Main identifier of an object in SALOME application.

Definition at line 48 of file SALOMEDS.idl.

List of attributes of SObjects.

Definition at line 99 of file SALOMEDS.idl.

typedef sequence<string> SALOMEDS::ListOfDates

List of modification dates of a study.

Definition at line 67 of file SALOMEDS.idl.

typedef sequence<string> SALOMEDS::ListOfFileNames

List of file names.

Definition at line 65 of file SALOMEDS.idl.

An unbounded sequence of sequence of strings.

Definition at line 71 of file SALOMEDS.idl.

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.

Definition at line 63 of file SALOMEDS.idl.

typedef sequence<string> SALOMEDS::ListOfStrings

An unbounded sequence of strings.

Definition at line 69 of file SALOMEDS.idl.

typedef sequence<long> SALOMEDS::LongSeq

Sequence of long values.

Definition at line 41 of file SALOMEDS_Attributes.idl.

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

Definition at line 52 of file SALOMEDS.idl.

typedef string SALOMEDS::SalomeReference

IOR of the study in SALOME application.

Definition at line 56 of file SALOMEDS.idl.

typedef sequence<string> SALOMEDS::StringSeq

Sequence of string values.

Definition at line 43 of file SALOMEDS_Attributes.idl.

typedef sequence<octet> SALOMEDS::TMPFile

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

Definition at line 73 of file SALOMEDS.idl.

typedef string SALOMEDS::URL

Name of the file in which the Study is saved.

Definition at line 44 of file SALOMEDS.idl.


Function Documentation

PortableServer::ServantBase_var SALOMEDS::GetServant ( CORBA::Object_ptr  theObject,
PortableServer::POA_ptr  thePOA 
)

Definition at line 499 of file SALOMEDS_StudyManager_i.cxx.

  {
    if(CORBA::is_nil(theObject))
      return NULL;
    try{
      return thePOA->reference_to_servant(theObject);
    }catch(...){
      return NULL;
    }
  }
void SALOMEDS::lock ( )

Definition at line 58 of file SALOMEDS.cxx.

{
  Locker::MutexDS.lock();
}
void SALOMEDS::unlock ( )

Definition at line 63 of file SALOMEDS.cxx.

{
       SALOMEDS::Locker::MutexDS.unlock();
}

Here is the caller graph for this function: