Study properties attribute More...

Inheritance diagram for SALOMEDS::AttributeStudyProperties:

Public Member Functions
void	SetUserName (in string author)
	Sets the name of the study author to the attribute. More...

string	GetUserName ()
	Returns the name of the study author. More...

void	SetCreationDate (in long minute, in long hour, in long day, in long month, in long year)
	Sets creation date of the study. More...

boolean	GetCreationDate (out long minute, out long hour, out long day, out long month, out long year)
	Returns creation date of the study. More...

void	SetCreationMode (in string mode)
	Sets creation mode of the study. More...

string	GetCreationMode ()
	Returns creation mode of the study. More...

void	SetModified (in long modified)
	Sets the number of transactions executed after the last saving of the study. More...

boolean	IsModified ()
	Check if study has been modified since last saving operation. More...

long	GetModified ()
	Returns the number of transactions executed after the last saving of the study. More...

void	SetLocked (in boolean lock)
	Lock/unlock the study for modifications. More...

boolean	IsLocked ()
	Check if study is locked. More...

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. More...

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. More...

void	SetComment (in string comment)
	Sets the comment of the study. More...

string	GetComment ()
	Returns comment of the study. More...

void	SetUnits (in string units)
	Sets the units of the study. More...

string	GetUnits ()
	Returns units of the study. More...

StringSeq	GetStoredComponents ()
	Returns list of components which data was stored (after previous sessions) in the study. More...

string	GetComponentVersion (in string comp)
	Returns version of component data stored in the study. More...

StringSeq	GetComponentVersions (in string comp)
	Returns all versions of component data stored in the study. More...

void	CheckLocked () raises (LockProtection)
	Method CheckLocked. More...

string	Type ()
	Get Type. More...

string	GetClassType ()
	Get the class type. More...

SObject	GetSObject ()
	Get SObject. More...

long long	GetLocalImpl (in string theHostname, in long thePID, out boolean isLocal)
	Private method, returns an implementation of this GenericAttribute. More...

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

void	UnRegister ()
	Decrease the reference count (release by another object). More...

void	Destroy ()
	Obsolete, left for compatibility reasons only. Use UnRegister() instead. More...

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.

Member Function Documentation

void SALOMEDS::AttributeStudyProperties::SetUserName ( in string author )

Sets the name of the study author to the attribute.

Parameters

author study author name

string SALOMEDS::AttributeStudyProperties::GetUserName ( )

Returns the name of the study author.

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

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

minute	minutes part of the date
hour	hour part of the date
day	day number part of the date
month	month part of the date
year	year part of the date

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

minute	used to return minutes part of the date (undefined if creation date is not set)
hour	used to return hour part of the date (undefined if creation date is not set)
day	used to return day number part of the date (undefined if creation date is not set)
month	used to return month part of the date (undefined if creation date is not set)
year	used to return year part of the date (undefined if creation date is not set)

Returns: true if creation date is set or false otherwise

void SALOMEDS::AttributeStudyProperties::SetCreationMode ( in string mode )

Sets creation mode of the study.

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

Parameters

mode	creation mode description

string SALOMEDS::AttributeStudyProperties::GetCreationMode ( )

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

void SALOMEDS::AttributeStudyProperties::SetModified ( in long modified )

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

Parameters

modified transaction count

boolean SALOMEDS::AttributeStudyProperties::IsModified ( )

Check if study has been modified since last saving operation.

Returns: true, if the study has been modified and not saved or false otherwise

long SALOMEDS::AttributeStudyProperties::GetModified ( )

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

Returns: transaction count

void SALOMEDS::AttributeStudyProperties::SetLocked ( in boolean lock )

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

lock	`true` if study should be locked or `false` if study should be unlocked

boolean SALOMEDS::AttributeStudyProperties::IsLocked ( )

Check if study is locked.

Returns: true if study is locked or false otherwise

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

author	author of the modification
minute	minutes part of the modification date
hour	hour part of the modification date
day	day number part of the modification date
month	month part of the modification date
year	year part of the modification date

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

authors	used to return authors of the modification records
minutes	used to return minutes parts of the modification records
hours	used to return hour parts of the modification records
days	used to return day number parts of the modification records
months	used to return month parts of the modification records
years	used to return year parts of the modification records
withCreator	`true` if creation record should be also added to the resulting list or `false` otherwise

void SALOMEDS::AttributeStudyProperties::SetComment ( in string comment )

Sets the comment of the study.

Parameters

comment comment of the study.

string SALOMEDS::AttributeStudyProperties::GetComment ( )

Returns comment of the study.

Returns: comment

void SALOMEDS::AttributeStudyProperties::SetUnits ( in string units )

Sets the units of the study.

Parameters

units units of the study.

string SALOMEDS::AttributeStudyProperties::GetUnits ( )

Returns units of the study.

Returns: units

StringSeq SALOMEDS::AttributeStudyProperties::GetStoredComponents ( )

Returns list of components which data was stored (after previous sessions) in the study.

Returns: list of component names

string SALOMEDS::AttributeStudyProperties::GetComponentVersion ( in string comp )

Returns version of component data stored in the study.

Parameters

comp	component name

Returns: version of stored component data

StringSeq SALOMEDS::AttributeStudyProperties::GetComponentVersions ( in string comp )

Returns all versions of component data stored in the study.

Parameters

comp	component name

Returns: versions of stored component data

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

Get Type.

string SALOMEDS::GenericAttribute::GetClassType ( )

inherited

Get the class type.

SObject SALOMEDS::GenericAttribute::GetSObject ( )

inherited

Get SObject.

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.

Public Member Functions

Detailed Description

Member Function Documentation