SALOMEDSImpl_UseCaseBuilder Class Reference

#include <SALOMEDSImpl_UseCaseBuilder.hxx>

Public Member Functions
	SALOMEDSImpl_UseCaseBuilder (DF_Document *theDocument)
	standard constructor More...
virtual	~SALOMEDSImpl_UseCaseBuilder ()
	standard destructor More...
virtual bool	Append (const SALOMEDSImpl_SObject &theObject)
	Function : Append Purpose : More...
virtual bool	Remove (const SALOMEDSImpl_SObject &theObject)
	Function : Remove Purpose : More...
virtual bool	AppendTo (const SALOMEDSImpl_SObject &theFather, const SALOMEDSImpl_SObject &theObject)
	Function : AppendTo Purpose : More...
virtual bool	InsertBefore (const SALOMEDSImpl_SObject &theFirst, const SALOMEDSImpl_SObject &theNext)
	Function : InsertBefore Purpose : More...
int	GetIndexInFather (const SALOMEDSImpl_SObject &theFather, const SALOMEDSImpl_SObject &theObject)
	Function : GetIndexInFather Purpose : More...
virtual bool	SetCurrentObject (const SALOMEDSImpl_SObject &theObject)
	Function : SetCurrentObject Purpose : More...
virtual bool	SetRootCurrent ()
	Function : SetRootCurrent Purpose : More...
virtual bool	HasChildren (const SALOMEDSImpl_SObject &theObject)
	Function : HasChildren Purpose : More...
virtual bool	SortChildren (const SALOMEDSImpl_SObject &theObject, bool theAscendingOrder)
	Function : SortChildren Purpose : More...
virtual SALOMEDSImpl_SObject	GetFather (const SALOMEDSImpl_SObject &theObject)
	Function : GetFather Purpose : More...
virtual bool	IsUseCase (const SALOMEDSImpl_SObject &theObject)
	Function : IsUseCase Purpose : More...
virtual bool	IsUseCaseNode (const SALOMEDSImpl_SObject &theObject)
	Function : IsUseCaseNode Purpose : More...
virtual bool	SetName (const std::string &theName)
	Function : SetName Purpose : More...
virtual SALOMEDSImpl_SObject	GetCurrentObject ()
	Function : GetCurrentObject Purpose : More...
virtual std::string	GetName ()
	Function : GetName Purpose : More...
virtual SALOMEDSImpl_SObject	AddUseCase (const std::string &theName)
	Function : NewUseCase Purpose : More...
virtual SALOMEDSImpl_UseCaseIterator	GetUseCaseIterator (const SALOMEDSImpl_SObject &anObject)
	Function : GetUseCaseIterator Purpose : Creates a new UseCase iterator, if anObject is null all use cases are iterated. More...
SALOMEDSImpl_SObject	GetSObject (const std::string &theEntry)

Private Attributes
SALOMEDSImpl_AttributeTreeNode *	_root
DF_Document *	_doc
SALOMEDSImpl_AttributeTreeNode *	_lastChild
int	_childIndex

Constructor & Destructor Documentation

SALOMEDSImpl_UseCaseBuilder()

SALOMEDSImpl_UseCaseBuilder::SALOMEDSImpl_UseCaseBuilder

(

DF_Document *

theDocument

)

standard constructor

Function : constructor Purpose :

References _doc, _root, DF_Attribute::FindAttribute(), DF_Label::FindAttribute(), DF_Label::FindChild(), SALOMEDSImpl_AttributeName::GetID(), SALOMEDSImpl_AttributeReference::GetID(), DF_Attribute::Label(), DF_Document::Main(), DF_Label::Root(), SALOMEDSImpl_AttributeTreeNode::Set(), SALOMEDSImpl_AttributeName::Set(), SALOMEDSImpl_AttributeReference::Set(), USE_CASE_GUID, and USE_CASE_LABEL_TAG.

~SALOMEDSImpl_UseCaseBuilder()

SALOMEDSImpl_UseCaseBuilder::~SALOMEDSImpl_UseCaseBuilder ( )

