SALOMEDS.SObject Interface Reference

SObject interface More...

import "SALOMEDS.idl";

Inheritance diagram for SALOMEDS.SObject:

Public Member Functions
ID	GetID ()
SComponent	GetFatherComponent ()
SObject	GetFather ()
short	Tag ()
short	Depth ()
boolean	FindSubObject (in long atag, out SObject obj)
boolean	FindAttribute (out GenericAttribute anAttribute, in string aTypeOfAttribute)
boolean	ReferencedObject (out SObject obj)
ListOfAttributes	GetAllAttributes ()
Study	GetStudy ()
Object	GetObject ()
string	GetName ()
string	GetComment ()
string	GetIOR ()
Data Fields
attribute string	Name

---

Detailed Description

The objects in the study are built by the StudyBuilder. The SObject interface provides methods for elementary inquiries, like getting an object ID or its attribuites.

Note:

Tag of an item in SALOME application is an integer value uniquely defining an item in the tree-type data structure.
ID of an item is a description of item's position in the tree-type data structure. ID is a list of tags and it has the following form: 0:2:1:1.

---

Member Function Documentation

ID SALOMEDS.SObject.GetID (   )

Gets an object ID Returns: ID of the SObject.

SComponent SALOMEDS.SObject.GetFatherComponent (   )

Acquisition of the father Component of the SObject Returns: The father Component of the SObject.

SObject SALOMEDS.SObject.GetFather (   )

Acquisition of the father SObject of the SObject Returns: the father SObject of the given SObject.

short SALOMEDS.SObject.Tag (   )

Gets the tag of a SObject Returns: the tag of a SObject.

short SALOMEDS.SObject.Depth (   )

Gets the depth of a SObject Returns: the depth of a SObject.

boolean SALOMEDS.SObject.FindSubObject (  in long  atag, out SObject  obj )

Looks for subobjects of a given SObject. Parameters: atag  Tag of the given SObject Returns: True if it finds a subobject of the SObject with a definite tag as well as the required subobject.

boolean SALOMEDS.SObject.FindAttribute (  out GenericAttribute  anAttribute, in string  aTypeOfAttribute )

Looks for attributes of a given SObject Parameters: aTypeOfAttribute  String value defining the type of the required attribute of the given SObject. Returns: True if it finds an attribute of a definite type of the given SObject as well as the discovered attribute. See also an example of this method usage in batchmode of SALOME application.

boolean SALOMEDS.SObject.ReferencedObject (  out SObject  obj  )

Looks for a SObject which the given SObject refers to. Returns: The object which the given SObject refers to as well as True if it finds this object.

ListOfAttributes SALOMEDS.SObject.GetAllAttributes (   )

Gets all attributes of a given SObject Returns: The list of all attributes of the given SObject. See also an example of this method usage in batchmode of SALOME application.

Study SALOMEDS.SObject.GetStudy (   )

Gets the study of a given SObject. /return The study containing the given SObject.

Object SALOMEDS.SObject.GetObject (   )

Gets the CORBA object by its own IOR attribute. Returns nil, if can't. /return The CORBA object of the SObject.

string SALOMEDS.SObject.GetName (   )

Returns the name attribute value of this SObject. Returns empty string if there is no name attribute.

string SALOMEDS.SObject.GetComment (   )

Returns the comment attribute value of this SObject. Returns empty string if there is no comment attribute.

string SALOMEDS.SObject.GetIOR (   )

Returns the IOR attribute value of this SObject. Returns empty string if there is no IOR attribute.

---

Field Documentation

attribute string SALOMEDS.SObject.Name

Name of the SObject

---