SALOMEDS::StudyBuilder Interface Reference

Study Builder Interface More...

import "SALOMEDS.idl";

Collaboration diagram for SALOMEDS::StudyBuilder:


Public Member Functions
SComponent	NewComponent (in string ComponentDataType) raises (LockProtection)
	Creation of a new SComponent.
void	DefineComponentInstance (in SComponent aComponent, in Object ComponentIOR) raises (LockProtection)
	Definition of the instance to the SComponent.
void	RemoveComponent (in SComponent aComponent) raises (LockProtection)
	Deletion of a SComponent.
SObject	NewObject (in SObject theFatherObject) raises (LockProtection)
	Creation of a new SObject.
SObject	NewObjectToTag (in SObject theFatherObject, in long atag) raises (LockProtection)
	Creation of a new SObject with a definite tag.
void	RemoveObject (in SObject anObject) raises (LockProtection)
	Deletion of the SObject.
void	RemoveObjectWithChildren (in SObject anObject) raises (LockProtection)
	Deletion of the SObject with all his child objects.
void	LoadWith (in SComponent sco, in Driver Engine) raises (SALOME::SALOME_Exception)
void	Load (in SObject sco)
GenericAttribute	FindOrCreateAttribute (in SObject anObject, in string aTypeOfAttribute) raises (LockProtection)
	Looking for or creating an attribute assigned to the SObject.
boolean	FindAttribute (in SObject anObject, out GenericAttribute anAttribute, in string aTypeOfAttribute)
	Looking for an attribute assigned to a SObject.
void	RemoveAttribute (in SObject anObject, in string aTypeOfAttribute) raises (LockProtection)
	Deleting the attribute assigned to the SObject.
void	Addreference (in SObject anObject, in SObject theReferencedObject)
void	RemoveReference (in SObject anObject)
void	AddDirectory (in string theName) raises (LockProtection)
void	SetGUID (in SObject anObject, in string theGUID) raises (LockProtection)
	Identification of the SObject's substructure.
boolean	IsGUID (in SObject anObject, in string theGUID)
void	NewCommand ()
	Creation of a new command.
void	CommitCommand () raises (LockProtection)
	Execution of the command.
boolean	HasOpenCommand ()
void	AbortCommand ()
	Cancelation of the command.
void	Undo () raises (LockProtection)
	Undo method.
void	Redo () raises (LockProtection)
	Redo method.
boolean	GetAvailableUndos ()
boolean	GetAvailableRedos ()
void	SetName (in SObject theSO, in string theValue) raises (LockProtection)
void	SetComment (in SObject theSO, in string theValue) raises (LockProtection)
void	SetIOR (in SObject theSO, in string theValue) raises (LockProtection)
Data Fields
attribute long	UndoLimit
	Undolimit.
Data Structures
exception	LockProtection
	LockProtection Exception More...

Detailed Description

The purpose of the Builder is to add and/or remove objects and attributes. A StudyBuilder is linked to a Study. A command management is provided for the undo/redo functionalities.

Note:: The Tag of an item in SALOME application is a symbolic description of item's position in the tree-type structure of the browser. In general it has the following form: 0:2:1:1

Member Function Documentation

SComponent SALOMEDS::StudyBuilder::NewComponent ( in string ComponentDataType ) raises (LockProtection)

Creates a new SComponent
Parameters:

ComponentDataType Data type of the SComponent which will be created.

See also an example of this method usage in batchmode of SALOME application.

void SALOMEDS::StudyBuilder::DefineComponentInstance ( in SComponent aComponent,

in Object ComponentIOR

) raises (LockProtection)

Defines the instance to the SComponent.

void SALOMEDS::StudyBuilder::RemoveComponent ( in SComponent aComponent ) raises (LockProtection)

Removes a SComponent.

SObject SALOMEDS::StudyBuilder::NewObject ( in SObject theFatherObject ) raises (LockProtection)

Creates a new SObject under a definite father SObject.

Parameters:

theFatherObject The father SObject under which this one should be created.

Returns:
New SObject

See also an example of this method usage in batchmode of SALOME application.

SObject SALOMEDS::StudyBuilder::NewObjectToTag ( in SObject theFatherObject,

in long atag

) raises (LockProtection)

Creates a new SObject with a definite tag.

Parameters:

atag Long value corresponding to the tag of the new SObject.

Returns:
New SObject

void SALOMEDS::StudyBuilder::RemoveObject ( in SObject anObject ) raises (LockProtection)

Removes a SObject from the StudyBuilder.

Parameters:

anObject The SObject to be deleted.

void SALOMEDS::StudyBuilder::RemoveObjectWithChildren ( in SObject anObject ) raises (LockProtection)

Removes the SObject with all his child objects.

Parameters:

anObject The SObject to be deleted with all child objects.

void SALOMEDS::StudyBuilder::LoadWith ( in SComponent sco,

in Driver Engine

) raises (SALOME::SALOME_Exception)

Loads a SComponent.

See also an example of this method usage in batchmode of SALOME application.

