Class corresponding to SMESH_Gen. More...

#include <SMESH_2smeshpy.hxx>

Inheritance diagram for _pyGen:

Public Member Functions
	_pyGen (Resource_DataMapOfAsciiStringAsciiString &theEntry2AccessorMethod, Resource_DataMapOfAsciiStringAsciiString &theObjectNames, std::set< TCollection_AsciiString > &theRemovedObjIDs, const bool theToKeepAllCommands)
	_pyGen constructor More...

	Handle (_pyCommand) AddCommand(const _AString &theCommand)

void	ExchangeCommands (Handle(_pyCommand) theCmd1, Handle(_pyCommand) theCmd2)
	Change order of commands in the script. More...

void	SetCommandAfter (Handle(_pyCommand) theCmd, Handle(_pyCommand) theAfterCmd)
	Set one command after the other. More...

void	SetCommandBefore (Handle(_pyCommand) theCmd, Handle(_pyCommand) theBeforeCmd)
	Set one command before the other. More...

	Handle (_pyCommand) &GetLastCommand()

std::list< Handle(_pyCommand) > &	GetCommands ()

void	PlaceSubmeshAfterItsCreation (Handle(_pyCommand) theCmdUsingSubmesh) const
	Prevent moving a command creating a sub-mesh to the end of the script if the sub-mesh is used in theCmdUsingSubmesh as argument. More...

_pyID	GenerateNewID (const _pyID &theID)
	Generated new ID for object and assign with existing name. More...

bool	AddObject (Handle(_pyObject)&theObj)
	Stores theObj in myObjects. More...

void	CheckObjectIsReCreated (Handle(_pyObject)&theObj)
	Erases an existing object with the same ID. More...

void	SetProxyObject (const _pyID &theID, Handle(_pyObject)&theObj)
	Re-register an object with other ID to make it Process() commands of other object having this ID. More...

	Handle (_pyObject) FindObject(const _pyID &theObjID) const

	Handle (_pySubMesh) FindSubMesh(const _pyID &theSubMeshID)

	Handle (_pyHypothesis) FindHyp(const _pyID &theHypID)

	Handle (_pyHypothesis) FindAlgo(const _pyID &theGeom

const _pyID const	Handle (_pyHypothesis) &theHypothesis)

void	SetAccessorMethod (const _pyID &theID, const char *theMethod)
	Set method to access to object wrapped with python class. More...

bool	AddMeshAccessorMethod (Handle(_pyCommand) theCmd) const
	Add access method to mesh that is an argument. More...

bool	AddAlgoAccessorMethod (Handle(_pyCommand) theCmd) const
	Add access method to algo that is an object or an argument. More...

virtual const char *	AccessorMethod () const
	name of SMESH_Gen in smeshBuilder.py More...

bool	IsGeomObject (const _pyID &theObjID) const

bool	IsNotPublished (const _pyID &theObjID) const

void	ObjectCreationRemoved (const _pyID &theObjID)

void	KeepAgrCmds (const _pyID &theObjID)

bool	IsToKeepAllCommands () const

void	AddExportedMesh (const _AString &file, const ExportedMeshData &mesh)

ExportedMeshData &	FindExportedMesh (const _AString &file)

virtual void	Process (const Handle(_pyCommand)&theCommand)
	Convert the command or remember it for later conversion. More...

virtual void	Flush ()
	Convert the remembered commands. More...

virtual void	ClearCommands ()
	Clean commands of removed objects depending on myIsPublished flag. More...

virtual void	Free ()
	Release mutual handles of objects. More...

	Handle (_pyHypothesisReader) GetHypothesisReader() const

const _pyID &	GetID ()

int	GetNbCalls () const

bool	IsInStudy () const

virtual void	SetRemovedFromStudy (const bool isRemoved)

void	SetCreationCmd (Handle(_pyCommand) cmd)

int	GetCommandNb ()

void	AddProcessedCmd (const Handle(_pyCommand) &cmd)

std::list< Handle(_pyCommand) > &	GetProcessedCmds ()

void	AddArgCmd (const Handle(_pyCommand) &cmd)

virtual void	Process (const Handle(_pyCommand) &cmd)

virtual bool	CanClear ()
	Return true if all my users can be cleared. More...

Static Public Member Functions
static _pyID	FatherID (const _pyID &childID)
	Return ID of a father. More...

Data Fields
const _pyID &	theMesh

Protected Member Functions
void	setID (const _pyID &theID)
	Set up myID and myIsPublished. More...

Protected Attributes
_pyID	myID

std::list< Handle(_pyCommand) >	myProcessedCmds

std::list< Handle(_pyCommand) >	myArgCmds

bool	myIsPublished

Private Member Functions
void	setNeighbourCommand (Handle(_pyCommand)&theCmd, Handle(_pyCommand)&theOtherCmd, const bool theIsAfter)
	Set one command before or after the other. More...

	Handle (_pyCommand) myLastCommand

	Handle (_pyHypothesisReader) myHypReader

Private Attributes
std::map< _pyID, Handle(_pyMesh) >	myMeshes

std::map< _pyID, Handle(_pyMeshEditor) >	myMeshEditors

std::map< _pyID, Handle(_pyHypothesis) >	myHypos

std::map< _pyID, Handle(_pyObject) >	myObjects

std::list< Handle(_pyObject) >	myOrderedObjects

_pyStringFamily	myKeepAgrCmdsIDs

std::list< Handle(_pyCommand) >	myCommands

int	myNbCommands

Resource_DataMapOfAsciiStringAsciiString &	myID2AccessorMethod

Resource_DataMapOfAsciiStringAsciiString &	myObjectNames

std::set< TCollection_AsciiString > &	myRemovedObjIDs

int	myNbFilters

bool	myToKeepAllCommands

int	myGeomIDNb

int	myGeomIDIndex

int	myShaperIDNb

int	myShaperIDIndex

std::map< _AString, ExportedMeshData >	myFile2ExportedMesh

Detailed Description

Class corresponding to SMESH_Gen.

It holds info on existing meshes and hypotheses

Constructor & Destructor Documentation

◆ _pyGen()

_pyGen::_pyGen	(	Resource_DataMapOfAsciiStringAsciiString &	theEntry2AccessorMethod,
		Resource_DataMapOfAsciiStringAsciiString &	theObjectNames,
		std::set< TCollection_AsciiString > &	theRemovedObjIDs,
		const bool	theToKeepAllCommands
	)

_pyGen constructor

References SMESH_Gen_i::GetSMESHGen(), SMESH_Gen_i::getStudyServant(), _pyCommand::IsStudyEntry(), myGeomIDIndex, myGeomIDNb, myShaperIDIndex, and myShaperIDNb.

Member Function Documentation

◆ AccessorMethod()

const char * _pyGen::AccessorMethod ( ) const

virtual

name of SMESH_Gen in smeshBuilder.py

Reimplemented from _pyObject.

References SMESH_2smeshpy::GenName().

◆ AddAlgoAccessorMethod()

bool _pyGen::AddAlgoAccessorMethod ( Handle(_pyCommand) theCmd ) const

Add access method to algo that is an object or an argument.

Parameters

theCmd - command to add access method

Return values

bool	- true if added

References _pyCommand::AddAccessorMethod(), Handle(), and myHypos.

◆ AddArgCmd()

void _pyObject::AddArgCmd ( const Handle(_pyCommand) & cmd )

inherited

References _pyObject::myArgCmds.

◆ AddExportedMesh()

void _pyGen::AddExportedMesh	(	const _AString &	file,
		const ExportedMeshData &	mesh
	)

References myFile2ExportedMesh.

◆ AddMeshAccessorMethod()

bool _pyGen::AddMeshAccessorMethod ( Handle(_pyCommand) theCmd ) const

Add access method to mesh that is an argument.

Parameters

theCmd - command to add access method

Return values

bool	- true if added

References _pyCommand::AddAccessorMethod(), Handle(), and myMeshes.

Referenced by Handle(), and Process().

◆ AddObject()

bool _pyGen::AddObject ( Handle(_pyObject)& theObj )

Stores theObj in myObjects.

References CheckObjectIsReCreated(), SMESH::DownCast(), _pyObject::GetID(), Handle(), myMeshEditors, myMeshes, myObjects, and myOrderedObjects.