virtual

standard destructor

Function : destructor Purpose :

Member Function Documentation

AddUseCase()

SALOMEDSImpl_SObject SALOMEDSImpl_UseCaseBuilder::AddUseCase ( const std::string &  theName )

virtual

Function : NewUseCase Purpose :

References _doc, _root, SALOMEDSImpl_AttributeTreeNode::Append(), DF_Attribute::FindAttribute(), DF_Label::FindAttribute(), DF_Label::FindChild(), SALOMEDSImpl_AttributeReference::Get(), SALOMEDSImpl_AttributeInteger::GetID(), SALOMEDSImpl_AttributeReference::GetID(), DF_Document::Main(), DF_Label::Root(), SALOMEDSImpl_AttributeTreeNode::Set(), SALOMEDSImpl_AttributeName::Set(), SALOMEDSImpl_AttributeInteger::Set(), SALOMEDSImpl_AttributeReference::Set(), SALOMEDSImpl_AttributeInteger::SetValue(), SALOMEDSImpl_Study::SObject(), USE_CASE_GUID, USE_CASE_LABEL_TAG, and SALOMEDSImpl_AttributeInteger::Value().

Referenced by SALOMEDS_UseCaseBuilder_i::AddUseCase(), and main().

Append()

bool SALOMEDSImpl_UseCaseBuilder::Append ( const SALOMEDSImpl_SObject &  theObject )

virtual

Function : Append Purpose :

References _childIndex, _lastChild, _root, SALOMEDSImpl_Study::addSO_Notification(), SALOMEDSImpl_AttributeTreeNode::Append(), DF_Attribute::FindAttribute(), DF_Label::FindAttribute(), SALOMEDSImpl_AttributeReference::Get(), SALOMEDSImpl_AttributeReference::GetID(), SALOMEDSImpl_SObject::GetLabel(), SALOMEDSImpl_Study::GetStudyImpl(), SALOMEDSImpl_AttributeTreeNode::ID(), DF_Label::IsNull(), DF_Attribute::Label(), SALOMEDSImpl_AttributeTreeNode::Remove(), SALOMEDSImpl_AttributeTreeNode::Set(), and SALOMEDSImpl_AttributeReference::Set().

Referenced by SALOMEDS_UseCaseBuilder::Append(), SALOMEDS_UseCaseBuilder_i::Append(), and SALOMEDSImpl_Callback::OnAddSObject().

AppendTo()

bool SALOMEDSImpl_UseCaseBuilder::AppendTo ( const SALOMEDSImpl_SObject &  theFather, const SALOMEDSImpl_SObject &  theObject  )

virtual

Function : AppendTo Purpose :

References _childIndex, _lastChild, _root, SALOMEDSImpl_Study::addSO_Notification(), SALOMEDSImpl_AttributeTreeNode::Append(), DF_Label::FindAttribute(), SALOMEDSImpl_AttributeTreeNode::GetFather(), SALOMEDSImpl_SObject::GetLabel(), SALOMEDSImpl_Study::GetStudyImpl(), SALOMEDSImpl_AttributeTreeNode::HasNext(), SALOMEDSImpl_AttributeTreeNode::ID(), SALOMEDSImpl_AttributeTreeNode::InsertAfter(), DF_Label::IsNull(), TestKernelHelpers::ret, and SALOMEDSImpl_AttributeTreeNode::Set().

Referenced by SALOMEDS_UseCaseBuilder::AppendTo(), SALOMEDS_UseCaseBuilder_i::AppendTo(), and SortChildren().

GetCurrentObject()

SALOMEDSImpl_SObject SALOMEDSImpl_UseCaseBuilder::GetCurrentObject ( )

virtual

Function : GetCurrentObject Purpose :

References _root, DF_Attribute::FindAttribute(), SALOMEDSImpl_AttributeReference::Get(), SALOMEDSImpl_AttributeReference::GetID(), DF_Label::IsNull(), DF_Attribute::Label(), SALOMEDSImpl_AttributeReference::Set(), and SALOMEDSImpl_Study::SObject().

