Back to index

salome-kernel  6.5.0
Public Member Functions | Public Attributes
SALOMEDS::SObject Interface Reference

SObject interface More...

import "SALOMEDS.idl";

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

List of all members.

Public Member Functions

boolean IsNull ()
 Returns true if the SObject does not belong to any Study.
ID GetID ()
 Gets an object ID.
SComponent GetFatherComponent ()
 Acquisition of the father Component of the SObject.
SObject GetFather ()
 Acquisition of the father SObject of the SObject.
short Tag ()
 Gets the tag of a SObject.
short Depth ()
 Gets the depth of a SObject.
boolean FindSubObject (in long atag, out SObject obj)
 Looks for subobjects of a given SObject.
boolean FindAttribute (out GenericAttribute anAttribute, in string aTypeOfAttribute)
 Looks for attributes of a given SObject.
boolean ReferencedObject (out SObject obj)
 Looks for a SObject which the given SObject refers to.
ListOfAttributes GetAllAttributes ()
 Gets all attributes of a given SObject.
Study GetStudy ()
 Gets the study of a given SObject.
Object GetObject ()
 Gets the CORBA object by its own IOR attribute.
string GetName ()
 Returns the name attribute value of this SObject.
string GetComment ()
 Returns the comment attribute value of this SObject.
string GetIOR ()
 Returns the IOR attribute value of this SObject.
void SetAttrString (in string name, in string value)
 Set an attribute value (of type string)
long long GetLocalImpl (in string theHostname, in long thePID, out boolean isLocal)
 Private method, returns an implementation of this SObject.
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.

Public Attributes

attribute string Name
 Name of the SObject.

Detailed Description

SObject interface

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.

Definition at line 1006 of file SALOMEDS.idl.


Member Function Documentation

Gets the depth of a SObject.

Returns:
the depth of a SObject.
void SALOME::GenericObj::Destroy ( ) [inherited]

Obsolete, left for compatibility reasons only.

Use UnRegister() instead.

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

Looks for attributes of a given SObject.

Parameters:
aTypeOfAttributeString 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 example1 for an example of this method usage in batchmode of SALOME application.

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

Looks for subobjects of a given SObject.

Parameters:
atagTag of the given SObject
Returns:
True if it finds a subobject of the SObject with a definite tag as well as the required subobject.

Gets all attributes of a given SObject.

\return The list of all attributes of the given %SObject.

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

Returns the comment attribute value of this SObject.

Returns empty string if there is no comment attribute.

Acquisition of the father SObject of the SObject.

Returns:
the father SObject of the given SObject.

Acquisition of the father Component of the SObject.

Returns:
The father Component of the SObject.

Gets an object ID.

Returns:
ID of the SObject.

Returns the IOR attribute value of this SObject.

Returns empty string if there is no IOR attribute.

long long SALOMEDS::SObject::GetLocalImpl ( in string  theHostname,
in long  thePID,
out boolean  isLocal 
)

Private method, returns an implementation of this SObject.

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

Returns the name attribute value of this SObject.

Returns empty string if there is no name attribute.

Gets the CORBA object by its own IOR attribute.

Returns nil, if can't.

Returns:
The CORBA object of the SObject.

Gets the study of a given SObject.

Returns:
The study containing the given SObject.

Returns true if the SObject does not belong to any Study.

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.
void SALOME::GenericObj::Register ( ) [inherited]

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

void SALOMEDS::SObject::SetAttrString ( in string  name,
in string  value 
)

Set an attribute value (of type string)

Parameters:
namethe name of the attribute
valuethe value of the attribute

Gets the tag of a SObject.

Returns:
the tag of a SObject.
void SALOME::GenericObj::UnRegister ( ) [inherited]

Decrease the reference count (release by another object).

Here is the caller graph for this function:


Member Data Documentation

attribute string SALOMEDS::SObject::Name

Name of the SObject.

Definition at line 1010 of file SALOMEDS.idl.


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