Referenced by Handle(), and Process().

◆ AddProcessedCmd()

void _pyObject::AddProcessedCmd ( const Handle(_pyCommand) & cmd )

inherited

References _pyObject::myProcessedCmds.

Referenced by _pyObject::Process().

◆ CanClear()

bool _pyObject::CanClear ( )

virtualinherited

Return true if all my users can be cleared.

Reimplemented in _pyMesh, _pyMeshEditor, _pyHypothesis, _pySelfEraser, and _pyGroup.

References _pyObject::Handle(), _pyObject::myArgCmds, and _pyObject::myIsPublished.

Referenced by _pyObject::ClearCommands().

◆ CheckObjectIsReCreated()

void _pyGen::CheckObjectIsReCreated ( Handle(_pyObject)& theObj )

Erases an existing object with the same ID.

This method should be called before storing theObj in _pyGen

References _pyObject::GetID(), Handle(), _pyCommand::IsStudyEntry(), myHypos, myMeshes, and myObjects.

Referenced by AddObject(), Handle(), and Process().

◆ ClearCommands()

void _pyGen::ClearCommands ( )

virtual

Clean commands of removed objects depending on myIsPublished flag.

Reimplemented from _pyObject.

References Handle(), myHypos, myMeshes, and myOrderedObjects.

◆ ExchangeCommands()

void _pyGen::ExchangeCommands	(	Handle(_pyCommand)	theCmd1,
		Handle(_pyCommand)	theCmd2
	)

Change order of commands in the script.

Parameters

theCmd1	- One command
theCmd2	- Another command

References _pyCommand::GetOrderNb(), Handle(), myCommands, and _pyCommand::SetOrderNb().

◆ FatherID()

_pyID _pyObject::FatherID ( const _pyID & childID )

staticinherited

Return ID of a father.

Referenced by _pySegmentLengthAroundVertexHyp::Addition2Creation().

◆ FindExportedMesh()

ExportedMeshData & _pyGen::FindExportedMesh ( const _AString & file )

References myFile2ExportedMesh.

◆ Flush()

void _pyGen::Flush ( )

virtual

Convert the remembered commands.

Implements _pyObject.

References SMESH_2smeshpy::GenName(), Handle(), IsToKeepAllCommands(), myCommands, myHypos, myMeshes, myNbCommands, myObjects, and myOrderedObjects.

◆ Free()

void _pyGen::Free ( )

virtual

Release mutual handles of objects.

Reimplemented from _pyObject.

References Handle(), myFile2ExportedMesh, myHypos, myMeshEditors, myMeshes, and myObjects.

◆ GenerateNewID()

_pyID _pyGen::GenerateNewID ( const _pyID & theID )

Generated new ID for object and assign with existing name.

Parameters

theID - ID of existing object

References myObjectNames.

◆ GetCommandNb()

int _pyObject::GetCommandNb ( )

inherited

◆ GetCommands()

std::list< Handle(_pyCommand) > & _pyGen::GetCommands ( )

References myCommands.

◆ GetID()

const _pyID & _pyObject::GetID ( )

inherited

References _pyObject::myID.

Referenced by _pyFilter::_pyFilter(), _pySelfEraser::_pySelfEraser(), _pySubMesh::_pySubMesh(), _pyMesh::addFatherMesh(), _pyHypothesis::Addition2Creation(), _pyAlgorithm::Addition2Creation(), AddObject(), _pySelfEraser::CanClear(), _pyGroup::CanClear(), CheckObjectIsReCreated(), _pyMesh::Flush(), _pyFilter::Flush(), Handle(), _pyMesh::Process(), _pyFilter::Process(), and _pyObject::setID().

◆ GetNbCalls()

int _pyObject::GetNbCalls ( ) const

inherited

References _pyObject::myProcessedCmds.

Referenced by _pySubMesh::Flush(), and _pyFilter::Process().

◆ GetProcessedCmds()

std::list< Handle(_pyCommand) > & _pyObject::GetProcessedCmds ( )

inherited

References _pyObject::myProcessedCmds.

Referenced by _pySelfEraser::CanClear().

