#include <SALOMEDS_Study_i.hxx>

Inheritance diagram for SALOMEDS_Study_i:

Public Member Functions
	SALOMEDS_Study_i (SALOMEDSImpl_Study *, CORBA::ORB_ptr)
	standard constructor More...

virtual	~SALOMEDS_Study_i ()
	standard destructor More...

virtual char *	GetPersistentReference ()
	method to Get persistent reference of study (idem URL()) More...

virtual char *	GetTransientReference ()
	method to Get transient reference of study More...

virtual CORBA::Boolean	IsEmpty ()
	method to detect if a study is empty More...

virtual SALOMEDS::SComponent_ptr	FindComponent (const char *aComponentName)
	method to Find a Component with ComponentDataType = aComponentName More...

virtual SALOMEDS::SComponent_ptr	FindComponentID (const char *aComponentID)
	method to Find a Component Find a Component from it's ID More...

virtual SALOMEDS::SObject_ptr	FindObject (const char *anObjectName)
	method to Find an Object with SALOMEDS::Name = anObjectName More...

virtual SALOMEDS::Study::ListOfSObject *	FindObjectByName (const char anObjectName, const char aComponentName)
	method to Find Object(s) with SALOMEDS::Name = anObjectName in a component with ComponentDataType = aComponentName More...

virtual SALOMEDS::SObject_ptr	FindObjectID (const char *anObjectID)
	method to Find an Object with ID = anObjectID More...

virtual SALOMEDS::SObject_ptr	CreateObjectID (const char *anObjectID)
	method to Create an Object with ID = anObjectID More...

virtual SALOMEDS::SObject_ptr	FindObjectIOR (const char *anObjectIOR)
	method to Find an Object with ID = anObjectIOR More...

virtual SALOMEDS::SObject_ptr	FindObjectByPath (const char *thePath)
	method to Find an Object by its path More...

virtual char *	GetObjectPath (CORBA::Object_ptr theObject)
	method to get a path of SObject More...

virtual void	SetContext (const char *thePath)
	method to set a context: root ('/') is UserData component More...

virtual char *	GetContext ()
	method to get a context More...

virtual SALOMEDS::ListOfStrings *	GetObjectNames (const char *theContext)
	method to get all object names in the given context (or in the current context, if 'theContext' is empty) More...

virtual SALOMEDS::ListOfStrings *	GetDirectoryNames (const char *theContext)
	method to get all directory names in the given context (or in the current context, if 'theContext' is empty) More...

virtual SALOMEDS::ListOfStrings *	GetFileNames (const char *theContext)
	method to get all file names in the given context (or in the current context, if 'theContext' is empty) More...

virtual SALOMEDS::ListOfStrings *	GetComponentNames (const char *theContext)
	method to get all components names More...

virtual SALOMEDS::ChildIterator_ptr	NewChildIterator (SALOMEDS::SObject_ptr aSO)
	method to Create a ChildIterator from an SObject More...

virtual SALOMEDS::SComponentIterator_ptr	NewComponentIterator ()
	method to Create a SComponentIterator More...

virtual SALOMEDS::StudyBuilder_ptr	NewBuilder ()
	method to Create a StudyBuilder More...

virtual char *	Name ()
	method to get study name More...

virtual void	Name (const char *name)
	method to set study name More...

virtual CORBA::Boolean	IsSaved ()
	method to get if study has been saved More...

virtual void	IsSaved (CORBA::Boolean save)
	method to set if study has been saved More...

virtual CORBA::Boolean	IsModified ()
	method to Detect if a Study has been modified since it has been saved More...

virtual void	Modified ()
	method to set Modified flag of a Study to True More...

virtual char *	URL ()
	method to get URL of the study (idem GetPersistentReference) More...

virtual void	URL (const char *url)
	method to set URL of the study More...

virtual CORBA::Short	StudyId ()

virtual void	StudyId (CORBA::Short id)

virtual void	UpdateIORLabelMap (const char anIOR, const char aLabel)

virtual SALOMEDS::Study::ListOfSObject *	FindDependances (SALOMEDS::SObject_ptr anObject)

virtual SALOMEDS::AttributeStudyProperties_ptr	GetProperties ()

virtual char *	GetLastModificationDate ()

virtual SALOMEDS::ListOfDates *	GetModificationsDate ()

virtual char *	ConvertObjectToIOR (CORBA::Object_ptr theObject)

virtual CORBA::Object_ptr	ConvertIORToObject (const char *theIOR)

virtual SALOMEDS::UseCaseBuilder_ptr	GetUseCaseBuilder ()
	Function : GetUseCaseBuilder Purpose : Returns a UseCase builder. More...

virtual void	Close ()
	Function : Close Purpose : More...

void	EnableUseCaseAutoFilling (CORBA::Boolean isEnabled)
	Function : EnableUseCaseAutoFilling Purpose : More...

virtual void	AddPostponed (const char *theIOR)
	Function : AddPostponed Purpose : More...

virtual void	AddCreatedPostponed (const char *theIOR)

virtual void	RemovePostponed (CORBA::Long theUndoLimit)
	Function : RemovePostponed Purpose : More...

virtual void	UndoPostponed (CORBA::Long theWay)
	Function : UndoPostponed Purpose : More...

