Back to index

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

Study properties attribute More...

import "SALOMEDS_Attributes.idl";

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

List of all members.

Public Member Functions

void SetUserName (in string author)
 Sets the name of the study author to the attribute.
string GetUserName ()
 Returns the name of the study author.
void SetCreationDate (in long minute, in long hour, in long day, in long month, in long year)
 Sets creation date of the study.
boolean GetCreationDate (out long minute, out long hour, out long day, out long month, out long year)
 Returns creation date of the study.
void SetCreationMode (in string mode)
 Sets creation mode of the study.
string GetCreationMode ()
 Returns creation mode of the study.
void SetModified (in long modified)
 Sets the number of transactions executed after the last saving of the study.
boolean IsModified ()
 Check if study has been modified since last saving operation.
long GetModified ()
 Returns the number of transactions executed after the last saving of the study.
void SetLocked (in boolean lock)
 Lock/unlock the study for modifications.
boolean IsLocked ()
 Check if study is locked.
void SetModification (in string author, in long minute, in long hour, in long day, in long month, in long year)
 Appends modification record to the list of study modifications.
void GetModificationsList (out StringSeq authors, out LongSeq minutes, out LongSeq hours, out LongSeq days, out LongSeq months, out LongSeq years, in boolean withCreator)
 Returns list of all the study modification records.
void SetComment (in string comment)
 Sets the comment of the study.
string GetComment ()
 Returns comment of the study.
void SetUnits (in string units)
 Sets the units of the study.
string GetUnits ()
 Returns units of the study.
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

Study properties attribute

This attribute is used to store study properties: user name, creation date, creation mode, modified flag, locked flag.

See example20 for an example of usage of this attribute in batchmode of SALOME application.

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

Get the class type.

Returns comment of the study.

Returns:
comment
boolean SALOMEDS::AttributeStudyProperties::GetCreationDate ( out long  minute,
out long  hour,
out long  day,
out long  month,
out long  year 
)

Returns creation date of the study.

Parameters:
minuteused to return minutes part of the date (undefined if creation date is not set)
hourused to return hour part of the date (undefined if creation date is not set)
dayused to return day number part of the date (undefined if creation date is not set)
monthused to return month part of the date (undefined if creation date is not set)
yearused to return year part of the date (undefined if creation date is not set)
Returns:
true if creation date is set or false otherwise

Returns creation mode of the study.

The following values are allowed for creation mode: "from scratch", "copy from", empty string (if not set).

Returns:
creation mode description
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
void SALOMEDS::AttributeStudyProperties::GetModificationsList ( out StringSeq  authors,
out LongSeq  minutes,
out LongSeq  hours,
out LongSeq  days,
out LongSeq  months,
out LongSeq  years,
in boolean  withCreator 
)

Returns list of all the study modification records.

Parameters:
authorsused to return authors of the modification records
minutesused to return minutes parts of the modification records
hoursused to return hour parts of the modification records
daysused to return day number parts of the modification records
monthsused to return month parts of the modification records
yearsused to return year parts of the modification records
withCreatortrue if creation record should be also added to the resulting list or false otherwise

Returns the number of transactions executed after the last saving of the study.

Returns:
transaction count

Get SObject.

Returns units of the study.

Returns:
units

Returns the name of the study author.

Returns:
study author name (empty string if not set)

Check if study is locked.

Returns:
true if study is locked or false otherwise

Check if study has been modified since last saving operation.

Returns:
true, if the study has been modified and not saved or false otherwise
void SALOME::GenericObj::Register ( ) [inherited]

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

Sets the comment of the study.

Parameters:
commentcomment of the study.
void SALOMEDS::AttributeStudyProperties::SetCreationDate ( in long  minute,
in long  hour,
in long  day,
in long  month,
in long  year 
)

Sets creation date of the study.

Parameters:
minuteminutes part of the date
hourhour part of the date
dayday number part of the date
monthmonth part of the date
yearyear part of the date

Sets creation mode of the study.

Note:
Creation mode must be either "from scratch" or "copy from".
Parameters:
modecreation mode description

Lock/unlock the study for modifications.

Note:
This parameter is not recursive.
If the study is locked, any attempt to modify study contents leads to the raising of the LockProtection exception.
Parameters:
locktrue if study should be locked or false if study should be unlocked
void SALOMEDS::AttributeStudyProperties::SetModification ( in string  author,
in long  minute,
in long  hour,
in long  day,
in long  month,
in long  year 
)

Appends modification record to the list of study modifications.

Parameters:
authorauthor of the modification
minuteminutes part of the modification date
hourhour part of the modification date
dayday number part of the modification date
monthmonth part of the modification date
yearyear part of the modification date

Sets the number of transactions executed after the last saving of the study.

Parameters:
modifiedtransaction count

Sets the units of the study.

Parameters:
unitsunits of the study.

Sets the name of the study author to the attribute.

Parameters:
authorstudy author name
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: