#include <SALOMEDS_StudyBuilder_i.hxx>

Inheritance diagram for SALOMEDS_StudyBuilder_i:

Public Member Functions
	SALOMEDS_StudyBuilder_i (SALOMEDSImpl_StudyBuilder *, CORBA::ORB_ptr)
	Function : constructor Purpose : More...

	~SALOMEDS_StudyBuilder_i ()
	Function : destructor Purpose : More...

virtual SALOMEDS::SComponent_ptr	NewComponent (const char *ComponentDataType)
	NewComponent. More...

virtual void	DefineComponentInstance (SALOMEDS::SComponent_ptr, CORBA::Object_ptr ComponentIOR)
	DefineComponentInstance. More...

virtual void	RemoveComponent (SALOMEDS::SComponent_ptr aComponent)
	<long-description> More...

virtual SALOMEDS::SObject_ptr	NewObject (SALOMEDS::SObject_ptr theFatherObject)
	<long-description> More...

virtual SALOMEDS::SObject_ptr	NewObjectToTag (SALOMEDS::SObject_ptr theFatherObject, CORBA::Long atag)
	<long-description> More...

virtual void	AddDirectory (const char *thePath)
	The methods adds a new subdirectory, the path can be absolute or relative (then the current context is used) More...

virtual void	LoadWith (SALOMEDS::SComponent_ptr sco, SALOMEDS::Driver_ptr Engine) throw (SALOME::SALOME_Exception)
	Function : LoadWith Purpose : More...

virtual void	Load (SALOMEDS::SObject_ptr sco)
	Function : Load Purpose : More...

virtual void	RemoveObject (SALOMEDS::SObject_ptr anObject)
	Function : RemoveObject Purpose : More...

virtual void	RemoveObjectWithChildren (SALOMEDS::SObject_ptr anObject)
	Function : RemoveObjectWithChildren Purpose : More...

virtual SALOMEDS::GenericAttribute_ptr	FindOrCreateAttribute (SALOMEDS::SObject_ptr anObject, const char *aTypeOfAttribute)
	Function : FindOrCreateAttribute Purpose : Add attribute of given type to SObject, if there is attribute of such type, returns existing one. More...

virtual CORBA::Boolean	FindAttribute (SALOMEDS::SObject_ptr anObject, SALOMEDS::GenericAttribute_out anAttribute, const char *aTypeOfAttribute)
	Function : FindAttribute Purpose : Find attribute of given type assigned SObject, returns true if it is found. More...

virtual void	RemoveAttribute (SALOMEDS::SObject_ptr anObject, const char *aTypeOfAttribute)
	Function : RemoveAttribute Purpose : Remove attribute of given type assigned SObject. More...

virtual void	Addreference (SALOMEDS::SObject_ptr me, SALOMEDS::SObject_ptr thereferencedObject)
	Function : Addreference Purpose : More...

virtual void	RemoveReference (SALOMEDS::SObject_ptr me)
	Function : RemoveReference Purpose : More...

virtual void	SetGUID (SALOMEDS::SObject_ptr anObject, const char *theGUID)
	Function : SetGUID Purpose : More...

virtual bool	IsGUID (SALOMEDS::SObject_ptr anObject, const char *theGUID)
	Function : IsGUID Purpose : More...

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

virtual void	CommitCommand () throw (SALOMEDS::StudyBuilder::LockProtection)
	Function : CommitCommand Purpose : More...

virtual CORBA::Boolean	HasOpenCommand ()
	Function : HasOpenCommand Purpose : More...

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

virtual void	Undo () throw (SALOMEDS::StudyBuilder::LockProtection)
	Function : Undo Purpose : More...

virtual void	Redo () throw (SALOMEDS::StudyBuilder::LockProtection)
	Function : Redo Purpose : More...

CORBA::Boolean	GetAvailableUndos ()
	Function : GetAvailableUndos Purpose : More...

CORBA::Boolean	GetAvailableRedos ()
	Function : GetAvailableRedos Purpose : More...

CORBA::Boolean	IsSaved ()

CORBA::Boolean	IsModified ()

virtual CORBA::Long	UndoLimit ()
	Function : UndoLimit Purpose : More...

virtual void	UndoLimit (CORBA::Long)
	Function : UndoLimit Purpose : More...

void	CheckLocked () throw (SALOMEDS::StudyBuilder::LockProtection)
	Function : CheckLocked Purpose : More...

virtual void	SetName (SALOMEDS::SObject_ptr theSO, const char *theValue) throw (SALOMEDS::StudyBuilder::LockProtection)
	Function : SetName Purpose : More...

virtual void	SetComment (SALOMEDS::SObject_ptr theSO, const char *theValue) throw (SALOMEDS::StudyBuilder::LockProtection)
	Function : SetComment Purpose : More...

virtual void	SetIOR (SALOMEDS::SObject_ptr theSO, const char *theValue) throw (SALOMEDS::StudyBuilder::LockProtection)
	Function : SetIOR Purpose : More...

SALOMEDSImpl_StudyBuilder *	GetImpl ()

Private Attributes
CORBA::ORB_var	_orb

SALOMEDSImpl_StudyBuilder *	_impl

Constructor & Destructor Documentation

SALOMEDS_StudyBuilder_i::SALOMEDS_StudyBuilder_i	(	SALOMEDSImpl_StudyBuilder *	theImpl,
		CORBA::ORB_ptr	orb
	)

Function : constructor Purpose :

References _impl, and _orb.

SALOMEDS_StudyBuilder_i::~SALOMEDS_StudyBuilder_i ( )

Function : destructor Purpose :

Member Function Documentation

void SALOMEDS_StudyBuilder_i::AbortCommand ( )

virtual

Function : AbortCommand Purpose :

References _impl, SALOMEDSImpl_StudyBuilder::AbortCommand(), and SALOMEDS::lock().

void SALOMEDS_StudyBuilder_i::AddDirectory ( const char * thePath )

virtual

The methods adds a new subdirectory, the path can be absolute or relative (then the current context is used)

Function : AddDirectory Purpose : adds a new directory with a path = thePath.

References _impl, SALOMEDSImpl_StudyBuilder::AddDirectory(), CheckLocked(), SALOMEDSImpl_StudyBuilder::GetErrorCode(), and SALOMEDS::lock().

void SALOMEDS_StudyBuilder_i::Addreference	(	SALOMEDS::SObject_ptr	me,
		SALOMEDS::SObject_ptr	thereferencedObject
	)

virtual

Function : Addreference Purpose :

References _impl, SALOMEDSImpl_StudyBuilder::Addreference(), ASSERT, CheckLocked(), SALOMEDSImpl_SObject::GetID(), SALOMEDSImpl_StudyBuilder::GetOwner(), SALOMEDSImpl_Study::GetSObject(), and SALOMEDS::lock().

void SALOMEDS_StudyBuilder_i::CheckLocked ( ) throw (SALOMEDS::StudyBuilder::LockProtection)

Function : CheckLocked Purpose :

References _impl, SALOMEDSImpl_StudyBuilder::CheckLocked(), and SALOMEDS::lock().

Referenced by AddDirectory(), Addreference(), DefineComponentInstance(), NewComponent(), NewObject(), NewObjectToTag(), RemoveAttribute(), RemoveComponent(), RemoveObject(), RemoveObjectWithChildren(), RemoveReference(), SetGUID(), and UndoLimit().

void SALOMEDS_StudyBuilder_i::CommitCommand ( ) throw (SALOMEDS::StudyBuilder::LockProtection)

virtual

Function : CommitCommand Purpose :

References _impl, SALOMEDSImpl_StudyBuilder::CommitCommand(), SALOMEDS::lock(), and MESSAGE.