◆ Handle() [1/10]

_pyGen::Handle ( _pyCommand ) &

◆ Handle() [2/10]

_pyGen::Handle ( _pyCommand ) const &

Referenced by AddAlgoAccessorMethod(), AddMeshAccessorMethod(), AddObject(), CheckObjectIsReCreated(), ClearCommands(), ExchangeCommands(), Flush(), Free(), Handle(), Process(), setNeighbourCommand(), and SetProxyObject().

◆ Handle() [3/10]

_pyGen::Handle ( _pyCommand )

private

◆ Handle() [4/10]

const _pyID const _pyGen::Handle ( _pyHypothesis ) &

◆ Handle() [5/10]

_pyGen::Handle ( _pyHypothesis ) const &

◆ Handle() [6/10]

_pyGen::Handle ( _pyHypothesis ) const &

◆ Handle() [7/10]

_pyGen::Handle ( _pyHypothesisReader ) const

◆ Handle() [8/10]

_pyGen::Handle ( _pyHypothesisReader )

private

◆ Handle() [9/10]

_pyGen::Handle ( _pyObject ) const &

◆ Handle() [10/10]

_pyGen::Handle ( _pySubMesh ) const &

◆ IsGeomObject()

bool _pyGen::IsGeomObject ( const _pyID & theObjID ) const

◆ IsInStudy()

bool _pyObject::IsInStudy ( ) const

inherited

References _pyObject::myIsPublished.

Referenced by _pyMesh::CanClear(), _pyHypothesis::CanClear(), _pyGroup::CanClear(), _pyMesh::ClearCommands(), _pyHypothesis::GetReferredMeshesAndGeom(), and _pyHypothesis::IsWrappable().

◆ IsNotPublished()

bool _pyGen::IsNotPublished ( const _pyID & theObjID ) const

◆ IsToKeepAllCommands()

bool _pyGen::IsToKeepAllCommands ( ) const

References myToKeepAllCommands.

Referenced by Flush().

◆ KeepAgrCmds()

void _pyGen::KeepAgrCmds ( const _pyID & theObjID )

References _pyStringFamily::Add(), and myKeepAgrCmdsIDs.

◆ ObjectCreationRemoved()

void _pyGen::ObjectCreationRemoved ( const _pyID & theObjID )

◆ PlaceSubmeshAfterItsCreation()

void _pyGen::PlaceSubmeshAfterItsCreation ( Handle(_pyCommand) theCmdUsingSubmesh ) const

Prevent moving a command creating a sub-mesh to the end of the script if the sub-mesh is used in theCmdUsingSubmesh as argument.

◆ Process() [1/2]

virtual void _pyObject::Process ( const Handle(_pyCommand) & cmd )

virtualinherited

References _pyObject::AddProcessedCmd().

Referenced by _pySubMesh::Process(), and _pyFilter::Process().

◆ Process() [2/2]

void _pyGen::Process ( const Handle(_pyCommand)& theCommand )

virtual

Convert the command or remember it for later conversion.

Parameters

theCommand - The python command calling a method of SMESH_Gen

References AddMeshAccessorMethod(), AddObject(), CheckObjectIsReCreated(), _pyCommand::Clear(), SMESH_2smeshpy::GenName(), _pyCommand::GetArg(), _pyCommand::GetMethod(), _pyCommand::GetNbArgs(), _pyCommand::GetResultValue(), _pyCommand::GetStudyEntries(), Handle(), myHypos, myMeshes, myObjectNames, _pyCommand::RemoveArgs(), _pyCommand::SetArg(), _pyCommand::SetMethod(), _pyCommand::SetObject(), and SMESH_2smeshpy::SmeshpyName().

Referenced by Handle().

◆ SetAccessorMethod()

void _pyGen::SetAccessorMethod	(	const _pyID &	theID,
		const char *	theMethod
	)

Set method to access to object wrapped with python class.

Parameters

theID	- The wrapped object entry
theMethod	- The accessor method

References myID2AccessorMethod.

◆ SetCommandAfter()

void _pyGen::SetCommandAfter	(	Handle(_pyCommand)	theCmd,
		Handle(_pyCommand)	theAfterCmd
	)

