SALOMEDS::AttributeComment Interface Reference

Comment attribute. More...

import"SALOMEDS_Attributes.idl";

Inheritance diagram for SALOMEDS::AttributeComment:

Public Member Functions
string	Value ()
	Returns the value of the attribute. More...
void	SetValue (in string value)
	Sets the value of the attribute (description of a SObject). More...
void	CheckLocked () raises (LockProtection)
	Method CheckLocked. More...
string	Type ()
	Get Type. More...
string	GetClassType ()
	Get the class type. More...
SObject	GetSObject ()
	Get SObject. More...
long long	GetLocalImpl (in string theHostname, in long thePID, out boolean isLocal)
	Private method, returns an implementation of this GenericAttribute. More...
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. More...

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

Member Function Documentation

CheckLocked()

void SALOMEDS::GenericAttribute::CheckLocked ( ) raises ( LockProtection )

inherited

Method CheckLocked.

Checks whether the Study is protected for modifications.

Note

This exception is raised only outside a transaction.

Destroy()

void SALOME::GenericObj::Destroy ( )

inherited

Obsolete, left for compatibility reasons only.

Use UnRegister() instead.

GetClassType()

string SALOMEDS::GenericAttribute::GetClassType ( )

inherited

Get the class type.

GetLocalImpl()

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

inherited

Private method, returns an implementation of this GenericAttribute.

Parameters

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

GetSObject()

SObject SALOMEDS::GenericAttribute::GetSObject ( )

inherited

Get SObject.

Register()

void SALOME::GenericObj::Register ( )

inherited

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

SetValue()

void SALOMEDS::AttributeComment::SetValue

(

in string

value

)

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

Parameters

value

value being set to the attribute

Type()

string SALOMEDS::GenericAttribute::Type ( )

inherited

Get Type.

UnRegister()

void SALOME::GenericObj::UnRegister ( )

inherited

Decrease the reference count (release by another object).

Referenced by SALOME_PyNode.Generic::Destroy().

Value()

string SALOMEDS::AttributeComment::Value

(

)

Returns the value of the attribute.

Returns

attribute value