SALOME documentation central

SALOMEDS::AttributeLocalID Interface Reference

LocalID attribute. More...

Inheritance diagram for SALOMEDS::AttributeLocalID:

Public Member Functions

long Value ()
void SetValue (in long value)
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 Destroy ()
 Decrease the reference count (release by another object).

Detailed Description

LocalID attribute.

Attribute describing the link between a SObject and a local object in the component.


Member Function Documentation

long SALOMEDS::AttributeLocalID::Value ( )

Returns the value of this attribute.

See example1 for an example of this method usage in batchmode of SALOME application.

void SALOMEDS::AttributeLocalID::SetValue ( in long  value)

Sets the value of this attribute.

Parameters:
valueThis parameter defines the local ID which will be set.

See example1 for an example of this method usage in batchmode of SALOME application.

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::Destroy ( ) [inherited]

Decrease the reference count (release by another object).