Back to index

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

Tree node attribute. More...

import "SALOMEDS_Attributes.idl";

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

List of all members.

Public Member Functions

void SetFather (in AttributeTreeNode father)
 Assigns the father tree node to this tree node.
boolean HasFather ()
 Checks if father tree node attribute is set for this tree node.
AttributeTreeNode GetFather ()
 Returns the father tree node of this tree node.
void SetPrevious (in AttributeTreeNode sibling)
 Assigns the previous sibling tree node to this tree node.
boolean HasPrevious ()
 Checks if previous sibling tree node attribute is set for this tree node.
AttributeTreeNode GetPrevious ()
 Returns the previous sibling tree node of this tree node.
void SetNext (in AttributeTreeNode sibling)
 Assigns the next sibling tree node to this tree node.
boolean HasNext ()
 Checks if next sibling tree node attribute is set for this tree node.
AttributeTreeNode GetNext ()
 Returns the next sibling tree node of this tree node.
void SetFirst (in AttributeTreeNode child)
 Sets the specified tree node as a first child of this tree node.
boolean HasFirst ()
 Checks if first child tree node attribute is set for this tree node.
AttributeTreeNode GetFirst ()
 Returns the first child tree node of this tree node.
void SetTreeID (in string ID)
 Sets identifier of the parent tree to this tree node.
string GetTreeID ()
 Returns identifier of the parent tree.
void Append (in AttributeTreeNode child)
 Appends specified tree node to the end of the children list of this tree node.
void Prepend (in AttributeTreeNode child)
 Puts specified tree node to the beginning of the children list of this tree node.
void InsertBefore (in AttributeTreeNode child)
 Insert specified tree node as a previous child in the parent tree node's children list.
void InsertAfter (in AttributeTreeNode child)
 Insert specified tree node as a next child in the parent tree node's children list.
void Remove ()
 Removes this tree node.
long Depth ()
 Returns the depth of the tree node in the tree structure.
boolean IsRoot ()
 Checks if the tree node is a root of the tree.
boolean IsDescendant (in AttributeTreeNode other)
 Checks if the tree node is a descendant of the specified tree node.
boolean IsFather (in AttributeTreeNode other)
 Checks if this tree node is a parent of the specified tree node other.
boolean IsChild (in AttributeTreeNode other)
 Checks if this tree node is a child of the specified tree node other.
string Label ()
 Returns string identifier of the owner SObject (e.g.
void CheckLocked () raises (LockProtection)
 Method CheckLocked.
string Type ()
 Get Type.
string GetClassType ()
 Get the class type.
SObject GetSObject ()
 Get SObject.
long long GetLocalImpl (in string theHostname, in long thePID, out boolean isLocal)
 Private method, returns an implementation of this GenericAttribute.
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

Tree node attribute.

By specifying the tree node attributes for the SObjects it is possible to create internal auxillary object tree with its own structure and identifier.

Since each such tree is specfied by the unique identifier, it is possible to create as many trees as it is required.

See example18 for an example of usage of this attribute in batchmode of SALOME application.

Definition at line 668 of file SALOMEDS_Attributes.idl.


Member Function Documentation

Appends specified tree node to the end of the children list of this tree node.

Parameters:
childtree node being added to the list of children

Method CheckLocked.

Checks whether the Study is protected for modifications.

Note:

This exception is raised only outside a transaction.

Returns the depth of the tree node in the tree structure.

The resulting value it equal to the number of the fathers of this tree node.

Note:
The depth of the root tree node is 0.
Returns:
tree node's depth
void SALOME::GenericObj::Destroy ( ) [inherited]

Obsolete, left for compatibility reasons only.

Use UnRegister() instead.

Get the class type.

Returns the father tree node of this tree node.

Returns:
father tree node attribute

Returns the first child tree node of this tree node.

Returns:
first child tree node attribute
long long SALOMEDS::GenericAttribute::GetLocalImpl ( in string  theHostname,
in long  thePID,
out boolean  isLocal 
) [inherited]

Private method, returns an implementation of this GenericAttribute.

Parameters:
theHostnameis a hostname of the caller
thePIDis a process ID of the caller
isLocalis set True if the GenericAttribute is launched locally with the caller

Returns the next sibling tree node of this tree node.

Returns:
next sibling tree node attribute

Returns the previous sibling tree node of this tree node.

Returns:
previous sibling tree node attribute

Get SObject.

Returns identifier of the parent tree.

Returns:
parent tree identifier

Checks if father tree node attribute is set for this tree node.

Returns:
true if father tree node attribute is defined or false otherwise

Checks if first child tree node attribute is set for this tree node.

Returns:
true if first child tree node attribute is defined or false otherwise

Checks if next sibling tree node attribute is set for this tree node.

Returns:
true if next sibling tree node attribute is defined or false otherwise

Checks if previous sibling tree node attribute is set for this tree node.

Returns:
true if previous sibling tree node attribute is defined or false otherwise

Insert specified tree node as a next child in the parent tree node's children list.

Parameters:
childtree node being inserted to the parent tree node

Insert specified tree node as a previous child in the parent tree node's children list.

Parameters:
childtree node being inserted to the parent tree node

Checks if this tree node is a child of the specified tree node other.

Parameters:
othertree node that is tested for being child of this tree node
Returns:
true if this node is child of the other node or false otherwise

Checks if the tree node is a descendant of the specified tree node.

Parameters:
othertree node that is tested for being ancestor of this tree node
Returns:
true if this node is descendant of the other node or false otherwise

Checks if this tree node is a parent of the specified tree node other.

Parameters:
othertree node that is tested for being father of this tree node
Returns:
true if this node is father of the other node or false otherwise

Checks if the tree node is a root of the tree.

Returns:
true if it is a root tree node or false otherwise

Returns string identifier of the owner SObject (e.g.

"0:1:2").

Returns:
string entry of the owner SObject

Puts specified tree node to the beginning of the children list of this tree node.

Parameters:
childtree node being added to the list of children
void SALOME::GenericObj::Register ( ) [inherited]

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

Removes this tree node.

Assigns the father tree node to this tree node.

Parameters:
fathertree node attribute being set as a parent of this tree node

Sets the specified tree node as a first child of this tree node.

Parameters:
childtree node attribute being set filrst child of this tree node

Assigns the next sibling tree node to this tree node.

Parameters:
siblingtree node attribute being set as a next sibling of this tree node

Assigns the previous sibling tree node to this tree node.

Parameters:
siblingtree node attribute being set as a previous sibling of this tree node

Sets identifier of the parent tree to this tree node.

Note:
All tree nodes which belong to the same tree, should have the same identifier.
Parameters:
IDidentifier (arbitrary non-empty string) being set for this tree node
string SALOMEDS::GenericAttribute::Type ( ) [inherited]

Get Type.

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: