Tree node attribute. More...

import "SALOMEDS_Attributes.idl";

Inheritance diagram for SALOMEDS::AttributeTreeNode:

Public Member Functions
void	SetFather (in AttributeTreeNode father)
	Assigns the father tree node to this tree node. More...

boolean	HasFather ()
	Checks if father tree node attribute is set for this tree node. More...

AttributeTreeNode	GetFather ()
	Returns the father tree node of this tree node. More...

void	SetPrevious (in AttributeTreeNode sibling)
	Assigns the previous sibling tree node to this tree node. More...

boolean	HasPrevious ()
	Checks if previous sibling tree node attribute is set for this tree node. More...

AttributeTreeNode	GetPrevious ()
	Returns the previous sibling tree node of this tree node. More...

void	SetNext (in AttributeTreeNode sibling)
	Assigns the next sibling tree node to this tree node. More...

boolean	HasNext ()
	Checks if next sibling tree node attribute is set for this tree node. More...

AttributeTreeNode	GetNext ()
	Returns the next sibling tree node of this tree node. More...

void	SetFirst (in AttributeTreeNode child)
	Sets the specified tree node as a first child of this tree node. More...

boolean	HasFirst ()
	Checks if first child tree node attribute is set for this tree node. More...

AttributeTreeNode	GetFirst ()
	Returns the first child tree node of this tree node. More...

void	SetTreeID (in string ID)
	Sets identifier of the parent tree to this tree node. More...

string	GetTreeID ()
	Returns identifier of the parent tree. More...

void	Append (in AttributeTreeNode child)
	Appends specified tree node to the end of the children list of this tree node. More...

void	Prepend (in AttributeTreeNode child)
	Puts specified tree node to the beginning of the children list of this tree node. More...

void	InsertBefore (in AttributeTreeNode child)
	Insert specified tree node as a previous child in the parent tree node's children list. More...

void	InsertAfter (in AttributeTreeNode child)
	Insert specified tree node as a next child in the parent tree node's children list. More...

void	Remove ()
	Removes this tree node. More...

long	Depth ()
	Returns the depth of the tree node in the tree structure. More...

boolean	IsRoot ()
	Checks if the tree node is a root of the tree. More...

boolean	IsDescendant (in AttributeTreeNode other)
	Checks if the tree node is a descendant of the specified tree node. More...

boolean	IsFather (in AttributeTreeNode other)
	Checks if this tree node is a parent of the specified tree node other. More...

boolean	IsChild (in AttributeTreeNode other)
	Checks if this tree node is a child of the specified tree node other. More...

string	Label ()
	Returns string identifier of the owner SObject (e.g. More...

void	CheckLocked () raises (LockProtection)
	Method CheckLocked. More...

string	Type ()
	Get Type. More...

string	GetClassType ()
	Get the class type. More...

SObject	GetSObject ()
	Get SObject. More...

long long	GetLocalImpl (in string theHostname, in long thePID, out boolean isLocal)
	Private method, returns an implementation of this GenericAttribute. More...

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

void	UnRegister ()
	Decrease the reference count (release by another object). More...

void	Destroy ()
	Obsolete, left for compatibility reasons only. More...

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.

Member Function Documentation

void SALOMEDS::AttributeTreeNode::Append ( in AttributeTreeNode child )

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

Parameters

child tree node being added to the list of children

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.

long SALOMEDS::AttributeTreeNode::Depth ( )

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.

string SALOMEDS::GenericAttribute::GetClassType ( )

inherited

Get the class type.

AttributeTreeNode SALOMEDS::AttributeTreeNode::GetFather ( )

Returns the father tree node of this tree node.

Returns: father tree node attribute

AttributeTreeNode SALOMEDS::AttributeTreeNode::GetFirst ( )

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

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

AttributeTreeNode SALOMEDS::AttributeTreeNode::GetNext ( )

Returns the next sibling tree node of this tree node.

Returns: next sibling tree node attribute

AttributeTreeNode SALOMEDS::AttributeTreeNode::GetPrevious ( )

Returns the previous sibling tree node of this tree node.

Returns: previous sibling tree node attribute

SObject SALOMEDS::GenericAttribute::GetSObject ( )

inherited

Get SObject.

string SALOMEDS::AttributeTreeNode::GetTreeID ( )

Returns identifier of the parent tree.

Returns: parent tree identifier

boolean SALOMEDS::AttributeTreeNode::HasFather ( )

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

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

boolean SALOMEDS::AttributeTreeNode::HasFirst ( )

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

boolean SALOMEDS::AttributeTreeNode::HasNext ( )

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

boolean SALOMEDS::AttributeTreeNode::HasPrevious ( )

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

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

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

Parameters

child tree node being inserted to the parent tree node

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

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

Parameters

child tree node being inserted to the parent tree node

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

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

Parameters

other tree 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

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

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

Parameters

other tree 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

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

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

Parameters

other tree 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

boolean SALOMEDS::AttributeTreeNode::IsRoot ( )

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

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

string SALOMEDS::AttributeTreeNode::Label ( )

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

"0:1:2").

Returns: string entry of the owner SObject

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

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

Parameters

child tree node being added to the list of children

void SALOME::GenericObj::Register ( )

inherited

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

void SALOMEDS::AttributeTreeNode::Remove ( )

Removes this tree node.

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

Assigns the father tree node to this tree node.

Parameters

father tree node attribute being set as a parent of this tree node

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

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

Parameters

child tree node attribute being set filrst child of this tree node

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

Assigns the next sibling tree node to this tree node.

Parameters

sibling tree node attribute being set as a next sibling of this tree node

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

Assigns the previous sibling tree node to this tree node.

Parameters

sibling tree node attribute being set as a previous sibling of this tree node

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

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

ID	identifier (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).

Public Member Functions

Detailed Description

Member Function Documentation