AttributeStudyProperties interface More...
Public Member Functions | |
void | SetUserName (in string theName) |
string | GetUserName () |
void | SetCreationDate (in long theMinute, in long theHour, in long theDay, in long theMonth, in long theYear) |
boolean | GetCreationDate (out long theMinute, out long theHour, out long theDay, out long theMonth, out long theYear) |
void | SetCreationMode (in string theMode) |
string | GetCreationMode () |
void | SetModified (in long theModified) |
boolean | IsModified () |
long | GetModified () |
void | SetLocked (in boolean theLocked) |
boolean | IsLocked () |
void | SetModification (in string theName, in long theMinute, in long theHour, in long theDay, in long theMonth, in long theYear) |
void | GetModificationsList (out StringSeq theNames, out LongSeq theMinutes, out LongSeq theHours, out LongSeq theDays, out LongSeq theMonths, out LongSeq theYears, in boolean theWithCreator) |
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). |
AttributeStudyProperties interface
This attribute allows to store study properties: user name, creation date, creation mode, modified flag, locked flag. See example20 for an example of usage of these methods in batchmode of SALOME application.
void SALOMEDS::AttributeStudyProperties::SetUserName | ( | in string | theName | ) |
Sets the name of the author of the Study
string SALOMEDS::AttributeStudyProperties::GetUserName | ( | ) |
Returns the name of the user of the Study.
void SALOMEDS::AttributeStudyProperties::SetCreationDate | ( | in long | theMinute, | |
in long | theHour, | |||
in long | theDay, | |||
in long | theMonth, | |||
in long | theYear | |||
) |
Sets creation date of the Study.
boolean SALOMEDS::AttributeStudyProperties::GetCreationDate | ( | out long | theMinute, | |
out long | theHour, | |||
out long | theDay, | |||
out long | theMonth, | |||
out long | theYear | |||
) |
Returns creation date of the Study and True if creation date is set.
void SALOMEDS::AttributeStudyProperties::SetCreationMode | ( | in string | theMode | ) |
Sets creation mode of the Study.
string SALOMEDS::AttributeStudyProperties::GetCreationMode | ( | ) |
Returns creation mode: "from scratch", "copy from", or null string if creation mode is not set
void SALOMEDS::AttributeStudyProperties::SetModified | ( | in long | theModified | ) |
Sets the number of transactions executed after the last saving of the document.
boolean SALOMEDS::AttributeStudyProperties::IsModified | ( | ) |
Returns True, if the document has been modified and not saved.
long SALOMEDS::AttributeStudyProperties::GetModified | ( | ) |
Returns the number of transactions executed after the last saving of the document.
void SALOMEDS::AttributeStudyProperties::SetLocked | ( | in boolean | theLocked | ) |
Sets the document locked for modifications if theLocked is True.
boolean SALOMEDS::AttributeStudyProperties::IsLocked | ( | ) |
Returns True if the document is locked for modifications.
void SALOMEDS::AttributeStudyProperties::SetModification | ( | in string | theName, | |
in long | theMinute, | |||
in long | theHour, | |||
in long | theDay, | |||
in long | theMonth, | |||
in long | theYear | |||
) |
Appends modification parameters to the modifications list.
void SALOMEDS::AttributeStudyProperties::GetModificationsList | ( | out StringSeq | theNames, | |
out LongSeq | theMinutes, | |||
out LongSeq | theHours, | |||
out LongSeq | theDays, | |||
out LongSeq | theMonths, | |||
out LongSeq | theYears, | |||
in boolean | theWithCreator | |||
) |
Returns a list of mosdifiers user names, modification dates. /note
If theWithCreator is True, then the output list will also contain the name of the author and the date of creation.
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.
long long SALOMEDS::GenericAttribute::GetLocalImpl | ( | in string | theHostname, | |
in long | thePID, | |||
out boolean | isLocal | |||
) | [inherited] |
Private method, returns an implementation of this GenericAttribute.
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).