void SALOMEDS_StudyBuilder_i::DefineComponentInstance	(	SALOMEDS::SComponent_ptr	aComponent,
		CORBA::Object_ptr	ComponentIOR
	)

virtual

DefineComponentInstance.

Function : DefineComponentInstance Purpose : Add IOR attribute of a Scomponent.

Parameters

SComponent_ptr
ComponentIOR

References _impl, _orb, CheckLocked(), SALOMEDSImpl_StudyBuilder::DefineComponentInstance(), SALOMEDSImpl_StudyBuilder::GetOwner(), SALOMEDSImpl_Study::GetSComponent(), and SALOMEDS::lock().

CORBA::Boolean SALOMEDS_StudyBuilder_i::FindAttribute	(	SALOMEDS::SObject_ptr	anObject,
		SALOMEDS::GenericAttribute_out	anAttribute,
		const char *	aTypeOfAttribute
	)

virtual

Function : FindAttribute Purpose : Find attribute of given type assigned SObject, returns true if it is found.

References _impl, _orb, ASSERT, SALOMEDS_GenericAttribute_i::CreateAttribute(), SALOMEDSImpl_StudyBuilder::FindAttribute(), SALOMEDSImpl_StudyBuilder::GetOwner(), SALOMEDSImpl_Study::GetSObject(), and SALOMEDS::lock().

SALOMEDS::GenericAttribute_ptr SALOMEDS_StudyBuilder_i::FindOrCreateAttribute	(	SALOMEDS::SObject_ptr	anObject,
		const char *	aTypeOfAttribute
	)

virtual

Function : FindOrCreateAttribute Purpose : Add attribute of given type to SObject, if there is attribute of such type, returns existing one.

References _impl, _orb, SALOMEDS_GenericAttribute_i::CreateAttribute(), SALOMEDSImpl_StudyBuilder::FindOrCreateAttribute(), SALOMEDSImpl_StudyBuilder::GetOwner(), SALOMEDSImpl_Study::GetSObject(), and SALOMEDS::lock().

CORBA::Boolean SALOMEDS_StudyBuilder_i::GetAvailableRedos ( )

Function : GetAvailableRedos Purpose :

References _impl, SALOMEDSImpl_StudyBuilder::GetAvailableRedos(), and SALOMEDS::lock().

CORBA::Boolean SALOMEDS_StudyBuilder_i::GetAvailableUndos ( )

Function : GetAvailableUndos Purpose :

References _impl, SALOMEDSImpl_StudyBuilder::GetAvailableUndos(), and SALOMEDS::lock().

SALOMEDSImpl_StudyBuilder* SALOMEDS_StudyBuilder_i::GetImpl ( )

References _impl.

Referenced by SALOMEDS_Study_i::EnableUseCaseAutoFilling().

CORBA::Boolean SALOMEDS_StudyBuilder_i::HasOpenCommand ( )

virtual

Function : HasOpenCommand Purpose :

References _impl, SALOMEDSImpl_StudyBuilder::HasOpenCommand(), and SALOMEDS::lock().

bool SALOMEDS_StudyBuilder_i::IsGUID	(	SALOMEDS::SObject_ptr	anObject,
		const char *	theGUID
	)

virtual

Function : IsGUID Purpose :

References _impl, ASSERT, SALOMEDSImpl_StudyBuilder::GetOwner(), SALOMEDSImpl_Study::GetSObject(), SALOMEDSImpl_StudyBuilder::IsGUID(), and SALOMEDS::lock().

CORBA::Boolean SALOMEDS_StudyBuilder_i::IsModified ( )

CORBA::Boolean SALOMEDS_StudyBuilder_i::IsSaved ( )

void SALOMEDS_StudyBuilder_i::Load ( SALOMEDS::SObject_ptr sco )

virtual

Function : Load Purpose :

References MESSAGE.

