Back to index

salome-kernel  6.5.0
Public Member Functions
SALOMEDS::UseCaseBuilder Interface Reference

Interface of the UseCaseBuilder. More...

import "SALOMEDS.idl";

Inheritance diagram for SALOMEDS::UseCaseBuilder:
Inheritance graph
[legend]
Collaboration diagram for SALOMEDS::UseCaseBuilder:
Collaboration graph
[legend]

List of all members.

Public Member Functions

boolean Append (in SObject theObject)
 Adds to the use case an object as a child of the current object of the use case.
boolean Remove (in SObject theObject)
 Removes an object from 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.
boolean InsertBefore (in SObject theFirst, in SObject theNext)
 Inserts in the use case the object theFirst before the object theNext.
boolean SetCurrentObject (in SObject theObject)
 Sets the current object of the use case.
boolean SetRootCurrent ()
 Makes the root object to be 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.
SObject GetFather (in SObject theObject)
 Gets father object of the given object theObject in the use cases tree.
boolean SetName (in string theName)
 Sets the name of the use case.
string GetName ()
 Gets the name of the use case.
boolean IsUseCase (in SObject theObject)
 Returns True if the given object theObject represents a use case.
boolean IsUseCaseNode (in SObject theObject)
 Returns True if the given object theObject is included in the use cases tree on any level.
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.
UseCaseIterator GetUseCaseIterator (in SObject theObject)
 Returns the UseCaseIterator for the given object theObject in the use case.
void Register ()
 Increase the reference count (mark as used by another object).
void UnRegister ()
 Decrease the reference count (release by another object).
void Destroy ()
 Obsolete, left for compatibility reasons only.

Detailed Description

Interface of the UseCaseBuilder.

Use case in the study represents a user-managed subtree, containing all or some of the objects which exist in the study. The UseCaseBuilder interface contains a set of methods used for management of the use case in the study.

Definition at line 1286 of file SALOMEDS.idl.


Member Function Documentation

Creates a new use case in the use case browser.

boolean SALOMEDS::UseCaseBuilder::Append ( in SObject  theObject)

Adds to the use case an object as a child of the current object of the use case.

Parameters:
theObjectThe added SObject.
Returns:
True if this SObject has been added in the use case.
boolean SALOMEDS::UseCaseBuilder::AppendTo ( in SObject  theFather,
in SObject  theObject 
)

Adds a child object theObject to the given father theFather object in the use case.

void SALOME::GenericObj::Destroy ( ) [inherited]

Obsolete, left for compatibility reasons only.

Use UnRegister() instead.

Gets the current object of the use case.

Gets father object of the given object theObject in the use cases tree.

Gets the name of the use case.

Returns the UseCaseIterator for the given object theObject in the use case.

Returns True if the given object theObject of the use case has child objects.

boolean SALOMEDS::UseCaseBuilder::InsertBefore ( in SObject  theFirst,
in SObject  theNext 
)

Inserts in the use case the object theFirst before the object theNext.

boolean SALOMEDS::UseCaseBuilder::IsUseCase ( in SObject  theObject)

Returns True if the given object theObject represents a use case.

Returns True if the given object theObject is included in the use cases tree on any level.

void SALOME::GenericObj::Register ( ) [inherited]

Increase the reference count (mark as used by another object).

boolean SALOMEDS::UseCaseBuilder::Remove ( in SObject  theObject)

Removes an object from the use case.

Parameters:
theObjectThe deleted SObject
Returns:
True if this SObject has been deleted from the use case.

Sets the current object of the use case.

boolean SALOMEDS::UseCaseBuilder::SetName ( in string  theName)

Sets the name of the use case.

Makes the root object to be the current object of the use case.

void SALOME::GenericObj::UnRegister ( ) [inherited]

Decrease the reference count (release by another object).

Here is the caller graph for this function:


The documentation for this interface was generated from the following file: