Back to index

salome-kernel  6.5.0
Public Member Functions
SALOMEDS::AttributeName Interface Reference

Name attribute. More...

import "SALOMEDS_Attributes.idl";

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

List of all members.

Public Member Functions

string Value ()
 Returns the value assigned to the attribute.
void SetValue (in string value)
 Sets the value of the attribute (name of a SObject).
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 UnRegister ()
 Decrease the reference count (release by another object).
void Destroy ()
 Obsolete, left for compatibility reasons only.

Detailed Description

Name attribute.

The attribute stores a string value, which corresponds to the name of the SObject or to the name of corresponding object.

See example5 for an example of this attribute usage in batchmode of SALOME application.

See also:
AttributeComment

Definition at line 223 of file SALOMEDS_Attributes.idl.


Member Function Documentation

Method CheckLocked.

Checks whether the Study is protected for modifications.

Note:

This exception is raised only outside a transaction.
void SALOME::GenericObj::Destroy ( ) [inherited]

Obsolete, left for compatibility reasons only.

Use UnRegister() instead.

Get the class type.

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

Private method, returns an implementation of this GenericAttribute.

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

Get SObject.

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

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

void SALOMEDS::AttributeName::SetValue ( in string  value)

Sets the value of the attribute (name of a SObject).

Parameters:
valuevalue being set to the attribute
string SALOMEDS::GenericAttribute::Type ( ) [inherited]

Get Type.

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

Decrease the reference count (release by another object).

Here is the caller graph for this function:

Returns the value assigned to the attribute.

Returns:
attribute value

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