Set one command after the other.

Parameters

theCmd	- Command to move
theAfterCmd	- Command ater which to insert the first one

References setNeighbourCommand().

◆ SetCommandBefore()

void _pyGen::SetCommandBefore	(	Handle(_pyCommand)	theCmd,
		Handle(_pyCommand)	theBeforeCmd
	)

Set one command before the other.

Parameters

theCmd	- Command to move
theBeforeCmd	- Command before which to insert the first one

References setNeighbourCommand().

◆ SetCreationCmd()

void _pyObject::SetCreationCmd ( Handle(_pyCommand) cmd )

inherited

Referenced by _pyHypothesis::Addition2Creation().

◆ setID()

void _pyObject::setID ( const _pyID & theID )

protectedinherited

Set up myID and myIsPublished.

References _pyObject::GetID(), _pyObject::myID, and _pyObject::myIsPublished.

Referenced by _pyGroup::_pyGroup(), and _pyObject::_pyObject().

◆ setNeighbourCommand()

void _pyGen::setNeighbourCommand	(	Handle(_pyCommand)&	theCmd,
		Handle(_pyCommand)&	theOtherCmd,
		const bool	theIsAfter
	)

private

Set one command before or after the other.

Parameters

theCmd	- Command to move
theOtherCmd	- Command ater or before which to insert the first one

References Handle(), and myCommands.

Referenced by SetCommandAfter(), and SetCommandBefore().

◆ SetProxyObject()

void _pyGen::SetProxyObject	(	const _pyID &	theID,
		Handle(_pyObject)&	theObj
	)

Re-register an object with other ID to make it Process() commands of other object having this ID.

References SMESH::DownCast(), Handle(), myMeshEditors, myMeshes, and myObjects.

◆ SetRemovedFromStudy()

virtual void _pyObject::SetRemovedFromStudy ( const bool isRemoved )

virtualinherited

Reimplemented in _pyMesh.

References _pyObject::myIsPublished.

Referenced by _pyMesh::SetRemovedFromStudy().

Field Documentation

◆ myArgCmds

std::list< Handle(_pyCommand) > _pyObject::myArgCmds

protectedinherited

Referenced by _pyObject::AddArgCmd(), _pyObject::CanClear(), _pySelfEraser::CanClear(), _pySubMesh::Flush(), and _pyFilter::Flush().

◆ myCommands

std::list< Handle(_pyCommand) > _pyGen::myCommands

private

Referenced by ExchangeCommands(), Flush(), GetCommands(), Handle(), and setNeighbourCommand().

◆ myFile2ExportedMesh

std::map< _AString, ExportedMeshData > _pyGen::myFile2ExportedMesh

private

Referenced by AddExportedMesh(), FindExportedMesh(), and Free().

◆ myGeomIDIndex

int _pyGen::myGeomIDIndex

private

Referenced by _pyGen().

◆ myGeomIDNb

int _pyGen::myGeomIDNb

private

Referenced by _pyGen().

◆ myHypos

std::map< _pyID, Handle(_pyHypothesis) > _pyGen::myHypos

private

Referenced by AddAlgoAccessorMethod(), CheckObjectIsReCreated(), ClearCommands(), Flush(), Free(), Handle(), and Process().

◆ myID

_pyID _pyObject::myID

protectedinherited

Referenced by _pyObject::GetID(), and _pyObject::setID().

◆ myID2AccessorMethod

Resource_DataMapOfAsciiStringAsciiString& _pyGen::myID2AccessorMethod

private

Referenced by SetAccessorMethod().

◆ myIsPublished

bool _pyObject::myIsPublished

protectedinherited

Referenced by _pySelfEraser::_pySelfEraser(), _pyObject::CanClear(), _pySelfEraser::Flush(), _pyObject::IsInStudy(), _pyObject::setID(), and _pyObject::SetRemovedFromStudy().

◆ myKeepAgrCmdsIDs

_pyStringFamily _pyGen::myKeepAgrCmdsIDs

private

Referenced by Handle(), and KeepAgrCmds().

◆ myMeshEditors

std::map< _pyID, Handle(_pyMeshEditor) > _pyGen::myMeshEditors