void SALOMEDS::StudyBuilder::Load ( in SObject sco )

Loads a SObject.

Parameters:

sco SObject to be loaded.

GenericAttribute SALOMEDS::StudyBuilder::FindOrCreateAttribute ( in SObject anObject,

in string aTypeOfAttribute

) raises (LockProtection)

Allows to find or create an attribute of a specific type which is assigned to the object.
Parameters:

anObject The SObject corresponding to the attribute which is looked for.

aTypeOfAttribute Type of the attribute.

See also an example of this method usage in batchmode of SALOME application.

boolean SALOMEDS::StudyBuilder::FindAttribute ( in SObject anObject,

out GenericAttribute anAttribute,

in string aTypeOfAttribute

)

Allows to find an attribute of a specific type which is assigned to the object.
Parameters:

anObject The SObject corresponding to the attribute which is looked for.

aTypeOfAttribute Type of the attribute.

anAttribute Where the attribute is placed if it's found.

Returns:
True if it finds an attribute.

void SALOMEDS::StudyBuilder::RemoveAttribute ( in SObject anObject,

in string aTypeOfAttribute

) raises (LockProtection)

Removes the attribute of a specific type which is assigned to the object.
Parameters:

anObject The SObject corresponding to the attribute.

aTypeOfAttribute Type of the attribute.

See also an example of this method usage in batchmode of SALOME application.

void SALOMEDS::StudyBuilder::Addreference ( in SObject anObject,

in SObject theReferencedObject

)

Adds a reference between anObject and theReferencedObject.
Parameters:

anObject The SObject which will get a reference

theReferencedObject The SObject having a reference

void SALOMEDS::StudyBuilder::RemoveReference ( in SObject anObject )

Removes a reference from anObject to another object.
Parameters:

anObject The SObject which contains a reference

void SALOMEDS::StudyBuilder::AddDirectory ( in string theName ) raises (LockProtection)

Adds a directory in the Study.
Parameters:

theName String parameter defining the name of the directory.

See also an example of this method usage in batchmode of SALOME application.

void SALOMEDS::StudyBuilder::SetGUID ( in SObject anObject,

in string theGUID

) raises (LockProtection)

Identification of the SObject's substructure by GUID.

Parameters:

anObject The SObject which will be identified

theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"

boolean SALOMEDS::StudyBuilder::IsGUID ( in SObject anObject,

in string theGUID

)

Searches for a definite SObject with a definite GUID and returns True if it finds it.

Parameters:

anObject A definite SObject which will be identified

theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"

void SALOMEDS::StudyBuilder::NewCommand ( )

Creates a new command which can contain several different actions.

See also an example of this method usage in batchmode of SALOME application.

void SALOMEDS::StudyBuilder::CommitCommand ( ) raises (LockProtection)

Commits all actions declared within this command.

Exceptions:

LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.

See also an example of this method usage in batchmode of SALOME application.

boolean SALOMEDS::StudyBuilder::HasOpenCommand ( )

Returns True if at this moment there is a command under execution.

void SALOMEDS::StudyBuilder::AbortCommand ( )

Cancels all actions declared within the command.

See also an example of this method usage in batchmode of SALOME application.

void SALOMEDS::StudyBuilder::Undo ( ) raises (LockProtection)

Cancels all actions of the last command.

Exceptions:

LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.

See also an example of this method usage in batchmode of SALOME application.

void SALOMEDS::StudyBuilder::Redo ( ) raises (LockProtection)

Redoes all actions of the last command.

Exceptions:

LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.

See also an example of this method usage in batchmode of SALOME application.

boolean SALOMEDS::StudyBuilder::GetAvailableUndos ( )

Returns True if at this moment there are any actions which can be canceled.

See also an example of this method usage in batchmode of SALOME application.

boolean SALOMEDS::StudyBuilder::GetAvailableRedos ( )

Returns True if at this moment there are any actions which can be redone.

See also an example of this method usage in batchmode of SALOME application.

void SALOMEDS::StudyBuilder::SetName ( in SObject theSO,

in string theValue

) raises (LockProtection)

Puts name attribute with the given string value to the given SObject

Parameters:

theSO Existing SObject to set name attribute.

theValue The value to be set to the name attribute.

void SALOMEDS::StudyBuilder::SetComment ( in SObject theSO,

in string theValue

) raises (LockProtection)

Puts comment attribute with the given string value to the given SObject

Parameters:

theSO Existing SObject to set comment attribute.

theValue The value to be set to the comment attribute.

void SALOMEDS::StudyBuilder::SetIOR ( in SObject theSO,

in string theValue

) raises (LockProtection)

Puts IOR attribute with the given string value to the given SObject

Parameters:

theSO Existing SObject to set IOR attribute.

theValue The value to be set to the IOR attribute.

Field Documentation

attribute long SALOMEDS::StudyBuilder::UndoLimit

The number of actions which can be undone

SALOMEDS::StudyBuilder Interface Reference

Public Member Functions

Data Fields

Data Structures

Detailed Description

Member Function Documentation

Field Documentation