SALOMEDS::AttributeParameter Interface Reference
AttributeParameter interface
More...
Public Member Functions |
void | SetInt (in string theID, in long theValue) |
long | GetInt (in string theID) |
void | SetReal (in string theID, in double theValue) |
double | GetReal (in string theID) |
void | SetString (in string theID, in string theValue) |
string | GetString (in string theID) |
void | SetBool (in string theID, in boolean theValue) |
boolean | GetBool (in string theID) |
void | SetRealArray (in string theID, in DoubleSeq theArray) |
DoubleSeq | GetRealArray (in string theID) |
void | SetIntArray (in string theID, in LongSeq theArray) |
LongSeq | GetIntArray (in string theID) |
void | SetStrArray (in string theID, in StringSeq theArray) |
StringSeq | GetStrArray (in string theID) |
boolean | IsSet (in string theID, in long theType) |
boolean | RemoveID (in string theID, in long theType) |
AttributeParameter | GetFather () |
boolean | HasFather () |
boolean | IsRoot () |
void | Clear () |
StringSeq | GetIDs (in long theType) |
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
AttributeParameter interface
Attribute is a universal container of basic types
Member Function Documentation
void SALOMEDS::AttributeParameter::SetInt |
( |
in string |
theID, |
|
|
in long |
theValue | |
|
) |
| | |
Associates a integer value with the ID
- Parameters:
-
| theID | An ID of a parameter. |
| theValue | A value of the parameter |
long SALOMEDS::AttributeParameter::GetInt |
( |
in string |
theID |
) |
|
Returns a int value associated with the given ID
- Parameters:
-
| theID | An ID of a parameter. |
void SALOMEDS::AttributeParameter::SetReal |
( |
in string |
theID, |
|
|
in double |
theValue | |
|
) |
| | |
Associates a real value with the ID
- Parameters:
-
| theID | An ID of a parameter. |
| theValue | A value of the parameter |
double SALOMEDS::AttributeParameter::GetReal |
( |
in string |
theID |
) |
|
Returns a real value associated with the given ID
- Parameters:
-
| theID | An ID of a parameter. |
void SALOMEDS::AttributeParameter::SetString |
( |
in string |
theID, |
|
|
in string |
theValue | |
|
) |
| | |
Associates a string value with the ID
- Parameters:
-
| theID | An ID of a parameter. |
| theValue | A value of the parameter |
string SALOMEDS::AttributeParameter::GetString |
( |
in string |
theID |
) |
|
Returns a string value associated with the given ID
- Parameters:
-
| theID | An ID of a parameter. |
void SALOMEDS::AttributeParameter::SetBool |
( |
in string |
theID, |
|
|
in boolean |
theValue | |
|
) |
| | |
Associates a boolean value with the ID
- Parameters:
-
| theID | An ID of a parameter. |
| theValue | A value of the parameter |
boolean SALOMEDS::AttributeParameter::GetBool |
( |
in string |
theID |
) |
|
Returns a boolean value associated with the given ID
- Parameters:
-
| theID | An ID of a parameter. |
void SALOMEDS::AttributeParameter::SetRealArray |
( |
in string |
theID, |
|
|
in DoubleSeq |
theArray | |
|
) |
| | |
Associates an array of real values with the ID
- Parameters:
-
| theID | An ID of a parameter. |
| theArray | The array of real values |
DoubleSeq SALOMEDS::AttributeParameter::GetRealArray |
( |
in string |
theID |
) |
|
Returns an array of real values associated with the ID
- Parameters:
-
| theID | An ID of a parameter. |
void SALOMEDS::AttributeParameter::SetIntArray |
( |
in string |
theID, |
|
|
in LongSeq |
theArray | |
|
) |
| | |
Associates an array of integer values with the ID
- Parameters:
-
| theID | An ID of a parameter. |
| theArray | The array of integer values |
LongSeq SALOMEDS::AttributeParameter::GetIntArray |
( |
in string |
theID |
) |
|
Returns an array of integer values associated with the ID
- Parameters:
-
| theID | An ID of a parameter. |
void SALOMEDS::AttributeParameter::SetStrArray |
( |
in string |
theID, |
|
|
in StringSeq |
theArray | |
|
) |
| | |
Associates an array of string values with the ID
- Parameters:
-
| theID | An ID of a parameter. |
| theArray | The array of string values |
StringSeq SALOMEDS::AttributeParameter::GetStrArray |
( |
in string |
theID |
) |
|
Returns an array of string values associated with the ID
- Parameters:
-
| theID | An ID of a parameter. |
boolean SALOMEDS::AttributeParameter::IsSet |
( |
in string |
theID, |
|
|
in long |
theType | |
|
) |
| | |
Returns True if for the ID of given type was assigned a value in the attribute
- Parameters:
-
| theID | An ID of a parameter. |
| theType | A type of parameter [0(Int), 1(Real), 2(Boolean), 3(String), 4(RealArray), 5(IntArray), 6(StrArray)]. |
boolean SALOMEDS::AttributeParameter::RemoveID |
( |
in string |
theID, |
|
|
in long |
theType | |
|
) |
| | |
Removes a parameter with given ID and Type, returns True if succeded
- Parameters:
-
| theID | An ID of a parameter. |
| theType | A type of parameter [0(Int), 1(Real), 2(Boolean), 3(String), 4(RealArray), 5(IntArray), 6(StrArray)]. |
Returns a father attribute of this attribute
boolean SALOMEDS::AttributeParameter::HasFather |
( |
|
) |
|
Returns True if this attribute has a father attribute
boolean SALOMEDS::AttributeParameter::IsRoot |
( |
|
) |
|
Returns True if this attribute is a root attribute
void SALOMEDS::AttributeParameter::Clear |
( |
|
) |
|
Clears the content of the attribute
StringSeq SALOMEDS::AttributeParameter::GetIDs |
( |
in long |
theType |
) |
|
Returns a sequence of ID's of the give type
- Parameters:
-
| theType | A type of parameter [0(Int), 1(Real), 2(Boolean), 3(String), 4(RealArray), 5(IntArray), 6(StrArray)]. |
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] |
string SALOMEDS::GenericAttribute::GetClassType |
( |
|
) |
[inherited] |
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::Destroy |
( |
|
) |
[inherited] |
Decrease the reference count (release by another object).