Back to index

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

Flags attribute. More...

import "SALOMEDS_Attributes.idl";

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

List of all members.

Public Member Functions

long GetFlags ()
 Returns the value of the attribute.
void SetFlags (in long flags)
 Sets the value of the attribute.
boolean Get (in long flags)
 Test the value for the specified flag or set of flags.
void Set (in long flags, in boolean value)
 Set/clear specific flag or set of flags.
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

Flags attribute.

The interface is intended for storing different object attributes that have only two states: 0 (false) or 1 (true).

Note:
The interpretation of the flag values attribute is a matter of the user.
The total number of flags which can be stored in a single attribute is defined by the size of CORBA::Long data type.

Definition at line 491 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.

boolean SALOMEDS::AttributeFlags::Get ( in long  flags)

Test the value for the specified flag or set of flags.

Parameters:
flagsflag or set of flags being tested.
Returns:
true if all bits correspoding to the flags are currently set or false otherwise

Get the class type.

Returns the value of the attribute.

Returns:
set of flags currently set to the attribute
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

Get SObject.

void SALOME::GenericObj::Register ( ) [inherited]

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

void SALOMEDS::AttributeFlags::Set ( in long  flags,
in boolean  value 
)

Set/clear specific flag or set of flags.

Parameters:
flagsflag or set of flags being set / cleared
valuetrue if all bits correspoding to the flags should be set or false if flag(s) should be cleared
void SALOMEDS::AttributeFlags::SetFlags ( in long  flags)

Sets the value of the attribute.

Parameters:
flagsnew set of flags to be stored in the attribute
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: