Back to index

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

Python object attribute. More...

import "SALOMEDS_Attributes.idl";

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

List of all members.

Public Member Functions

void SetObject (in string pyObject, in boolean isScript)
 Sets a Python object converted into a sequence of characters to the attribute.
string GetObject ()
 Returns a Python object stored in the attribute as a sequence of characters.
boolean IsScript ()
 Check if the value stored in the attribute is a Python script.
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

Python object attribute.

This attribute is used to store pyton objects as a sequence of characters.

Definition at line 1662 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

Returns a Python object stored in the attribute as a sequence of characters.

Returns:
encoded Python object stored in the attribute (empty string if not set)

Get SObject.

Check if the value stored in the attribute is a Python script.

Returns:
true if the sequence of characters stored in the attribute corresponds to a Python script or false otherwise
void SALOME::GenericObj::Register ( ) [inherited]

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

void SALOMEDS::AttributePythonObject::SetObject ( in string  pyObject,
in boolean  isScript 
)

Sets a Python object converted into a sequence of characters to the attribute.

Parameters:
pyObjectsequence of characters representing the encoded Python object
isScriptif true, the pyObject parameter specifies a Python script
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:


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