private

Referenced by AddObject(), Free(), Handle(), and SetProxyObject().

◆ myMeshes

std::map< _pyID, Handle(_pyMesh) > _pyGen::myMeshes

private

Referenced by AddMeshAccessorMethod(), AddObject(), CheckObjectIsReCreated(), ClearCommands(), Flush(), Free(), Handle(), Process(), and SetProxyObject().

◆ myNbCommands

int _pyGen::myNbCommands

private

Referenced by Flush(), and Handle().

◆ myNbFilters

int _pyGen::myNbFilters

private

Referenced by Handle().

◆ myObjectNames

Resource_DataMapOfAsciiStringAsciiString& _pyGen::myObjectNames

private

Referenced by GenerateNewID(), and Process().

◆ myObjects

std::map< _pyID, Handle(_pyObject) > _pyGen::myObjects

private

Referenced by AddObject(), CheckObjectIsReCreated(), Flush(), Free(), Handle(), and SetProxyObject().

◆ myOrderedObjects

std::list< Handle(_pyObject) > _pyGen::myOrderedObjects

private

Referenced by AddObject(), ClearCommands(), and Flush().

◆ myProcessedCmds

std::list< Handle(_pyCommand) > _pyObject::myProcessedCmds

protectedinherited

Referenced by _pyObject::AddProcessedCmd(), _pyObject::ClearCommands(), _pyObject::GetNbCalls(), and _pyObject::GetProcessedCmds().

◆ myRemovedObjIDs

std::set< TCollection_AsciiString >& _pyGen::myRemovedObjIDs

private

◆ myShaperIDIndex

int _pyGen::myShaperIDIndex

private

Referenced by _pyGen().

◆ myShaperIDNb

int _pyGen::myShaperIDNb

private

Referenced by _pyGen().

◆ myToKeepAllCommands

bool _pyGen::myToKeepAllCommands

private

Referenced by IsToKeepAllCommands().

◆ theMesh

const _pyID& _pyGen::theMesh

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ _pyGen()

Member Function Documentation

◆ AccessorMethod()

◆ AddAlgoAccessorMethod()

◆ AddArgCmd()

◆ AddExportedMesh()

◆ AddMeshAccessorMethod()

◆ AddObject()

◆ AddProcessedCmd()

◆ CanClear()

◆ CheckObjectIsReCreated()

◆ ClearCommands()

◆ ExchangeCommands()

◆ FatherID()

◆ FindExportedMesh()

◆ Flush()

◆ Free()

◆ GenerateNewID()

◆ GetCommandNb()

◆ GetCommands()

◆ GetID()

◆ GetNbCalls()

◆ GetProcessedCmds()

◆ Handle() [1/10]

◆ Handle() [2/10]

◆ Handle() [3/10]

◆ Handle() [4/10]

◆ Handle() [5/10]

◆ Handle() [6/10]

◆ Handle() [7/10]

◆ Handle() [8/10]

◆ Handle() [9/10]

◆ Handle() [10/10]

◆ IsGeomObject()

◆ IsInStudy()

◆ IsNotPublished()

◆ IsToKeepAllCommands()

◆ KeepAgrCmds()

◆ ObjectCreationRemoved()

◆ PlaceSubmeshAfterItsCreation()

◆ Process() [1/2]

◆ Process() [2/2]

◆ SetAccessorMethod()

◆ SetCommandAfter()

◆ SetCommandBefore()

◆ SetCreationCmd()

◆ setID()

◆ setNeighbourCommand()

◆ SetProxyObject()

◆ SetRemovedFromStudy()

Field Documentation

◆ myArgCmds

◆ myCommands

◆ myFile2ExportedMesh

◆ myGeomIDIndex

◆ myGeomIDNb

◆ myHypos

◆ myID

◆ myID2AccessorMethod

◆ myIsPublished

◆ myKeepAgrCmdsIDs

◆ myMeshEditors

◆ myMeshes

◆ myNbCommands

◆ myNbFilters

◆ myObjectNames

◆ myObjects

◆ myOrderedObjects

◆ myProcessedCmds

◆ myRemovedObjIDs

◆ myShaperIDIndex