virtual SALOMEDS::AttributeParameter_ptr	GetCommonParameters (const char *theID, CORBA::Long theSavePoint)
	Function : GetCommonParameters Purpose : More...

virtual SALOMEDS::AttributeParameter_ptr	GetModuleParameters (const char theID, const char theModuleName, CORBA::Long theSavePoint)
	Function : GetCommonModuleParameters Purpose : More...

virtual void	SetStudyLock (const char *theLockerID)
	Function : SetStudyLock Purpose : More...

virtual bool	IsStudyLocked ()
	Function : IsStudyLocked Purpose : More...

virtual void	UnLockStudy (const char *theLockerID)
	Function : UnLockStudy Purpose : More...

virtual SALOMEDS::ListOfStrings *	GetLockerID ()
	Function : GetLockerID Purpose : More...

virtual void	SetReal (const char *theVarName, CORBA::Double theValue)
	Function : SetReal Purpose : More...

virtual void	SetInteger (const char *theVarName, CORBA::Long theValue)
	Function : SetInteger Purpose : More...

virtual void	SetBoolean (const char *theVarName, CORBA::Boolean theValue)
	Function : SetBoolean Purpose : More...

virtual void	SetString (const char theVarName, const char theValue)
	Function : SetString Purpose : More...

virtual void	SetStringAsDouble (const char *theVarName, CORBA::Double theValue)
	Function : SetStringAsDouble Purpose : More...

virtual CORBA::Double	GetReal (const char *theVarName)
	Function : GetReal Purpose : More...

virtual CORBA::Long	GetInteger (const char *theVarName)
	Function : GetInteger Purpose : More...

virtual CORBA::Boolean	GetBoolean (const char *theVarName)
	Function : GetBoolean Purpose : More...

virtual char *	GetString (const char *theVarName)
	Function : GetString Purpose : More...

virtual CORBA::Boolean	IsReal (const char *theVarName)
	Function : IsReal Purpose : More...

virtual CORBA::Boolean	IsInteger (const char *theVarName)
	Function : IsInteger Purpose : More...

virtual CORBA::Boolean	IsBoolean (const char *theVarName)
	Function : IsBoolean Purpose : More...

virtual CORBA::Boolean	IsString (const char *theVarName)
	Function : IsString Purpose : More...

virtual CORBA::Boolean	IsVariable (const char *theVarName)
	Function : IsVariable Purpose : More...

virtual SALOMEDS::ListOfStrings *	GetVariableNames ()
	Function : GetVariableNames Purpose : More...

virtual CORBA::Boolean	RemoveVariable (const char *theVarName)
	Function : RemoveVariable Purpose : More...

virtual CORBA::Boolean	RenameVariable (const char theVarName, const char theNewVarName)
	Function : RenameVariable Purpose : More...

virtual CORBA::Boolean	IsVariableUsed (const char *theVarName)
	Function : IsVariableUsed Purpose : More...

virtual SALOMEDS::ListOfListOfStrings *	ParseVariables (const char *theVars)
	Function : ParseVariables Purpose : More...

virtual char *	GetDefaultScript (const char theModuleName, const char theShift)
	Function : GetDefaultScript Purpose : More...

virtual CORBA::Boolean	DumpStudy (const char thePath, const char theBaseName, CORBA::Boolean isPublished, CORBA::Boolean isMultiFile)
	Function : DumpStudy Purpose : More...

virtual SALOMEDSImpl_Study *	GetImpl ()

virtual CORBA::LongLong	GetLocalImpl (const char *theHostname, CORBA::Long thePID, CORBA::Boolean &isLocal)

virtual void	attach (SALOMEDS::Observer_ptr theObs, CORBA::Boolean modify)
	Function : attach Purpose : This function attach an observer to the study. More...

virtual void	detach (SALOMEDS::Observer_ptr theObs)
	Function : detach Purpose : This function detaches an observer from the study. More...

Static Public Member Functions
static SALOMEDS::Study_ptr	GetStudy (const DF_Label &theLabel, CORBA::ORB_ptr orb)

static SALOMEDS_Study_i *	GetStudyServant (SALOMEDSImpl_Study *, CORBA::ORB_ptr orb)

static void	IORUpdated (SALOMEDSImpl_AttributeIOR *theAttribute)

Private Attributes
CORBA::ORB_var	_orb

SALOMEDSImpl_Study *	_impl

SALOMEDS_StudyBuilder_i *	_builder

SALOMEDSImpl_AbstractCallback *	_notifier

SALOMEDSImpl_AbstractCallback *	_genObjRegister

bool	_closed

Static Private Attributes
static std::map < SALOMEDSImpl_Study , SALOMEDS_Study_i >	_mapOfStudies

Constructor & Destructor Documentation

SALOMEDS_Study_i::SALOMEDS_Study_i	(	SALOMEDSImpl_Study *	theImpl,
		CORBA::ORB_ptr	orb
	)

standard constructor

Function : SALOMEDS_Study_i Purpose : SALOMEDS_Study_i constructor.

References _builder, _closed, _genObjRegister, _impl, _notifier, _orb, KERNEL::getNamingService(), SALOMEDS::lock(), SALOMEDSImpl_Study::NewBuilder(), SALOME_NamingService::Resolve(), SALOMEDSImpl_Study::setGenObjRegister(), SALOMEDSImpl_Study::setNotifier(), SALOMEDSImpl_Study::StudyId(), and SALOMEDS::unlock().

