SALOME documentation central

SALOMEDS::AttributeTreeNode Interface Reference

TreeNodeAttribute. More...

Inheritance diagram for SALOMEDS::AttributeTreeNode:
Inheritance graph

Public Member Functions

void SetFather (in AttributeTreeNode value)
boolean HasFather ()
AttributeTreeNode GetFather ()
void SetPrevious (in AttributeTreeNode value)
boolean HasPrevious ()
AttributeTreeNode GetPrevious ()
void SetNext (in AttributeTreeNode value)
boolean HasNext ()
AttributeTreeNode GetNext ()
void SetFirst (in AttributeTreeNode value)
boolean HasFirst ()
AttributeTreeNode GetFirst ()
void SetTreeID (in string value)
string GetTreeID ()
void Append (in AttributeTreeNode value)
void Prepend (in AttributeTreeNode value)
void InsertBefore (in AttributeTreeNode value)
void InsertAfter (in AttributeTreeNode value)
void Remove ()
long Depth ()
boolean IsRoot ()
boolean IsDescendant (in AttributeTreeNode value)
boolean IsFather (in AttributeTreeNode value)
boolean IsChild (in AttributeTreeNode value)
string Label ()
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 Destroy ()
 Decrease the reference count (release by another object).

Detailed Description

TreeNodeAttribute.

A set of these attributes on the SObjects of the study forms an inner auxiliary tree whith its own structure and identifier. The quantity of such trees with different identifiers can be arbitrary.

See example18 for an example of usage of the methods of this interface in batchmode of SALOME application.


Member Function Documentation

void SALOMEDS::AttributeTreeNode::SetFather ( in AttributeTreeNode  value  ) 

Assigns the father tree node to this tree node.

boolean SALOMEDS::AttributeTreeNode::HasFather (  ) 

Returns True if there is a father tree node of this tree node.

AttributeTreeNode SALOMEDS::AttributeTreeNode::GetFather (  ) 

Returns the father tree node of this tree node.

void SALOMEDS::AttributeTreeNode::SetPrevious ( in AttributeTreeNode  value  ) 

Assigns the previous brother tree node to the given tree node.

boolean SALOMEDS::AttributeTreeNode::HasPrevious (  ) 

Returns True if there is the previous brother tree node of this tree node.

AttributeTreeNode SALOMEDS::AttributeTreeNode::GetPrevious (  ) 

Returns the previous brother tree node of this tree node.

void SALOMEDS::AttributeTreeNode::SetNext ( in AttributeTreeNode  value  ) 

Sets the next brother tree node to this tree node.

boolean SALOMEDS::AttributeTreeNode::HasNext (  ) 

Returns True if there is the next brother tree node of this tree node.

AttributeTreeNode SALOMEDS::AttributeTreeNode::GetNext (  ) 

Returns the previous brother tree node of this tree node.

void SALOMEDS::AttributeTreeNode::SetFirst ( in AttributeTreeNode  value  ) 

Sets the first child tree node to this tree node.

boolean SALOMEDS::AttributeTreeNode::HasFirst (  ) 

Returns True if there is the first child tree node of this tree node.

AttributeTreeNode SALOMEDS::AttributeTreeNode::GetFirst (  ) 

Returns the first child tree node of this tree node.

void SALOMEDS::AttributeTreeNode::SetTreeID ( in string  value  ) 

Sets ID of a tree.

Parameters:
value String parameter defining the ID of a tree.
Note:

Tree nodes of one tree have the same ID.
string SALOMEDS::AttributeTreeNode::GetTreeID (  ) 

Gets ID of a tree.

Returns:
An ID of a tree in the format of a string.
void SALOMEDS::AttributeTreeNode::Append ( in AttributeTreeNode  value  ) 

Adds a child tree node to the end of the list of children of this tree node.

void SALOMEDS::AttributeTreeNode::Prepend ( in AttributeTreeNode  value  ) 

Adds a child tree node to the beginning of the list of children of this tree node.

void SALOMEDS::AttributeTreeNode::InsertBefore ( in AttributeTreeNode  value  ) 

Adds a brother tree node before this tree node. In this case the both tree nodes will belong to the same father.

void SALOMEDS::AttributeTreeNode::InsertAfter ( in AttributeTreeNode  value  ) 

Adds a brother tree node after this tree node. In this case the both tree nodes will belong to the same father.

void SALOMEDS::AttributeTreeNode::Remove (  ) 

Deletes a tree node.

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

long SALOMEDS::AttributeTreeNode::Depth (  ) 

Returns the depth of the tree node in the structure, it means the number of fathers of the given tree node. (i.e.: the depth of the root tree node is 0).

boolean SALOMEDS::AttributeTreeNode::IsRoot (  ) 

Returns True if it is a root tree node.

boolean SALOMEDS::AttributeTreeNode::IsDescendant ( in AttributeTreeNode  value  ) 

Returns True if this tree node is a descendant of the tree node.

boolean SALOMEDS::AttributeTreeNode::IsFather ( in AttributeTreeNode  value  ) 

Returns True if this tree node is the father of the tree node.

boolean SALOMEDS::AttributeTreeNode::IsChild ( in AttributeTreeNode  value  ) 

Returns True if this tree node is a child of the tree node.

string SALOMEDS::AttributeTreeNode::Label (  ) 

Returns ID of the according SObject.

void SALOMEDS::GenericAttribute::CheckLocked (  )  raises (LockProtection) [inherited]

Method CheckLocked.

Checks whether the Study is protected for modifications.

Note:

This exception is raised only outside a transaction.
string SALOMEDS::GenericAttribute::Type (  )  [inherited]

Get Type.

string SALOMEDS::GenericAttribute::GetClassType (  )  [inherited]

Get the class type.

SObject SALOMEDS::GenericAttribute::GetSObject (  )  [inherited]

Get SObject.

long long SALOMEDS::GenericAttribute::GetLocalImpl ( in string  theHostname,
in long  thePID,
out boolean  isLocal 
) [inherited]

Private method, returns an implementation of this GenericAttribute.

Parameters:
theHostname is a hostname of the caller
thePID is a process ID of the caller
isLocal is set True if the GenericAttribute is launched locally with the caller
void SALOME::GenericObj::Register (  )  [inherited]

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

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

Decrease the reference count (release by another object).


Copyright © 2007-2008 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS