Back to index

salome-kernel  6.5.0
Classes | Public Member Functions
SALOMEDS::AttributeParameter Interface Reference

Parameter attribute. More...

import "SALOMEDS_Attributes.idl";

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

List of all members.

Classes

exception  InvalidIdentifier
 This exception is raised when an invalid identifier is passed as parameter. More...

Public Member Functions

void SetInt (in string ID, in long value)
 Associates integer value with the unique identifier.
long GetInt (in string ID) raises (InvalidIdentifier)
 Returns integer value associated with the specified identifier.
void SetReal (in string ID, in double value)
 Associates real value with the unique identifier.
double GetReal (in string ID) raises (InvalidIdentifier)
 Returns real value associated with the specified identifier.
void SetString (in string ID, in string value)
 Associates string value with the unique identifier.
string GetString (in string ID) raises (InvalidIdentifier)
 Returns string value associated with the specified identifier.
void SetBool (in string ID, in boolean value)
 Associates boolean value with the unique identifier.
boolean GetBool (in string ID) raises (InvalidIdentifier)
 Returns boolean value associated with the specified identifier.
void SetRealArray (in string ID, in DoubleSeq value)
 Associates real array value with the unique identifier.
DoubleSeq GetRealArray (in string ID) raises (InvalidIdentifier)
 Returns real array value associated with the specified identifier.
void SetIntArray (in string ID, in LongSeq value)
 Associates integer array value with the unique identifier.
LongSeq GetIntArray (in string ID) raises (InvalidIdentifier)
 Returns integer array value associated with the specified identifier.
void SetStrArray (in string ID, in StringSeq value)
 Associates string array value with the unique identifier.
StringSeq GetStrArray (in string ID) raises (InvalidIdentifier)
 Returns string array value associated with the specified identifier.
boolean IsSet (in string ID, in long ptype)
 Checks if the value of specified type is set for the identifier.
boolean RemoveID (in string ID, in long ptype)
 Removes value of specified type from the named parameter.
AttributeParameter GetFather ()
 Returns a father attribute of this attribute.
boolean HasFather ()
 Check if this attribute has parent parameter attribute.
boolean IsRoot ()
 Check if this attribute is a root (top-level) parameter attribute.
void Clear ()
 Clears the content of the attribute.
StringSeq GetIDs (in long ptype)
 Returns a sequence of parameters identifiers of the specified type stored in the attribute.
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

Parameter attribute.

This attribute is a universal container of arbitrary data of basic types (integer, real, string, array, etc).

Each parameter is identified by the unique name. Only one value of the specific type can be assigned to the parameter, though it is allowed to assign values of different types to the same name.

Definition at line 1695 of file SALOMEDS_Attributes.idl.


Class Documentation

exception SALOMEDS::AttributeParameter::InvalidIdentifier

This exception is raised when an invalid identifier is passed as parameter.

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

Clears the content of the attribute.

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

Obsolete, left for compatibility reasons only.

Use UnRegister() instead.

boolean SALOMEDS::AttributeParameter::GetBool ( in string  ID) raises (InvalidIdentifier)

Returns boolean value associated with the specified identifier.

Raises an exception if boolean parameter is not set for the specified parameter.

Parameters:
IDparameter name
Returns:
boolean value assigned to the parameter

Get the class type.

Returns a father attribute of this attribute.

Returns:
father parameter attribute

Returns a sequence of parameters identifiers of the specified type stored in the attribute.

Parameters:
ptypeparameter type [0(integer), 1(real), 2(boolean), 3(string), 4(real array), 5(integer array), 6(string array)]
Returns:
list of parameters identifier

Returns integer value associated with the specified identifier.

Raises an exception if integer parameter is not set for the specified parameter.

Parameters:
IDparameter name
Returns:
integer value assigned to the parameter

Returns integer array value associated with the specified identifier.

Raises an exception if integer array parameter is not set for the specified parameter.

Parameters:
IDparameter name
Returns:
integer array value assigned to the parameter
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
double SALOMEDS::AttributeParameter::GetReal ( in string  ID) raises (InvalidIdentifier)

Returns real value associated with the specified identifier.

Raises an exception if real parameter is not set for the specified parameter.

Parameters:
IDparameter name
Returns:
real value assigned to the parameter

Returns real array value associated with the specified identifier.

Raises an exception if real array parameter is not set for the specified parameter.

Parameters:
IDparameter name
Returns:
real array value assigned to the parameter

Get SObject.

Returns string array value associated with the specified identifier.

Raises an exception if string array parameter is not set for the specified parameter.

Parameters:
IDparameter name
Returns:
string array value assigned to the parameter

Returns string value associated with the specified identifier.

Raises an exception if string parameter is not set for the specified parameter.

Parameters:
IDparameter name
Returns:
string value assigned to the parameter

Check if this attribute has parent parameter attribute.

Returns:
true if this attribute has parent parameter attribute

Check if this attribute is a root (top-level) parameter attribute.

Returns:
true if this attribute is a root parameter attribute
boolean SALOMEDS::AttributeParameter::IsSet ( in string  ID,
in long  ptype 
)

Checks if the value of specified type is set for the identifier.

Parameters:
IDparameter name
ptypeparameter type [0(integer), 1(real), 2(boolean), 3(string), 4(real array), 5(integer array), 6(string array)]
Returns:
true if the value of type ptype is associated with the parameter ID
void SALOME::GenericObj::Register ( ) [inherited]

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

boolean SALOMEDS::AttributeParameter::RemoveID ( in string  ID,
in long  ptype 
)

Removes value of specified type from the named parameter.

Parameters:
IDparameter name
ptypeparameter type [0(integer), 1(real), 2(boolean), 3(string), 4(real array), 5(integer array), 6(string array)]
Returns:
true if value is successfully removed or false otherwise
void SALOMEDS::AttributeParameter::SetBool ( in string  ID,
in boolean  value 
)

Associates boolean value with the unique identifier.

Parameters:
IDparameter name
valueparameter value
void SALOMEDS::AttributeParameter::SetInt ( in string  ID,
in long  value 
)

Associates integer value with the unique identifier.

Parameters:
IDparameter name
valueparameter value
void SALOMEDS::AttributeParameter::SetIntArray ( in string  ID,
in LongSeq  value 
)

Associates integer array value with the unique identifier.

Parameters:
IDparameter name
valueparameter value
void SALOMEDS::AttributeParameter::SetReal ( in string  ID,
in double  value 
)

Associates real value with the unique identifier.

Parameters:
IDparameter name
valueparameter value
void SALOMEDS::AttributeParameter::SetRealArray ( in string  ID,
in DoubleSeq  value 
)

Associates real array value with the unique identifier.

Parameters:
IDparameter name
valueparameter value
void SALOMEDS::AttributeParameter::SetStrArray ( in string  ID,
in StringSeq  value 
)

Associates string array value with the unique identifier.

Parameters:
IDparameter name
valueparameter value
void SALOMEDS::AttributeParameter::SetString ( in string  ID,
in string  value 
)

Associates string value with the unique identifier.

Parameters:
IDparameter name
valueparameter value
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: