Back to index

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

Comment attribute. More...

import "SALOMEDS_Attributes.idl";

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

List of all members.

Public Member Functions

string Value ()
 Returns the value of the attribute.
void SetValue (in string value)
 Sets the value of the attribute (description 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

Comment attribute.

The attribute stores arbitrary string value containing supplementary information about the SObject. This is common-usage attribute that can be used for any purpose.

There is only one explicit limitation: for the SComponent object representing the root item of the SALOME component tree, the AttributeComment is used to store component data type value. This attribute is automatically set with NewComponent() function of StudyBuilder. Also, the value of this attribute is returned by the ComponentDataType() function of SComponent interface.

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

See also:
AttributeName

Definition at line 255 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::AttributeComment::SetValue ( in string  value)

Sets the value of the attribute (description 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 of the attribute.

Returns:
attribute value

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