Referenced by GetStudyServant().

SALOMEDS_Study_i::~SALOMEDS_Study_i ( )

virtual

standard destructor

Function : ~SALOMEDS_Study_i Purpose : SALOMEDS_Study_i destructor.

References _builder, _genObjRegister, _impl, _mapOfStudies, _notifier, and SALOMEDSImpl_Study::setNotifier().

Member Function Documentation

void SALOMEDS_Study_i::AddCreatedPostponed ( const char * theIOR )

virtual

References SALOMEDS::lock().

void SALOMEDS_Study_i::AddPostponed ( const char * theIOR )

virtual

Function : AddPostponed Purpose :

References SALOMEDS::lock().

void SALOMEDS_Study_i::attach	(	SALOMEDS::Observer_ptr	theObs,
		CORBA::Boolean	modify
	)

virtual

Function : attach Purpose : This function attach an observer to the study.

References _notifier.

void SALOMEDS_Study_i::Close ( )

virtual

Function : Close Purpose :

References _closed, _impl, _orb, SALOMEDSImpl_Study::Close(), KERNEL::getNamingService(), SALOMEDS::lock(), MESSAGE, NewComponentIterator(), RemovePostponed(), SALOME_NamingService::Resolve(), SALOMEDSImpl_Study::StudyId(), and SALOMEDS::unlock().

virtual CORBA::Object_ptr SALOMEDS_Study_i::ConvertIORToObject ( const char * theIOR )

virtual

virtual char* SALOMEDS_Study_i::ConvertObjectToIOR ( CORBA::Object_ptr theObject )

virtual

SALOMEDS::SObject_ptr SALOMEDS_Study_i::CreateObjectID ( const char * anObjectID )

virtual

method to Create an Object with ID = anObjectID

Function : CreateObjectID Purpose : Creates an Object with ID = anObjectID.

Parameters

anObjectID char* arguments

Returns: SObject_ptr arguments, the object found

References _closed, _impl, _orb, SALOMEDSImpl_Study::CreateObjectID(), SALOMEDSImpl_SObject::IsNull(), SALOMEDS::lock(), and SALOMEDS_SObject_i::New().

void SALOMEDS_Study_i::detach ( SALOMEDS::Observer_ptr theObs )

virtual

Function : detach Purpose : This function detaches an observer from the study.

References _notifier.

CORBA::Boolean SALOMEDS_Study_i::DumpStudy	(	const char *	thePath,
		const char *	theBaseName,
		CORBA::Boolean	isPublished,
		CORBA::Boolean	isMultiFile
	)

virtual

Function : DumpStudy Purpose :

References _closed, _impl, _orb, SALOMEDSImpl_Study::DumpStudy(), and SALOMEDS::lock().

void SALOMEDS_Study_i::EnableUseCaseAutoFilling ( CORBA::Boolean isEnabled )

Function : EnableUseCaseAutoFilling Purpose :

References _builder, _closed, _impl, SALOMEDSImpl_Study::EnableUseCaseAutoFilling(), SALOMEDSImpl_Study::GetCallback(), SALOMEDS_StudyBuilder_i::GetImpl(), SALOMEDSImpl_StudyBuilder::SetOnAddSObject(), and SALOMEDSImpl_StudyBuilder::SetOnRemoveSObject().

SALOMEDS::SComponent_ptr SALOMEDS_Study_i::FindComponent ( const char * aComponentName )

virtual

method to Find a Component with ComponentDataType = aComponentName

Function : FindComponent Purpose : Find a Component with ComponentDataType = aComponentName.

Parameters

aComponentName char* arguments

Returns: SComponent_ptr arguments, the component found

References _closed, _impl, _orb, SALOMEDSImpl_Study::FindComponent(), SALOMEDSImpl_SObject::IsNull(), SALOMEDS::lock(), and SALOMEDS_SComponent_i::New().

SALOMEDS::SComponent_ptr SALOMEDS_Study_i::FindComponentID ( const char * aComponentID )

virtual

method to Find a Component Find a Component from it's ID

Function : FindComponentID Purpose : Find a Component from it's ID.

Parameters

aComponentID char* arguments

Returns: SComponent_ptr arguments, the component found

References _closed, _impl, _orb, SALOMEDSImpl_Study::FindComponentID(), SALOMEDSImpl_SObject::IsNull(), SALOMEDS::lock(), and SALOMEDS_SComponent_i::New().

SALOMEDS::Study::ListOfSObject * SALOMEDS_Study_i::FindDependances ( SALOMEDS::SObject_ptr anObject )

virtual

References _closed, and SALOMEDS::lock().

SALOMEDS::SObject_ptr SALOMEDS_Study_i::FindObject ( const char * anObjectName )

virtual

method to Find an Object with SALOMEDS::Name = anObjectName

Function : FindObject Purpose : Find an Object with SALOMEDS::Name = anObjectName.

Parameters

anObjectName char* arguments

Returns: SObject_ptr arguments, the object found