Referenced by SALOMEDS_UseCaseBuilder_i::GetCurrentObject().

GetFather()

SALOMEDSImpl_SObject SALOMEDSImpl_UseCaseBuilder::GetFather ( const SALOMEDSImpl_SObject &  theObject )

virtual

Function : GetFather Purpose :

References _root, DF_Label::FindAttribute(), SALOMEDSImpl_AttributeTreeNode::GetFather(), SALOMEDSImpl_SObject::GetLabel(), SALOMEDSImpl_GenericAttribute::GetSObject(), SALOMEDSImpl_AttributeTreeNode::ID(), and DF_Label::IsNull().

Referenced by _PTR(), and SALOMEDS_UseCaseBuilder_i::GetFather().

GetIndexInFather()

int SALOMEDSImpl_UseCaseBuilder::GetIndexInFather	(	const SALOMEDSImpl_SObject &	theFather,
		const SALOMEDSImpl_SObject &	theObject
	)

Function : GetIndexInFather Purpose :

References _childIndex, _lastChild, _root, DF_Label::FindAttribute(), SALOMEDSImpl_AttributeTreeNode::GetFather(), SALOMEDSImpl_AttributeTreeNode::GetFirst(), SALOMEDSImpl_SObject::GetLabel(), SALOMEDSImpl_AttributeTreeNode::GetNext(), SALOMEDSImpl_AttributeTreeNode::GetPrevious(), SALOMEDSImpl_AttributeTreeNode::HasNext(), SALOMEDSImpl_AttributeTreeNode::ID(), python_test_driver::index, DF_Label::IsNull(), and SALOMEDSImpl_AttributeTreeNode::Set().

Referenced by SALOMEDS_UseCaseBuilder::GetIndexInFather(), and SALOMEDS_UseCaseBuilder_i::GetIndexInFather().

GetName()

std::string SALOMEDSImpl_UseCaseBuilder::GetName ( )

virtual

Function : GetName Purpose :

References _root, DF_Attribute::FindAttribute(), SALOMEDSImpl_AttributeName::GetID(), and SALOMEDSImpl_AttributeName::Value().

Referenced by SALOMEDS_UseCaseBuilder::GetName(), and SALOMEDS_UseCaseBuilder_i::GetName().

GetSObject()

SALOMEDSImpl_SObject SALOMEDSImpl_UseCaseBuilder::GetSObject

(

const std::string &

theEntry

)

References _root, DF_Attribute::Label(), DF_Label::Label(), and SALOMEDSImpl_Study::SObject().

Referenced by SALOMEDS_UseCaseBuilder_i::Append(), SALOMEDS_UseCaseBuilder_i::AppendTo(), SALOMEDS_UseCaseBuilder_i::GetFather(), SALOMEDS_UseCaseBuilder_i::GetIndexInFather(), SALOMEDS_UseCaseBuilder_i::GetUseCaseIterator(), SALOMEDS_UseCaseBuilder_i::HasChildren(), SALOMEDS_UseCaseBuilder_i::InsertBefore(), SALOMEDS_UseCaseBuilder_i::IsUseCase(), SALOMEDS_UseCaseBuilder_i::IsUseCaseNode(), SALOMEDS_UseCaseBuilder_i::Remove(), SALOMEDS_UseCaseBuilder_i::SetCurrentObject(), and SALOMEDS_UseCaseBuilder_i::SortChildren().

GetUseCaseIterator()

SALOMEDSImpl_UseCaseIterator SALOMEDSImpl_UseCaseBuilder::GetUseCaseIterator ( const SALOMEDSImpl_SObject &  anObject )

virtual

Function : GetUseCaseIterator Purpose : Creates a new UseCase iterator, if anObject is null all use cases are iterated.

References _doc, DF_Label::FindChild(), SALOMEDSImpl_SObject::GetLabel(), DF_Document::Main(), DF_Label::Root(), USE_CASE_GUID, and USE_CASE_LABEL_TAG.

