30 #ifndef _SALOMEDS_IDL_
31 #define _SALOMEDS_IDL_
217 in
string aTypeOfAttribute);
235 in
SObject theReferencedObject) ;
282 boolean HasOpenCommand();
294 attribute
long UndoLimit;
321 boolean GetAvailableUndos();
328 boolean GetAvailableRedos();
513 attribute
boolean IsSaved;
526 attribute wstring URL;
550 string ConvertObjectToIOR(in Object theObject);
556 Object ConvertIORToObject(in
string theIOR);
602 in
boolean theMultiFile,
643 in
string theBaseName,
644 in
boolean isPublished,
649 string GetDumpPath();
680 long long GetLocalImpl(in
string theHostname, in
long thePID,
out boolean isLocal);
925 in
string aTypeOfAttribute);
1007 string GetClassType();
1018 long long GetLocalImpl(in
string theHostname, in
long thePID,
out boolean isLocal);
1325 in
string IORString,
1326 in
boolean isMultiFile,
1327 in
boolean isASCII);
1344 in
string aLocalPersistentID,
1345 in
boolean isMultiFile,
1384 boolean CanPaste(in
string theComponentName, in
long theObjectID);
static std::ostream * out
Definition: DSC_interface.cxx:381
static void DumpStudy()
Function : Purpose :
Definition: SALOMEDS_Client.cxx:72
This file contains the objects defining the main exception used in SALOME application.
interface for common behavior of SALOME transient CORBA objects
Definition: SALOMEDSImpl_Attributes.hxx:34
Definition: Utils_SALOME_Exception.hxx:66
Exception locking all changes.
Definition: SALOMEDS.idl:994
Exception indicating that this feature hasn't been implemented in SALOME application.
Definition: SALOMEDS.idl:99
LockProtection Exception
Definition: SALOMEDS.idl:120
Invalid study component.
Definition: SALOMEDS.idl:376
Invalid directory of the study exception.
Definition: SALOMEDS.idl:378
Invalid study reference.
Definition: SALOMEDS.idl:374
Exception pointing that this name of the study has already been used.
Definition: SALOMEDS.idl:380
Invalid name of the study exception.
Definition: SALOMEDS.idl:384
study object already exists
Definition: SALOMEDS.idl:382
The main exception in SALOME application.
Definition: SALOME_Exception.idl:71
Parameter attribute.
Definition: SALOMEDS_Attributes.idl:1717
Study properties attribute
Definition: SALOMEDS_Attributes.idl:1535
ChildIterator interface
Definition: SALOMEDS.idl:1086
void Init()
Activates the ChildIterator.
void InitEx(in boolean allLevels)
Activates the ChildIterator for all child levels.
void Next()
Passes the iterator to the next level.
SObject Value()
Returns the SObject corresponding to the current object found by the iterator.
boolean More()
Method More.
Driver interface
Definition: SALOMEDS.idl:1241
string IORToLocalPersistentID(in SObject theSObject, in string IORString, in boolean isMultiFile, in boolean isASCII)
Transforms IOR of a given SObject into PersistentID.
boolean Load(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile)
Loading the data.
void Close(in SComponent aSComponent)
Closing of the study.
string LocalPersistentIDToIOR(in SObject theSObject, in string aLocalPersistentID, in boolean isMultiFile, in boolean isASCII)
Transforms PersistentID into IOR of the object.
TMPFile SaveASCII(in SComponent theComponent, in string theURL, in boolean isMultiFile)
Saving the data in ASCII format produced by a definite component.
TMPFile CopyFrom(in SObject theObject, out long theObjectID)
Returns the object ID and the TMPFile of the object from the given SObject.
boolean CanPublishInStudy(in Object theIOR)
Publishing in the study.
boolean CanPaste(in string theComponentName, in long theObjectID)
Returns True, if the component can paste the object with given ID of the component with name theCompo...
TMPFile Save(in SComponent theComponent, in string theURL, in boolean isMultiFile)
Saving the data produced by a definite component.
boolean LoadASCII(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile)
Loading the data from files in ASCII format.
SObject PublishInStudy(in SObject theSObject, in Object theObject, in string theName)
Publishing in the study.
string ComponentDataType()
Gets the type of the data.
boolean CanCopy(in SObject theObject)
Returns True, if the given SObject can be copied to the clipboard.
SObject PasteInto(in TMPFile theStream, in long theObjectID, in SObject theObject)
Returns the SObject of the pasted object.
Generic attribute interface
Definition: SALOMEDS.idl:989
void CheckLocked()
Method CheckLocked.
Definition: SALOMEDS.idl:90
oneway void notifyObserverID(in string theID, in long event)
SComponentIterator interface
Definition: SALOMEDS.idl:1055
void Next()
Moves the iterator to the next SComponent in the list.
boolean More()
Method More.
void Init()
Activates the SComponentIterator.
SComponent interface
Definition: SALOMEDS.idl:1032
string ComponentDataType()
Gets the data type of the given SComponent.
boolean ComponentIOR(out ID theID)
Gets the IOR of the given component.
SObject interface
Definition: SALOMEDS.idl:873
SObject GetFather()
Acquisition of the father SObject of the SObject.
Object GetObject()
Gets the CORBA object by its own IOR attribute.
string GetName()
Returns the name attribute value of this SObject.
boolean FindSubObject(in long atag, out SObject obj)
Looks for subobjects of a given SObject.
boolean FindAttribute(out GenericAttribute anAttribute, in string aTypeOfAttribute)
Looks for attributes of a given SObject.
ID GetID()
Gets an object ID.
string GetComment()
Returns the comment attribute value of this SObject.
attribute string Name
Name of the SObject.
Definition: SALOMEDS.idl:876
short Tag()
Gets the tag of a SObject.
SComponent GetFatherComponent()
Acquisition of the father Component of the SObject.
short Depth()
Gets the depth of a SObject.
string GetIOR()
Returns the IOR attribute value of this SObject.
boolean IsNull()
Returns true if the SObject does not belong to any Study.
long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal)
Private method, returns an implementation of this SObject.
ListOfAttributes GetAllAttributes()
Gets all attributes of a given SObject.
boolean ReferencedObject(out SObject obj)
Looks for a SObject which the given SObject refers to.
short GetLastChildTag()
Returns a tag of the last child SObject (if any) of this SObject.
void SetAttrString(in string name, in string value)
Set an attribute value (of type string)
Study Builder Interface
Definition: SALOMEDS.idl:115
void NewCommand()
Creation of a new command.
void RemoveComponent(in SComponent aComponent)
Deletion of a SComponent.
void RemoveReference(in SObject anObject)
Removes a reference from anObject to another object.
GenericAttribute FindOrCreateAttribute(in SObject anObject, in string aTypeOfAttribute)
Looking for or creating an attribute assigned to the SObject.
void CommitCommand()
Execution of the command.
void DefineComponentInstance(in SComponent aComponent, in Object ComponentIOR)
Definition of the instance to the SComponent.
void RemoveObjectWithChildren(in SObject anObject)
Deletion of the SObject with all his child objects.
SObject NewObject(in SObject theFatherObject)
Creation of a new SObject.
void RemoveAttribute(in SObject anObject, in string aTypeOfAttribute)
Deleting the attribute assigned to the SObject.
SComponent NewComponent(in string ComponentDataType)
Creation of a new SComponent.
void LoadWith(in SComponent sco, in Driver Engine)
Loads a SComponent.
void RemoveObject(in SObject anObject)
Deletion of the SObject.
boolean IsGUID(in SObject anObject, in string theGUID)
Searches for a definite SObject with a definite GUID and returns True if it finds it.
SObject NewObjectToTag(in SObject theFatherObject, in long atag)
Creation of a new SObject with a definite tag.
void Load(in SObject sco)
Loads a SObject.
void Addreference(in SObject anObject, in SObject theReferencedObject)
Adds a reference between anObject and theReferencedObject.
void SetGUID(in SObject anObject, in string theGUID)
Identification of the SObject's substructure.
boolean FindAttribute(in SObject anObject, out GenericAttribute anAttribute, in string aTypeOfAttribute)
Looking for an attribute assigned to a SObject.
Study Interface
Definition: SALOMEDS.idl:371
oneway void ShutdownWithExit()
Shutdown the Study process.
long getPID()
Returns the PID of the server.
sequence< SObject > ListOfSObject
Indicate the file where the study has been saved.
Definition: SALOMEDS.idl:413
PersistentReference GetPersistentReference()
Get the persistent reference to the Study.
void ping()
Determines whether the server has already been loaded or not.
attribute wstring Name
The name of the Study.
Definition: SALOMEDS.idl:407
Interface of the UseCaseBuilder.
Definition: SALOMEDS.idl:1150
boolean IsUseCaseNode(in SObject theObject)
Returns True if the given object theObject is included in the use cases tree on any level.
string GetName()
Gets the name of the use case.
boolean InsertBefore(in SObject theFirst, in SObject theNext)
Inserts in the use case the object theFirst before the object theNext.
boolean Append(in SObject theObject)
Adds to the use case an object as a child of the current object of the use case.
boolean IsUseCase(in SObject theObject)
Returns True if the given object theObject represents a use case.
UseCaseIterator GetUseCaseIterator(in SObject theObject)
Returns the UseCaseIterator for the given object theObject in the use case.
SObject GetFather(in SObject theObject)
Gets father object of the given object theObject in the use cases tree.
boolean Remove(in SObject theObject)
Removes an object from the use case.
boolean SetRootCurrent()
Makes the root object to be the current object of the use case.
boolean SortChildren(in SObject theObject, in boolean theAscendingOrder)
Returns True if children of the given object theObject of the use case tree were sorted successfully.
long GetIndexInFather(in SObject theFather, in SObject theObject)
Return index of a child among father children.
boolean SetName(in string theName)
Sets the name of the use case.
boolean AppendTo(in SObject theFather, in SObject theObject)
Adds a child object theObject to the given father theFather object in the use case.
SObject GetCurrentObject()
Gets the current object of the use case.
SObject AddUseCase(in string theName)
Creates a new use case in the use case browser.
boolean SetCurrentObject(in SObject theObject)
Sets the current object of the use case.
boolean HasChildren(in SObject theObject)
Returns True if the given object theObject of the use case has child objects.
Interface of the UseCaseIterator.
Definition: SALOMEDS.idl:1121
SObject Value()
Returns the SObject corresponding to the current object found by the Iterator.
void Next()
Passes the iterator to the next object.
void Init(in boolean allLevels)
Activates the UseCaseIterator.
boolean More()
Method More.
interface for common behavior of SALOME transient CORBA objects
Definition: SALOME_GenericObj.idl:40
obj
Definition: batchmode_salome.py:275
def SetName(objId, name)
Definition: salome_ComponentGUI.py:89
def Init()
Definition: salome_ComponentGUI.py:84
This package contains the interfaces used for creation, management and modification of the Study.
Definition: SALOMEDS.hxx:37
sequence< string > ListOfFileNames
List of file names.
Definition: SALOMEDS.idl:59
sequence< string > ListOfDates
List of modification dates of a study.
Definition: SALOMEDS.idl:61
sequence< octet > TMPFile
A byte stream which is used for binary data transfer between different components.
Definition: SALOMEDS.idl:67
sequence< ListOfStrings > ListOfListOfStrings
An unbounded sequence of sequence of strings.
Definition: SALOMEDS.idl:65
wstring URLPath
Name of the file in which the Study is saved.
Definition: SALOMEDS.idl:44
string SalomeReference
IOR of the study in SALOME application.
Definition: SALOMEDS.idl:56
string ID
Main identifier of an object in SALOME application.
Definition: SALOMEDS.idl:48
string PersistentReference
While saving the data, IOR is transformed into persistent reference.
Definition: SALOMEDS.idl:52
sequence< string > ListOfStrings
An unbounded sequence of strings.
Definition: SALOMEDS.idl:63
sequence< GenericAttribute > ListOfAttributes
List of attributes of SObjects.
Definition: SALOMEDS.idl:92
Module SALOME contains all base interfaces of SALOME Kernel.
Definition: HeatMarcel.hxx:25
string name
Definition: pythfilter.py:56