References _closed, _impl, _orb, SALOMEDSImpl_Study::FindObject(), SALOMEDSImpl_SObject::IsComponent(), SALOMEDSImpl_SObject::IsNull(), SALOMEDS::lock(), SALOMEDS_SComponent_i::New(), and SALOMEDS_SObject_i::New().

SALOMEDS::Study::ListOfSObject * SALOMEDS_Study_i::FindObjectByName	(	const char *	anObjectName,
		const char *	aComponentName
	)

virtual

method to Find Object(s) with SALOMEDS::Name = anObjectName in a component with ComponentDataType = aComponentName

Function : FindObjectByName Purpose : Find Objects with SALOMEDS::Name = anObjectName in a Component : with ComponentDataType = aComponentName.

Parameters

anObjectName	char* arguments
aComponentName	char* arguments

Returns: ListOfSObject_ptr arguments, a list of objects found

References _closed, _impl, _orb, SALOMEDSImpl_Study::FindObjectByName(), SALOMEDS::lock(), and SALOMEDS_SObject_i::New().

SALOMEDS::SObject_ptr SALOMEDS_Study_i::FindObjectByPath ( const char * thePath )

virtual

method to Find an Object by its path

Function : FindObjectByPath Purpose : Find an Object by its path = thePath.

Parameters

thePath char* arguments

Returns: SObject_ptr arguments, the object found

References _closed, _impl, _orb, SALOMEDSImpl_Study::FindObjectByPath(), SALOMEDSImpl_SObject::IsNull(), SALOMEDS::lock(), and SALOMEDS_SObject_i::New().

SALOMEDS::SObject_ptr SALOMEDS_Study_i::FindObjectID ( const char * anObjectID )

virtual

method to Find an Object with ID = anObjectID

Function : FindObjectID Purpose : Find an Object with ID = anObjectID.

Parameters

anObjectID char* arguments

Returns: SObject_ptr arguments, the object found

References _closed, _impl, _orb, SALOMEDSImpl_Study::FindObjectID(), SALOMEDSImpl_SObject::IsNull(), SALOMEDS::lock(), and SALOMEDS_SObject_i::New().

SALOMEDS::SObject_ptr SALOMEDS_Study_i::FindObjectIOR ( const char * anObjectIOR )

virtual

method to Find an Object with ID = anObjectIOR

Function : FindObjectIOR Purpose : Find an Object with IOR = anObjectIOR.

Parameters

anObjectIOR char* arguments

Returns: SObject_ptr arguments, the object found

References _closed, _impl, _orb, SALOMEDSImpl_Study::FindObjectIOR(), SALOMEDSImpl_SObject::IsNull(), SALOMEDS::lock(), and SALOMEDS_SObject_i::New().

CORBA::Boolean SALOMEDS_Study_i::GetBoolean ( const char * theVarName )

virtual

Function : GetBoolean Purpose :

References _closed, _impl, and SALOMEDSImpl_Study::GetVariableValue().

SALOMEDS::AttributeParameter_ptr SALOMEDS_Study_i::GetCommonParameters	(	const char *	theID,
		CORBA::Long	theSavePoint
	)

virtual

Function : GetCommonParameters Purpose :

References _closed, _impl, _orb, SALOMEDSImpl_Study::GetCommonParameters(), and SALOMEDS::lock().

SALOMEDS::ListOfStrings * SALOMEDS_Study_i::GetComponentNames ( const char * theContext )

virtual

method to get all components names

Function : GetComponentNames Purpose : method to get all components names SRN: Note, theContext can be any, it doesn't matter.

References _closed, _impl, SALOMEDSImpl_Study::GetComponentNames(), and SALOMEDS::lock().

char * SALOMEDS_Study_i::GetContext ( )

virtual

method to get a context

Function : GetContext Purpose : Gets the current context.

References _closed, _impl, SALOMEDSImpl_Study::GetContext(), SALOMEDSImpl_Study::HasCurrentContext(), and SALOMEDS::lock().

char * SALOMEDS_Study_i::GetDefaultScript	(	const char *	theModuleName,
		const char *	theShift
	)

virtual

Function : GetDefaultScript Purpose :

References _closed, _impl, SALOMEDSImpl_IParameters::getDefaultScript(), and SALOMEDS::lock().

SALOMEDS::ListOfStrings * SALOMEDS_Study_i::GetDirectoryNames ( const char * theContext )

virtual

method to get all directory names in the given context (or in the current context, if 'theContext' is empty)

Function : GetDirectoryNames Purpose : method to get all directory names in the given context (or in the current context, if 'theContext' is empty)

References _closed, _impl, SALOMEDSImpl_Study::GetDirectoryNames(), SALOMEDSImpl_Study::GetErrorCode(), SALOMEDSImpl_Study::HasCurrentContext(), and SALOMEDS::lock().

SALOMEDS::ListOfStrings * SALOMEDS_Study_i::GetFileNames ( const char * theContext )

virtual

method to get all file names in the given context (or in the current context, if 'theContext' is empty)

Function : GetFileNames Purpose : method to get all file names in the given context (or in the current context, if 'theContext' is empty)

References _closed, _impl, SALOMEDSImpl_Study::GetErrorCode(), SALOMEDSImpl_Study::GetFileNames(), SALOMEDSImpl_Study::HasCurrentContext(), and SALOMEDS::lock().

