SALOMEDS::SComponent Interface Reference

SComponent interface More...

Inheritance diagram for SALOMEDS::SComponent:

Public Member Functions
string	ComponentDataType ()
	Gets the data type of the given SComponent. More...
boolean	ComponentIOR (out ID theID)
	Gets the IOR of the given component. More...
boolean	IsNull ()
ID	GetID ()
SComponent	GetFatherComponent ()
SObject	GetFather ()
short	Tag ()
short	GetLastChildTag ()
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 ()
void	SetAttrString (in string name, in string value)
long long	GetLocalImpl (in string theHostname, in long thePID, out boolean isLocal)
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. Use UnRegister() instead. More...

Data Fields
attribute string	Name

Detailed Description

SComponent interface

The SComponent interface establishes in the study a permanent assocition to the Components integrated into SALOME platform. The SComponent interface is a specialization of the SObject interface. It inherits the most of its methods from the SObject interface.

Member Function Documentation

string SALOMEDS::SComponent::ComponentDataType

(

)

Gets the data type of the given SComponent.

Returns

The data type of this SComponent.

boolean SALOMEDS::SComponent::ComponentIOR

(

out ID

theID

)

Gets the IOR of the given component.

Returns

True (if there is an instance of the given component) and its IOR.

boolean SALOMEDS::SObject::IsNull ( )

inherited

Returns true if the SObject does not belong to any Study

ID SALOMEDS::SObject::GetID ( )

inherited

Gets an object ID

Returns

ID of the SObject.

SComponent SALOMEDS::SObject::GetFatherComponent ( )

inherited

Acquisition of the father Component of the SObject

Returns

The father Component of the SObject.

SObject SALOMEDS::SObject::GetFather ( )

inherited

Acquisition of the father SObject of the SObject

Returns

the father SObject of the given SObject.

short SALOMEDS::SObject::Tag ( )

inherited

Gets the tag of a SObject

Returns

the tag of a SObject.

short SALOMEDS::SObject::GetLastChildTag ( )

inherited

Returns a tag of the last child SObject (if any) of this SObject. Returns zero if this SObject has no children.

short SALOMEDS::SObject::Depth ( )

inherited

Gets the depth of a SObject

Returns

the depth of a SObject.

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

inherited

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  )

inherited

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

boolean SALOMEDS::SObject::ReferencedObject ( out SObject  obj )

inherited

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 ( )

inherited

Gets all attributes of a given SObject

Returns

The list of all attributes of the given SObject.

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

Study SALOMEDS::SObject::GetStudy ( )

inherited

Gets the study of a given SObject.

Returns

The study containing the given SObject.

Object SALOMEDS::SObject::GetObject ( )

inherited

Gets the CORBA object by its own IOR attribute. Returns nil, if can't.

Returns

The CORBA object of the SObject.

string SALOMEDS::SObject::GetName ( )

inherited

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

string SALOMEDS::SObject::GetComment ( )

inherited

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

string SALOMEDS::SObject::GetIOR ( )

inherited

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

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

inherited

Set an attribute value (of type string)

Parameters

name	the name of the attribute
value	the value of the attribute

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

inherited

Private method, returns an implementation of this SObject.

Parameters

theHostname	is a hostname of the caller
thePID	is a process ID of the caller
isLocal	is set True if the SObject is launched locally with the caller

void SALOME::GenericObj::Register ( )

inherited

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

void SALOME::GenericObj::UnRegister ( )

inherited

Decrease the reference count (release by another object).

void SALOME::GenericObj::Destroy ( )

inherited

Obsolete, left for compatibility reasons only. Use UnRegister() instead.

Field Documentation

attribute string SALOMEDS::SObject::Name

inherited

Name of the SObject