Version: 8.3.0
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
SALOMEDS::AttributePythonObject Interface Reference

Python object attribute. More...

Inheritance diagram for SALOMEDS::AttributePythonObject:
Inheritance graph

Public Member Functions

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

Detailed Description

Python object attribute.

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

Member Function Documentation

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::AttributePythonObject::GetObject ( )

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)
boolean SALOMEDS::AttributePythonObject::IsScript ( )

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 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.
string SALOMEDS::GenericAttribute::Type ( )
inherited

Get Type.

string SALOMEDS::GenericAttribute::GetClassType ( )
inherited

Get the class type.

SObject SALOMEDS::GenericAttribute::GetSObject ( )
inherited

Get SObject.

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
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.