virtual SALOMEDSImpl_Study* SALOMEDS_Study_i::GetImpl ( )

virtual

CORBA::Long SALOMEDS_Study_i::GetInteger ( const char * theVarName )

virtual

Function : GetInteger Purpose :

References _closed, _impl, and SALOMEDSImpl_Study::GetVariableValue().

char * SALOMEDS_Study_i::GetLastModificationDate ( )

virtual

References _closed, _impl, SALOMEDSImpl_Study::GetLastModificationDate(), and SALOMEDS::lock().

CORBA::LongLong SALOMEDS_Study_i::GetLocalImpl	(	const char *	theHostname,
		CORBA::Long	thePID,
		CORBA::Boolean &	isLocal
	)

virtual

References _impl, and Kernel_Utils::GetHostname().

SALOMEDS::ListOfStrings * SALOMEDS_Study_i::GetLockerID ( )

virtual

Function : GetLockerID Purpose :

References _closed, _impl, SALOMEDSImpl_Study::GetLockerID(), and SALOMEDS::lock().

SALOMEDS::ListOfDates * SALOMEDS_Study_i::GetModificationsDate ( )

virtual

References _closed, _impl, SALOMEDSImpl_Study::GetModificationsDate(), and SALOMEDS::lock().

SALOMEDS::AttributeParameter_ptr SALOMEDS_Study_i::GetModuleParameters	(	const char *	theID,
		const char *	theModuleName,
		CORBA::Long	theSavePoint
	)

virtual

Function : GetCommonModuleParameters Purpose :

References _closed, _impl, _orb, SALOMEDSImpl_Study::GetModuleParameters(), and SALOMEDS::lock().

SALOMEDS::ListOfStrings * SALOMEDS_Study_i::GetObjectNames ( const char * theContext )

virtual

method to get all object names in the given context (or in the current context, if 'theContext' is empty)

Function : GetObjectNames Purpose : method to get all object names in the given context (or in the current context, if 'theContext' is empty)

References _closed, _impl, SALOMEDSImpl_Study::GetErrorCode(), SALOMEDSImpl_Study::GetObjectNames(), SALOMEDSImpl_Study::HasCurrentContext(), and SALOMEDS::lock().

char * SALOMEDS_Study_i::GetObjectPath ( CORBA::Object_ptr theObject )

virtual

method to get a path of SObject

Function : GetObjectPath Purpose :

Parameters

aSO	SObject_ptr arguments

Returns: char* arguments, the path of the SObject

References _closed, _impl, _orb, SALOMEDSImpl_Study::FindObjectID(), SALOMEDSImpl_Study::FindObjectIOR(), SALOMEDSImpl_Study::GetObjectPath(), SALOMEDSImpl_SObject::IsNull(), and SALOMEDS::lock().

char * SALOMEDS_Study_i::GetPersistentReference ( )

virtual

method to Get persistent reference of study (idem URL())

Function : GetPersistentReference Purpose : Get persistent reference of study (idem URL())

See Also: URL()

Returns: char* arguments, the persistent reference of the study

References _closed, _impl, SALOMEDSImpl_Study::GetPersistentReference(), and SALOMEDS::lock().

SALOMEDS::AttributeStudyProperties_ptr SALOMEDS_Study_i::GetProperties ( )

virtual

References _closed, _impl, _orb, SALOMEDSImpl_Study::GetProperties(), and SALOMEDS::lock().

CORBA::Double SALOMEDS_Study_i::GetReal ( const char * theVarName )

virtual

Function : GetReal Purpose :

References _closed, _impl, and SALOMEDSImpl_Study::GetVariableValue().

char * SALOMEDS_Study_i::GetString ( const char * theVarName )

virtual

Function : GetString Purpose :

References _closed, _impl, and SALOMEDSImpl_Study::GetStringVariableValue().

SALOMEDS::Study_ptr SALOMEDS_Study_i::GetStudy	(	const DF_Label &	theLabel,
		CORBA::ORB_ptr	orb
	)

static

References ASSERT, DF_Label::FindAttribute(), SALOMEDSImpl_AttributeIOR::GetID(), SALOMEDS::lock(), MESSAGE, DF_Label::Root(), and SALOMEDSImpl_AttributeIOR::Value().

SALOMEDS_Study_i * SALOMEDS_Study_i::GetStudyServant	(	SALOMEDSImpl_Study *	aStudyImpl,
		CORBA::ORB_ptr	orb
	)

static

References _mapOfStudies, and SALOMEDS_Study_i().

Referenced by SALOMEDS_Driver_i::DumpPython(), SALOMEDS_StudyManager_i::GetStudyByID(), SALOMEDS_StudyManager_i::GetStudyByName(), SALOMEDS_StudyManager_i::NewStudy(), and SALOMEDS_StudyManager_i::Open().

char * SALOMEDS_Study_i::GetTransientReference ( )

virtual

method to Get transient reference of study

Function : GetTransientReference Purpose : Get IOR of the Study (registred in OCAF document in doc->Root)

Returns: char* arguments, the transient reference of the study

References _closed, _impl, SALOMEDSImpl_Study::GetTransientReference(), and SALOMEDS::lock().

SALOMEDS::UseCaseBuilder_ptr SALOMEDS_Study_i::GetUseCaseBuilder ( )