void SALOMEDS_StudyBuilder_i::LoadWith	(	SALOMEDS::SComponent_ptr	sco,
		SALOMEDS::Driver_ptr	Engine
	)		throw (SALOME::SALOME_Exception)

virtual

Function : LoadWith Purpose :

References SALOME::BAD_PARAM, SALOMEDS::lock(), and THROW_SALOME_CORBA_EXCEPTION.

void SALOMEDS_StudyBuilder_i::NewCommand ( )

virtual

Function : NewCommand Purpose :

References _impl, SALOMEDS::lock(), and SALOMEDSImpl_StudyBuilder::NewCommand().

SALOMEDS::SComponent_ptr SALOMEDS_StudyBuilder_i::NewComponent ( const char * ComponentDataType )

virtual

NewComponent.

Function : NewComponent Purpose : Create a new component (Scomponent)

Parameters

ComponentDataType

Returns: <ReturnValue>

References _impl, _orb, CheckLocked(), SALOMEDSImpl_SObject::IsNull(), SALOMEDS::lock(), SALOMEDS_SComponent_i::New(), and SALOMEDSImpl_StudyBuilder::NewComponent().

SALOMEDS::SObject_ptr SALOMEDS_StudyBuilder_i::NewObject ( SALOMEDS::SObject_ptr theFatherObject )

virtual

<long-description>

Function : NewObject Purpose : Create a new SObject.

Parameters

theFatherObject

Returns: <ReturnValue>

References _impl, _orb, CheckLocked(), SALOMEDSImpl_SObject::GetID(), SALOMEDSImpl_StudyBuilder::GetOwner(), SALOMEDSImpl_Study::GetSObject(), SALOMEDSImpl_SObject::IsNull(), SALOMEDS::lock(), SALOMEDS_SObject_i::New(), and SALOMEDSImpl_StudyBuilder::NewObject().

SALOMEDS::SObject_ptr SALOMEDS_StudyBuilder_i::NewObjectToTag	(	SALOMEDS::SObject_ptr	theFatherObject,
		CORBA::Long	atag
	)

virtual

<long-description>

Function : NewObjectToTag Purpose :

Parameters

theFatherObject
atag

Returns: <ReturnValue>

References _impl, _orb, CheckLocked(), SALOMEDSImpl_SObject::GetID(), SALOMEDSImpl_StudyBuilder::GetOwner(), SALOMEDSImpl_Study::GetSObject(), SALOMEDSImpl_SObject::IsNull(), SALOMEDS::lock(), SALOMEDS_SObject_i::New(), and SALOMEDSImpl_StudyBuilder::NewObjectToTag().

void SALOMEDS_StudyBuilder_i::Redo ( ) throw (SALOMEDS::StudyBuilder::LockProtection)

virtual

Function : Redo Purpose :

References _impl, SALOMEDS::lock(), MESSAGE, and SALOMEDSImpl_StudyBuilder::Redo().

void SALOMEDS_StudyBuilder_i::RemoveAttribute	(	SALOMEDS::SObject_ptr	anObject,
		const char *	aTypeOfAttribute
	)

virtual

Function : RemoveAttribute Purpose : Remove attribute of given type assigned SObject.

References _impl, ASSERT, CheckLocked(), SALOMEDSImpl_StudyBuilder::GetOwner(), SALOMEDSImpl_Study::GetSObject(), SALOMEDS::lock(), and SALOMEDSImpl_StudyBuilder::RemoveAttribute().

void SALOMEDS_StudyBuilder_i::RemoveComponent ( SALOMEDS::SComponent_ptr aComponent )

virtual

<long-description>

Function : RemoveComponent Purpose : Delete a Scomponent.

Parameters

aComponent

References _impl, ASSERT, CheckLocked(), SALOMEDSImpl_StudyBuilder::GetOwner(), SALOMEDSImpl_Study::GetSComponent(), SALOMEDS::lock(), and SALOMEDSImpl_StudyBuilder::RemoveComponent().