Referenced by _PTR(), SALOMEDS_UseCaseBuilder_i::GetUseCaseIterator(), and main().

HasChildren()

bool SALOMEDSImpl_UseCaseBuilder::HasChildren ( const SALOMEDSImpl_SObject &  theObject )

virtual

Function : HasChildren Purpose :

References _root, DF_Label::FindAttribute(), SALOMEDSImpl_AttributeTreeNode::GetFirst(), SALOMEDSImpl_SObject::GetLabel(), SALOMEDSImpl_AttributeTreeNode::ID(), DF_Label::IsNull(), and DF_Attribute::Label().

Referenced by SALOMEDS_UseCaseBuilder::HasChildren(), and SALOMEDS_UseCaseBuilder_i::HasChildren().

InsertBefore()

bool SALOMEDSImpl_UseCaseBuilder::InsertBefore ( const SALOMEDSImpl_SObject &  theFirst, const SALOMEDSImpl_SObject &  theNext  )

virtual

Function : InsertBefore Purpose :

References _childIndex, _lastChild, _root, SALOMEDSImpl_Study::addSO_Notification(), DF_Label::FindAttribute(), DF_Label::ForgetAttribute(), SALOMEDSImpl_AttributeTreeNode::GetFather(), SALOMEDSImpl_SObject::GetLabel(), SALOMEDSImpl_Study::GetStudyImpl(), SALOMEDSImpl_AttributeTreeNode::ID(), DF_Label::IsNull(), SALOMEDSImpl_AttributeTreeNode::Remove(), TestKernelHelpers::ret, and SALOMEDSImpl_AttributeTreeNode::Set().

Referenced by SALOMEDS_UseCaseBuilder::InsertBefore(), and SALOMEDS_UseCaseBuilder_i::InsertBefore().

IsUseCase()

bool SALOMEDSImpl_UseCaseBuilder::IsUseCase ( const SALOMEDSImpl_SObject &  theObject )

virtual

Function : IsUseCase Purpose :

References _doc, DF_Label::Father(), DF_Label::FindChild(), SALOMEDSImpl_SObject::GetLabel(), DF_Document::Main(), DF_Label::Root(), and USE_CASE_LABEL_TAG.

Referenced by SALOMEDS_UseCaseBuilder::IsUseCase(), and SALOMEDS_UseCaseBuilder_i::IsUseCase().

IsUseCaseNode()

bool SALOMEDSImpl_UseCaseBuilder::IsUseCaseNode ( const SALOMEDSImpl_SObject &  theObject )

virtual

Function : IsUseCaseNode Purpose :

References _root, DF_Label::FindAttribute(), SALOMEDSImpl_SObject::GetLabel(), SALOMEDSImpl_AttributeTreeNode::ID(), DF_Label::IsNull(), and DF_Attribute::Label().

Referenced by SALOMEDS_UseCaseBuilder::IsUseCaseNode(), and SALOMEDS_UseCaseBuilder_i::IsUseCaseNode().

Remove()

bool SALOMEDSImpl_UseCaseBuilder::Remove ( const SALOMEDSImpl_SObject &  theObject )

virtual

Function : Remove Purpose :

References _lastChild, _root, DF_Attribute::FindAttribute(), DF_Label::FindAttribute(), DF_Label::ForgetAttribute(), SALOMEDSImpl_AttributeReference::Get(), SALOMEDSImpl_AttributeTreeNode::GetFather(), SALOMEDSImpl_AttributeReference::GetID(), SALOMEDSImpl_SObject::GetLabel(), SALOMEDSImpl_AttributeTreeNode::ID(), DF_Label::IsNull(), DF_Attribute::Label(), SALOMEDSImpl_ChildNodeIterator::More(), SALOMEDSImpl_ChildNodeIterator::Next(), SALOMEDSImpl_AttributeTreeNode::Remove(), SALOMEDSImpl_AttributeReference::Set(), and SALOMEDSImpl_ChildNodeIterator::Value().