virtual

Function : GetUseCaseBuilder Purpose : Returns a UseCase builder.

References _closed, _impl, _orb, SALOMEDSImpl_Study::GetUseCaseBuilder(), and SALOMEDS::lock().

SALOMEDS::ListOfStrings * SALOMEDS_Study_i::GetVariableNames ( )

virtual

Function : GetVariableNames Purpose :

References _closed, _impl, and SALOMEDSImpl_Study::GetVariableNames().

void SALOMEDS_Study_i::IORUpdated ( SALOMEDSImpl_AttributeIOR * theAttribute )

static

References SALOMEDSImpl_Study::IORUpdated(), and SALOMEDS::lock().

CORBA::Boolean SALOMEDS_Study_i::IsBoolean ( const char * theVarName )

virtual

Function : IsBoolean Purpose :

References _closed, _impl, SALOMEDSImpl_GenericVariable::BOOLEAN_VAR, and SALOMEDSImpl_Study::IsTypeOf().

CORBA::Boolean SALOMEDS_Study_i::IsEmpty ( )

virtual

method to detect if a study is empty

Function : IsEmpty Purpose : Detect if study is empty.

Returns: bool arguments, true if study is empty

References _closed, _impl, SALOMEDSImpl_Study::IsEmpty(), and SALOMEDS::lock().

CORBA::Boolean SALOMEDS_Study_i::IsInteger ( const char * theVarName )

virtual

Function : IsInteger Purpose :

References _closed, _impl, SALOMEDSImpl_GenericVariable::INTEGER_VAR, and SALOMEDSImpl_Study::IsTypeOf().

CORBA::Boolean SALOMEDS_Study_i::IsModified ( )

virtual

method to Detect if a Study has been modified since it has been saved

Function : IsModified Purpose : Detect if a Study has been modified since it has been saved.

Returns: bool arguments

References _closed, _impl, SALOMEDSImpl_Study::IsModified(), and SALOMEDS::lock().

CORBA::Boolean SALOMEDS_Study_i::IsReal ( const char * theVarName )

virtual

Function : IsReal Purpose :

References _closed, _impl, SALOMEDSImpl_Study::IsTypeOf(), and SALOMEDSImpl_GenericVariable::REAL_VAR.

CORBA::Boolean SALOMEDS_Study_i::IsSaved ( )

virtual

method to get if study has been saved

Function : IsSaved Purpose : get if study has been saved.

Returns: bool arguments

References _closed, _impl, SALOMEDSImpl_Study::IsSaved(), and SALOMEDS::lock().

void SALOMEDS_Study_i::IsSaved ( CORBA::Boolean save )

virtual

method to set if study has been saved

Function : IsSaved Purpose : set if study has been saved.

Parameters

save	bool arguments

References _closed, _impl, SALOMEDSImpl_Study::IsSaved(), and SALOMEDS::lock().

CORBA::Boolean SALOMEDS_Study_i::IsString ( const char * theVarName )

virtual

Function : IsString Purpose :

References _closed, _impl, SALOMEDSImpl_Study::IsTypeOf(), and SALOMEDSImpl_GenericVariable::STRING_VAR.

bool SALOMEDS_Study_i::IsStudyLocked ( )

virtual

Function : IsStudyLocked Purpose :

References _closed, _impl, SALOMEDSImpl_Study::IsStudyLocked(), and SALOMEDS::lock().

CORBA::Boolean SALOMEDS_Study_i::IsVariable ( const char * theVarName )

virtual

Function : IsVariable Purpose :

References _closed, _impl, and SALOMEDSImpl_Study::IsVariable().

CORBA::Boolean SALOMEDS_Study_i::IsVariableUsed ( const char * theVarName )

virtual

Function : IsVariableUsed Purpose :

References _closed, _impl, and SALOMEDSImpl_Study::IsVariableUsed().

void SALOMEDS_Study_i::Modified ( )

virtual

method to set Modified flag of a Study to True

Function : Modified Purpose : Sets a Modified flag of a Study to True.

References _closed, _impl, SALOMEDS::lock(), and SALOMEDSImpl_Study::Modify().

char * SALOMEDS_Study_i::Name ( )

virtual

method to get study name

Function : Name Purpose : get study name.

Returns: char* arguments, the study name

References _impl, SALOMEDS::lock(), and SALOMEDSImpl_Study::Name().

void SALOMEDS_Study_i::Name ( const char * name )

virtual

method to set study name

Function : Name Purpose : set study name.

Parameters

name	char* arguments, the study name

References _impl, SALOMEDS::lock(), and SALOMEDSImpl_Study::Name().

SALOMEDS::StudyBuilder_ptr SALOMEDS_Study_i::NewBuilder ( )

virtual

method to Create a StudyBuilder

Function : NewBuilder Purpose : Create a StudyBuilder.

Returns: StudyBuilder_ptr arguments, the created StudyBuilder

References _builder, _closed, and SALOMEDS::lock().

SALOMEDS::ChildIterator_ptr SALOMEDS_Study_i::NewChildIterator ( SALOMEDS::SObject_ptr aSO )

virtual

method to Create a ChildIterator from an SObject

Function : NewChildIterator Purpose : Create a ChildIterator from an SObject.

Parameters

