SALOMEDS::AttributePythonObject Interface Reference

Python object attribute. More...

import "SALOMEDS_Attributes.idl";

Inheritance diagram for SALOMEDS::AttributePythonObject:

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

Detailed Description

Python object attribute.

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

Member Function Documentation

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.

void SALOME::GenericObj::Destroy ( )

inherited

Obsolete, left for compatibility reasons only.

Use UnRegister() instead.

string SALOMEDS::GenericAttribute::GetClassType ( )

inherited

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

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

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)

SObject SALOMEDS::GenericAttribute::GetSObject ( )

inherited

Get SObject.

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

pyObject	sequence of characters representing the encoded Python object
isScript	if 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).