Referenced by SALOMEDSImpl_Callback::OnRemoveSObject(), SALOMEDS_UseCaseBuilder::Remove(), and SALOMEDS_UseCaseBuilder_i::Remove().

SetCurrentObject()

bool SALOMEDSImpl_UseCaseBuilder::SetCurrentObject ( const SALOMEDSImpl_SObject &  theObject )

virtual

Function : SetCurrentObject Purpose :

References _root, DF_Attribute::FindAttribute(), DF_Label::FindAttribute(), SALOMEDSImpl_AttributeReference::GetID(), SALOMEDSImpl_SObject::GetLabel(), SALOMEDSImpl_AttributeTreeNode::ID(), DF_Label::IsNull(), DF_Attribute::Label(), and SALOMEDSImpl_AttributeReference::Set().

Referenced by SALOMEDS_UseCaseBuilder::SetCurrentObject(), and SALOMEDS_UseCaseBuilder_i::SetCurrentObject().

SetName()

bool SALOMEDSImpl_UseCaseBuilder::SetName ( const std::string &  theName )

virtual

Function : SetName Purpose :

References _root, DF_Attribute::FindAttribute(), SALOMEDSImpl_AttributeName::GetID(), DF_Attribute::Label(), SALOMEDSImpl_AttributeName::Set(), and SALOMEDSImpl_AttributeName::SetValue().

Referenced by SALOMEDS_UseCaseBuilder_i::SetName(), and SALOMEDS_UseCaseBuilder::SetName().

SetRootCurrent()

bool SALOMEDSImpl_UseCaseBuilder::SetRootCurrent ( )

virtual

Function : SetRootCurrent Purpose :

References _root, DF_Attribute::FindAttribute(), SALOMEDSImpl_AttributeReference::GetID(), DF_Attribute::Label(), and SALOMEDSImpl_AttributeReference::Set().

Referenced by SALOMEDS_UseCaseBuilder::SetRootCurrent(), and SALOMEDS_UseCaseBuilder_i::SetRootCurrent().

SortChildren()

bool SALOMEDSImpl_UseCaseBuilder::SortChildren ( const SALOMEDSImpl_SObject &  theObject, bool  theAscendingOrder  )

virtual

Function : SortChildren Purpose :

References _lastChild, _root, AppendTo(), DF_Label::FindAttribute(), SALOMEDSImpl_AttributeTreeNode::GetFirst(), SALOMEDSImpl_AttributeReference::GetID(), SALOMEDSImpl_SObject::GetLabel(), SALOMEDSImpl_AttributeTreeNode::GetNext(), SALOMEDSImpl_AttributeTreeNode::ID(), DF_Label::IsNull(), DF_Attribute::Label(), and SALOMEDSImpl_Study::SObject().

Referenced by SALOMEDS_UseCaseBuilder::SortChildren(), and SALOMEDS_UseCaseBuilder_i::SortChildren().

Field Documentation

_childIndex

int SALOMEDSImpl_UseCaseBuilder::_childIndex

private

Referenced by Append(), AppendTo(), GetIndexInFather(), and InsertBefore().

_doc

DF_Document* SALOMEDSImpl_UseCaseBuilder::_doc

private

Referenced by AddUseCase(), GetUseCaseIterator(), IsUseCase(), and SALOMEDSImpl_UseCaseBuilder().

_lastChild

SALOMEDSImpl_AttributeTreeNode* SALOMEDSImpl_UseCaseBuilder::_lastChild

private

Referenced by Append(), AppendTo(), GetIndexInFather(), InsertBefore(), Remove(), and SortChildren().

_root

SALOMEDSImpl_AttributeTreeNode* SALOMEDSImpl_UseCaseBuilder::_root

private

Referenced by AddUseCase(), Append(), AppendTo(), GetCurrentObject(), GetFather(), GetIndexInFather(), GetName(), GetSObject(), HasChildren(), InsertBefore(), IsUseCaseNode(), Remove(), SALOMEDSImpl_UseCaseBuilder(), SetCurrentObject(), SetName(), SetRootCurrent(), and SortChildren().