aSO	SObject_ptr arguments

Returns: ChildIterator_ptr arguments, the created ChildIterator

References _closed, _impl, _orb, SALOMEDSImpl_Study::GetSObject(), and SALOMEDS::lock().

SALOMEDS::SComponentIterator_ptr SALOMEDS_Study_i::NewComponentIterator ( )

virtual

method to Create a SComponentIterator

Function : NewComponentIterator Purpose : Create a SComponentIterator.

Returns: SComponentIterator_ptr arguments, the created SComponentIterator

References _closed, _impl, _orb, SALOMEDS_SComponentIterator_i::Init(), SALOMEDS::lock(), and SALOMEDSImpl_Study::NewComponentIterator().

Referenced by Close().

SALOMEDS::ListOfListOfStrings * SALOMEDS_Study_i::ParseVariables ( const char * theVars )

virtual

Function : ParseVariables Purpose :

References _closed, _impl, and SALOMEDSImpl_Study::ParseVariables().

void SALOMEDS_Study_i::RemovePostponed ( CORBA::Long theUndoLimit )

virtual

Function : RemovePostponed Purpose :

References _closed, _impl, _orb, SALOMEDSImpl_Study::GetIORs(), and SALOMEDS::lock().

Referenced by Close().

CORBA::Boolean SALOMEDS_Study_i::RemoveVariable ( const char * theVarName )

virtual

Function : RemoveVariable Purpose :

References _closed, _impl, _notifier, SALOMEDSImpl_AbstractCallback::modifyNB_Notification(), and SALOMEDSImpl_Study::RemoveVariable().

CORBA::Boolean SALOMEDS_Study_i::RenameVariable	(	const char *	theVarName,
		const char *	theNewVarName
	)

virtual

Function : RenameVariable Purpose :

References _closed, _impl, _notifier, SALOMEDSImpl_AbstractCallback::modifyNB_Notification(), and SALOMEDSImpl_Study::RenameVariable().

void SALOMEDS_Study_i::SetBoolean	(	const char *	theVarName,
		CORBA::Boolean	theValue
	)

virtual

Function : SetBoolean Purpose :

References _closed, _impl, _notifier, SALOMEDSImpl_GenericVariable::BOOLEAN_VAR, SALOMEDSImpl_AbstractCallback::modifyNB_Notification(), and SALOMEDSImpl_Study::SetVariable().

void SALOMEDS_Study_i::SetContext ( const char * thePath )

virtual

method to set a context: root ('/') is UserData component

Function : SetContext Purpose : Sets the current context.

References _closed, _impl, SALOMEDSImpl_Study::GetErrorCode(), SALOMEDSImpl_Study::IsError(), SALOMEDS::lock(), and SALOMEDSImpl_Study::SetContext().

void SALOMEDS_Study_i::SetInteger	(	const char *	theVarName,
		CORBA::Long	theValue
	)

virtual

Function : SetInteger Purpose :

References _closed, _impl, _notifier, SALOMEDSImpl_GenericVariable::INTEGER_VAR, SALOMEDSImpl_AbstractCallback::modifyNB_Notification(), and SALOMEDSImpl_Study::SetVariable().

void SALOMEDS_Study_i::SetReal	(	const char *	theVarName,
		CORBA::Double	theValue
	)

virtual

Function : SetReal Purpose :

References _closed, _impl, _notifier, SALOMEDSImpl_AbstractCallback::modifyNB_Notification(), SALOMEDSImpl_GenericVariable::REAL_VAR, and SALOMEDSImpl_Study::SetVariable().

void SALOMEDS_Study_i::SetString	(	const char *	theVarName,
		const char *	theValue
	)

virtual

Function : SetString Purpose :

References _closed, _impl, _notifier, SALOMEDSImpl_AbstractCallback::modifyNB_Notification(), SALOMEDSImpl_Study::SetStringVariable(), and SALOMEDSImpl_GenericVariable::STRING_VAR.

void SALOMEDS_Study_i::SetStringAsDouble	(	const char *	theVarName,
		CORBA::Double	theValue
	)

virtual

Function : SetStringAsDouble Purpose :

References _closed, _impl, SALOMEDSImpl_Study::SetStringVariableAsDouble(), and SALOMEDSImpl_GenericVariable::STRING_VAR.

void SALOMEDS_Study_i::SetStudyLock ( const char * theLockerID )

virtual

Function : SetStudyLock Purpose :

References _closed, _impl, SALOMEDS::lock(), and SALOMEDSImpl_Study::SetStudyLock().

CORBA::Short SALOMEDS_Study_i::StudyId ( )

virtual

References _impl, SALOMEDS::lock(), and SALOMEDSImpl_Study::StudyId().

void SALOMEDS_Study_i::StudyId ( CORBA::Short id )

virtual

References _impl, SALOMEDS::lock(), and SALOMEDSImpl_Study::StudyId().

void SALOMEDS_Study_i::UndoPostponed ( CORBA::Long theWay )

virtual

Function : UndoPostponed Purpose :

References SALOMEDS::lock().

void SALOMEDS_Study_i::UnLockStudy ( const char * theLockerID )

virtual

Function : UnLockStudy Purpose :

References _closed, _impl, SALOMEDS::lock(), and SALOMEDSImpl_Study::UnLockStudy().