void SALOMEDS_StudyBuilder_i::RemoveObject ( SALOMEDS::SObject_ptr anObject )

virtual

Function : RemoveObject Purpose :

References _impl, CheckLocked(), SALOMEDSImpl_StudyBuilder::GetOwner(), SALOMEDSImpl_Study::GetSObject(), SALOMEDS::lock(), and SALOMEDSImpl_StudyBuilder::RemoveObject().

void SALOMEDS_StudyBuilder_i::RemoveObjectWithChildren ( SALOMEDS::SObject_ptr anObject )

virtual

Function : RemoveObjectWithChildren Purpose :

References _impl, CheckLocked(), SALOMEDSImpl_StudyBuilder::GetOwner(), SALOMEDSImpl_Study::GetSObject(), SALOMEDS::lock(), and SALOMEDSImpl_StudyBuilder::RemoveObjectWithChildren().

void SALOMEDS_StudyBuilder_i::RemoveReference ( SALOMEDS::SObject_ptr me )

virtual

Function : RemoveReference Purpose :

References _impl, ASSERT, CheckLocked(), SALOMEDSImpl_StudyBuilder::GetOwner(), SALOMEDSImpl_Study::GetSObject(), SALOMEDS::lock(), and SALOMEDSImpl_StudyBuilder::RemoveReference().

void SALOMEDS_StudyBuilder_i::SetComment	(	SALOMEDS::SObject_ptr	theSO,
		const char *	theValue
	)		throw (SALOMEDS::StudyBuilder::LockProtection)

virtual

Function : SetComment Purpose :

References SALOMEDS::lock().

void SALOMEDS_StudyBuilder_i::SetGUID	(	SALOMEDS::SObject_ptr	anObject,
		const char *	theGUID
	)

virtual

Function : SetGUID Purpose :

References _impl, ASSERT, CheckLocked(), SALOMEDSImpl_StudyBuilder::GetOwner(), SALOMEDSImpl_Study::GetSObject(), SALOMEDS::lock(), and SALOMEDSImpl_StudyBuilder::SetGUID().

void SALOMEDS_StudyBuilder_i::SetIOR	(	SALOMEDS::SObject_ptr	theSO,
		const char *	theValue
	)		throw (SALOMEDS::StudyBuilder::LockProtection)

virtual

Function : SetIOR Purpose :

References SALOMEDS::lock().

void SALOMEDS_StudyBuilder_i::SetName	(	SALOMEDS::SObject_ptr	theSO,
		const char *	theValue
	)		throw (SALOMEDS::StudyBuilder::LockProtection)

virtual

Function : SetName Purpose :

References SALOMEDS::lock().

void SALOMEDS_StudyBuilder_i::Undo ( ) throw (SALOMEDS::StudyBuilder::LockProtection)

virtual

Function : Undo Purpose :

References _impl, SALOMEDS::lock(), MESSAGE, and SALOMEDSImpl_StudyBuilder::Undo().

CORBA::Long SALOMEDS_StudyBuilder_i::UndoLimit ( )

virtual

Function : UndoLimit Purpose :

References _impl, SALOMEDS::lock(), and SALOMEDSImpl_StudyBuilder::UndoLimit().

void SALOMEDS_StudyBuilder_i::UndoLimit ( CORBA::Long n )

virtual

Function : UndoLimit Purpose :

References _impl, CheckLocked(), SALOMEDS::lock(), and SALOMEDSImpl_StudyBuilder::UndoLimit().

Field Documentation

SALOMEDSImpl_StudyBuilder* SALOMEDS_StudyBuilder_i::_impl

private

CORBA::ORB_var SALOMEDS_StudyBuilder_i::_orb

private

Referenced by DefineComponentInstance(), FindAttribute(), FindOrCreateAttribute(), NewComponent(), NewObject(), NewObjectToTag(), and SALOMEDS_StudyBuilder_i().

Public Member Functions

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation