Flags attribute. More...

Inheritance diagram for SALOMEDS::AttributeFlags:

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. Use UnRegister() instead.

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.

Member Function Documentation

long SALOMEDS::AttributeFlags::GetFlags ( )

Returns the value of the attribute.

void SALOMEDS::AttributeFlags::SetFlags ( in long flags )

Sets the value of the attribute.

Parameters:

flags new set of flags to be stored in the attribute

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

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

Parameters:

flags flag or set of flags being tested.

Returns:: true if all bits correspoding to the flags are currently set or false otherwise

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

Set/clear specific flag or set of flags.

Parameters:

flags	flag or set of flags being set / cleared
value	`true` if all bits correspoding to the flags should be set or `false` if flag(s) should be cleared

void SALOMEDS::GenericAttribute::CheckLocked ( ) raises (LockProtection) [inherited]

Method CheckLocked.

Checks whether the Study is protected for modifications.

string SALOMEDS::GenericAttribute::Type ( ) [inherited]

Get Type.

string SALOMEDS::GenericAttribute::GetClassType ( ) [inherited]

Get the class type.

SObject SALOMEDS::GenericAttribute::GetSObject ( ) [inherited]

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

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.