void SALOMEDS_Study_i::UpdateIORLabelMap	(	const char *	anIOR,
		const char *	aLabel
	)

virtual

References _closed, _impl, SALOMEDS::lock(), and SALOMEDSImpl_Study::UpdateIORLabelMap().

char * SALOMEDS_Study_i::URL ( )

virtual

method to get URL of the study (idem GetPersistentReference)

Function : URL Purpose : get URL of the study (persistent reference of the study)

Returns: char* arguments, the study URL

References _impl, SALOMEDS::lock(), and SALOMEDSImpl_Study::URL().

void SALOMEDS_Study_i::URL ( const char * url )

virtual

method to set URL of the study

Function : URL Purpose : set URL of the study (persistent reference of the study)

Parameters

url	char* arguments, the study URL

References _impl, SALOMEDS::lock(), and SALOMEDSImpl_Study::URL().

Field Documentation

SALOMEDS_StudyBuilder_i* SALOMEDS_Study_i::_builder

private

Referenced by EnableUseCaseAutoFilling(), NewBuilder(), SALOMEDS_Study_i(), and ~SALOMEDS_Study_i().

bool SALOMEDS_Study_i::_closed

private

Referenced by Close(), CreateObjectID(), DumpStudy(), EnableUseCaseAutoFilling(), FindComponent(), FindComponentID(), FindDependances(), FindObject(), FindObjectByName(), FindObjectByPath(), FindObjectID(), FindObjectIOR(), GetBoolean(), GetCommonParameters(), GetComponentNames(), GetContext(), GetDefaultScript(), GetDirectoryNames(), GetFileNames(), GetInteger(), GetLastModificationDate(), GetLockerID(), GetModificationsDate(), GetModuleParameters(), GetObjectNames(), GetObjectPath(), GetPersistentReference(), GetProperties(), GetReal(), GetString(), GetTransientReference(), GetUseCaseBuilder(), GetVariableNames(), IsBoolean(), IsEmpty(), IsInteger(), IsModified(), IsReal(), IsSaved(), IsString(), IsStudyLocked(), IsVariable(), IsVariableUsed(), Modified(), NewBuilder(), NewChildIterator(), NewComponentIterator(), ParseVariables(), RemovePostponed(), RemoveVariable(), RenameVariable(), SALOMEDS_Study_i(), SetBoolean(), SetContext(), SetInteger(), SetReal(), SetString(), SetStringAsDouble(), SetStudyLock(), UnLockStudy(), and UpdateIORLabelMap().

SALOMEDSImpl_AbstractCallback* SALOMEDS_Study_i::_genObjRegister

private

Referenced by SALOMEDS_Study_i(), and ~SALOMEDS_Study_i().

SALOMEDSImpl_Study* SALOMEDS_Study_i::_impl

private

Referenced by Close(), CreateObjectID(), DumpStudy(), EnableUseCaseAutoFilling(), FindComponent(), FindComponentID(), FindObject(), FindObjectByName(), FindObjectByPath(), FindObjectID(), FindObjectIOR(), GetBoolean(), GetCommonParameters(), GetComponentNames(), GetContext(), GetDefaultScript(), GetDirectoryNames(), GetFileNames(), GetInteger(), GetLastModificationDate(), GetLocalImpl(), GetLockerID(), GetModificationsDate(), GetModuleParameters(), GetObjectNames(), GetObjectPath(), GetPersistentReference(), GetProperties(), GetReal(), GetString(), GetTransientReference(), GetUseCaseBuilder(), GetVariableNames(), IsBoolean(), IsEmpty(), IsInteger(), IsModified(), IsReal(), IsSaved(), IsString(), IsStudyLocked(), IsVariable(), IsVariableUsed(), Modified(), Name(), NewChildIterator(), NewComponentIterator(), ParseVariables(), RemovePostponed(), RemoveVariable(), RenameVariable(), SALOMEDS_Study_i(), SetBoolean(), SetContext(), SetInteger(), SetReal(), SetString(), SetStringAsDouble(), SetStudyLock(), StudyId(), UnLockStudy(), UpdateIORLabelMap(), URL(), and ~SALOMEDS_Study_i().

std::map< SALOMEDSImpl_Study *, SALOMEDS_Study_i * > SALOMEDS_Study_i::_mapOfStudies

staticprivate

Referenced by GetStudyServant(), and ~SALOMEDS_Study_i().

SALOMEDSImpl_AbstractCallback* SALOMEDS_Study_i::_notifier

private

Referenced by attach(), detach(), RemoveVariable(), RenameVariable(), SALOMEDS_Study_i(), SetBoolean(), SetInteger(), SetReal(), SetString(), and ~SALOMEDS_Study_i().

CORBA::ORB_var SALOMEDS_Study_i::_orb

private

Referenced by Close(), CreateObjectID(), DumpStudy(), FindComponent(), FindComponentID(), FindObject(), FindObjectByName(), FindObjectByPath(), FindObjectID(), FindObjectIOR(), GetCommonParameters(), GetModuleParameters(), GetObjectPath(), GetProperties(), GetUseCaseBuilder(), NewChildIterator(), NewComponentIterator(), RemovePostponed(), and SALOMEDS_Study_i().

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation