SMESH::TPythonDump Class Reference

Utility helping in storing SMESH engine calls as python commands. More...

#include <SMESH_PythonDump.hxx>

Public Member Functions
	TPythonDump ()
virtual	~TPythonDump ()
TPythonDump &	operator<< (const TVar &theVariableValue)
	< store a variable value. Write either a value or '$varID$' More...
TPythonDump &	operator<< (long int theArg)
TPythonDump &	operator<< (int theArg)
TPythonDump &	operator<< (double theArg)
TPythonDump &	operator<< (float theArg)
TPythonDump &	operator<< (const void *theArg)
TPythonDump &	operator<< (const char *theArg)
TPythonDump &	operator<< (const SMESH::ElementType &theArg)
TPythonDump &	operator<< (const SMESH::GeometryType &theArg)
TPythonDump &	operator<< (const SMESH::EntityType &theArg)
TPythonDump &	operator<< (const SMESH::long_array &theArg)
TPythonDump &	operator<< (const SMESH::double_array &theArg)
TPythonDump &	operator<< (const SMESH::string_array &theArg)
TPythonDump &	operator<< (const SMESH::nodes_array &theArg)
TPythonDump &	operator<< (SMESH::SMESH_Hypothesis_ptr theArg)
TPythonDump &	operator<< (SMESH::SMESH_IDSource_ptr theArg)
TPythonDump &	operator<< (SALOMEDS::SObject_ptr theArg)
TPythonDump &	operator<< (CORBA::Object_ptr theArg)
TPythonDump &	operator<< (SMESH::FilterLibrary_i *theArg)
TPythonDump &	operator<< (SMESH::FilterManager_i *theArg)
TPythonDump &	operator<< (SMESH::Filter_i *theArg)
TPythonDump &	operator<< (SMESH::Functor_i *theArg)
TPythonDump &	operator<< (SMESH::Measurements_i *theArg)
TPythonDump &	operator<< (SMESH_Gen_i *theArg)
TPythonDump &	operator<< (SMESH_MeshEditor_i *theArg)
TPythonDump &	operator<< (SMESH::MED_VERSION theArg)
TPythonDump &	operator<< (const SMESH::AxisStruct &theAxis)
TPythonDump &	operator<< (const SMESH::DirStruct &theDir)
TPythonDump &	operator<< (const SMESH::PointStruct &P)
TPythonDump &	operator<< (const TCollection_AsciiString &theArg)
TPythonDump &	operator<< (const SMESH::ListOfGroups &theList)
TPythonDump &	operator<< (const SMESH::ListOfGroups *theList)
TPythonDump &	operator<< (const GEOM::ListOfGO &theList)
TPythonDump &	operator<< (const GEOM::ListOfGBO &theList)
TPythonDump &	operator<< (const SMESH::ListOfIDSources &theList)
TPythonDump &	operator<< (const SMESH::CoincidentFreeBorders &theCFB)
TPythonDump &	operator<< (const std::string &theArg)

Static Public Member Functions
static const char *	SMESHGenName ()
static const char *	MeshEditorName ()
static const char *	NotPublishedObjectName ()
static TCollection_AsciiString	LongStringStart (const char *type)
	Return marker of long string literal beginning. More...
static TCollection_AsciiString	LongStringEnd ()
	Return marker of long string literal end. More...
static bool	CutoutLongString (TCollection_AsciiString &theText, int &theFrom, TCollection_AsciiString &theLongString, TCollection_AsciiString &theStringType)
	Cut out a long string literal from a string. More...

Private Attributes
std::ostringstream	myStream
int	myVarsCounter

Static Private Attributes
static size_t	myCounter = 0

Detailed Description

Utility helping in storing SMESH engine calls as python commands.

Constructor & Destructor Documentation

SMESH::TPythonDump::TPythonDump

(

)

References myCounter.

SMESH::TPythonDump::~TPythonDump ( )

virtual

References SMESH_Gen_i::AddToPythonScript(), SMESH_Gen_i::GetCurrentStudy(), SMESH_Gen_i::GetLastObjEntry(), SMESH_Gen_i::GetSMESHGen(), MESSAGE, myCounter, myStream, SMESH::TVar::ObjPrefix(), and SMESH_Gen_i::UpdateParameters().

Member Function Documentation

bool SMESH::TPythonDump::CutoutLongString ( TCollection_AsciiString &  theText, int &  theFrom, TCollection_AsciiString &  theLongString, TCollection_AsciiString &  theStringType  )

static

Cut out a long string literal from a string.

Parameters

theText	- text possibly containing string literals
theFrom	- position in the text to search from
theLongString	- the retrieved literal
theStringType	- a name of functionality produced the literal

Return values

bool	- true if a string literal found

The literal is removed from theText; theFrom points position right after the removed literal

References SMESH::myLongStringEnd(), and SMESH::myLongStringStart().

Referenced by SMESH_Gen_i::DumpPython_impl().

TCollection_AsciiString SMESH::TPythonDump::LongStringEnd ( )

static

Return marker of long string literal end.

Return values

TCollection_AsciiString

- the marker string to be written into a raw python script

References SMESH::myLongStringEnd().

TCollection_AsciiString SMESH::TPythonDump::LongStringStart ( const char *  type )

static

Return marker of long string literal beginning.

Parameters

type	- a name of functionality producing the string literal

Return values

TCollection_AsciiString

- the marker string to be written into a raw python script

References SMESH::myLongStringStart().

static const char* SMESH::TPythonDump::MeshEditorName ( )

static

Referenced by operator<<().

const char * SMESH::TPythonDump::NotPublishedObjectName ( )

static

References SMESH::theNotPublishedObjectName.

TPythonDump & SMESH::TPythonDump::operator<<

(

const TVar &

theVariableValue

)

< store a variable value. Write either a value or '$varID$'

References SMESH_Gen_i::GetLastParamIndices(), SMESH_Gen_i::GetSMESHGen(), SMESH::TVar::myIsList, myStream, SMESH::TVar::myVals, myVarsCounter, and SMESH::TVar::Quote().

TPythonDump & SMESH::TPythonDump::operator<<

(

long int

theArg

)

References myStream.

TPythonDump & SMESH::TPythonDump::operator<<

(

int

theArg

)

References myStream.

TPythonDump & SMESH::TPythonDump::operator<<

(

double

theArg

)

References myStream.

TPythonDump & SMESH::TPythonDump::operator<<

(

float

theArg

)

References myStream.

TPythonDump & SMESH::TPythonDump::operator<<

(

const void *

theArg

)

References myStream.

TPythonDump & SMESH::TPythonDump::operator<<

(

const char *

theArg

)

References myStream.

TPythonDump & SMESH::TPythonDump::operator<<

(

const SMESH::ElementType &

theArg

)

References SMESH::ALL, SMESH::BALL, SMESH::EDGE, SMESH::ELEM0D, SMESH::FACE, myStream, SMESH::NODE, and SMESH::VOLUME.

TPythonDump & SMESH::TPythonDump::operator<<

(

const SMESH::GeometryType &

theArg

)

References SMESH::Geom_BALL, SMESH::Geom_EDGE, SMESH::Geom_HEXA, SMESH::Geom_PENTA, SMESH::Geom_POINT, SMESH::Geom_POLYGON, SMESH::Geom_POLYHEDRA, SMESH::Geom_PYRAMID, SMESH::Geom_QUADRANGLE, SMESH::Geom_TETRA, SMESH::Geom_TRIANGLE, and myStream.

TPythonDump & SMESH::TPythonDump::operator<<

(

const SMESH::EntityType &

theArg

)

References SMESH::Entity_0D, SMESH::Entity_Ball, SMESH::Entity_BiQuad_Quadrangle, SMESH::Entity_BiQuad_Triangle, SMESH::Entity_Edge, SMESH::Entity_Hexa, SMESH::Entity_Hexagonal_Prism, SMESH::Entity_Last, SMESH::Entity_Penta, SMESH::Entity_Polygon, SMESH::Entity_Polyhedra, SMESH::Entity_Pyramid, SMESH::Entity_Quad_Edge, SMESH::Entity_Quad_Hexa, SMESH::Entity_Quad_Penta, SMESH::Entity_Quad_Polygon, SMESH::Entity_Quad_Polyhedra, SMESH::Entity_Quad_Pyramid, SMESH::Entity_Quad_Quadrangle, SMESH::Entity_Quad_Tetra, SMESH::Entity_Quad_Triangle, SMESH::Entity_Quadrangle, SMESH::Entity_Tetra, SMESH::Entity_Triangle, SMESH::Entity_TriQuad_Hexa, and myStream.

TPythonDump & SMESH::TPythonDump::operator<<

(

const SMESH::long_array &

theArg

)

References SMESH::DumpArray().

TPythonDump & SMESH::TPythonDump::operator<<

(

const SMESH::double_array &

theArg

)

References SMESH::DumpArray().

TPythonDump & SMESH::TPythonDump::operator<<

(

const SMESH::string_array &

theArg

)

References myStream.

TPythonDump & SMESH::TPythonDump::operator<<

(

const SMESH::nodes_array &

theArg

)

References SMESH::DumpArray().

TPythonDump & SMESH::TPythonDump::operator<<

(

SMESH::SMESH_Hypothesis_ptr

theArg

)

References SMESH_Gen_i::GetCurrentStudy(), SMESH_Gen_i::GetSMESHGen(), myStream, and SMESH_Gen_i::ObjectToSObject().

TPythonDump & SMESH::TPythonDump::operator<<

(

SMESH::SMESH_IDSource_ptr

theArg

)

References SMESH::ALL, SMESH_Gen_i::GetCurrentStudy(), SMESH_Gen_i::GetSMESHGen(), SMESH_MeshEditor_i::IsTemporaryIDSource(), SMESH_Gen_i::ObjectToSObject(), and SMESH::theNotPublishedObjectName.

TPythonDump & SMESH::TPythonDump::operator<<

(

SALOMEDS::SObject_ptr

theArg

)

References myStream, and SMESH::theNotPublishedObjectName.

TPythonDump & SMESH::TPythonDump::operator<<

(

CORBA::Object_ptr

theArg

)

References SMESH_Gen_i::CanPublishInStudy(), SMESH_Gen_i::GetCurrentStudy(), SMESH_Gen_i::GetSMESHGen(), myStream, SMESH_Gen_i::ObjectToSObject(), and SMESH::theNotPublishedObjectName.

TPythonDump & SMESH::TPythonDump::operator<<

(

SMESH::FilterLibrary_i *

theArg

)

References myStream.

TPythonDump & SMESH::TPythonDump::operator<<

(

SMESH::FilterManager_i *

theArg

)

References myStream.

TPythonDump & SMESH::TPythonDump::operator<<

(

SMESH::Filter_i *

theArg

)

References myStream.

TPythonDump & SMESH::TPythonDump::operator<<

(

SMESH::Functor_i *

theArg

)

References SMESH::FT_Area, SMESH::FT_AspectRatio, SMESH::FT_AspectRatio3D, SMESH::FT_BadOrientedVolume, SMESH::FT_BallDiameter, SMESH::FT_BareBorderFace, SMESH::FT_BareBorderVolume, SMESH::FT_BelongToCylinder, SMESH::FT_BelongToGenSurface, SMESH::FT_BelongToGeom, SMESH::FT_BelongToMeshGroup, SMESH::FT_BelongToPlane, SMESH::FT_ConnectedElements, SMESH::FT_CoplanarFaces, SMESH::FT_ElemGeomType, SMESH::FT_EntityType, SMESH::FT_EqualEdges, SMESH::FT_EqualFaces, SMESH::FT_EqualNodes, SMESH::FT_EqualTo, SMESH::FT_EqualVolumes, SMESH::FT_FreeBorders, SMESH::FT_FreeEdges, SMESH::FT_FreeFaces, SMESH::FT_FreeNodes, SMESH::FT_GroupColor, SMESH::FT_Length, SMESH::FT_Length2D, SMESH::FT_LessThan, SMESH::FT_LinearOrQuadratic, SMESH::FT_LogicalAND, SMESH::FT_LogicalNOT, SMESH::FT_LogicalOR, SMESH::FT_LyingOnGeom, SMESH::FT_MaxElementLength2D, SMESH::FT_MaxElementLength3D, SMESH::FT_MinimumAngle, SMESH::FT_MoreThan, SMESH::FT_MultiConnection, SMESH::FT_MultiConnection2D, SMESH::FT_NodeConnectivityNumber, SMESH::FT_OverConstrainedFace, SMESH::FT_OverConstrainedVolume, SMESH::FT_RangeOfIds, SMESH::FT_Skew, SMESH::FT_Taper, SMESH::FT_Undefined, SMESH::FT_Volume3D, SMESH::FT_Warping, and myStream.

TPythonDump & SMESH::TPythonDump::operator<<

(

SMESH::Measurements_i *

theArg

)

References myStream.

TPythonDump & SMESH::TPythonDump::operator<<

(

SMESH_Gen_i *

theArg

)

References myStream, and SMESHGenName().

TPythonDump & SMESH::TPythonDump::operator<<

(

SMESH_MeshEditor_i *

theArg

)

References SMESH_MeshEditor_i::GetMeshId(), MeshEditorName(), and myStream.

TPythonDump & SMESH::TPythonDump::operator<<

(

SMESH::MED_VERSION

theArg

)

References SMESH::MED_V2_1, SMESH::MED_V2_2, and myStream.

TPythonDump & SMESH::TPythonDump::operator<<

(

const SMESH::AxisStruct &

theAxis

)

References SMESH::AxisStruct::vx, SMESH::AxisStruct::vy, SMESH::AxisStruct::vz, SMESH::AxisStruct::x, SMESH::AxisStruct::y, and SMESH::AxisStruct::z.

TPythonDump & SMESH::TPythonDump::operator<<

(

const SMESH::DirStruct &

theDir

)

References SMESH::DirStruct::PS, SMESH::PointStruct::x, SMESH::PointStruct::y, and SMESH::PointStruct::z.

TPythonDump & SMESH::TPythonDump::operator<<

(

const SMESH::PointStruct &

P

)

References SMESH::PointStruct::x, SMESH::PointStruct::y, and SMESH::PointStruct::z.

TPythonDump & SMESH::TPythonDump::operator<<

(

const TCollection_AsciiString &

theArg

)

References myStream.

TPythonDump & SMESH::TPythonDump::operator<<

(

const SMESH::ListOfGroups &

theList

)

References SMESH::DumpArray().

TPythonDump & SMESH::TPythonDump::operator<<

(

const SMESH::ListOfGroups *

theList

)

References SMESH::DumpArray().

TPythonDump & SMESH::TPythonDump::operator<<

(

const GEOM::ListOfGO &

theList

)

References SMESH::DumpArray().

TPythonDump & SMESH::TPythonDump::operator<<

(

const GEOM::ListOfGBO &

theList

)

References SMESH::DumpArray().

TPythonDump & SMESH::TPythonDump::operator<<

(

const SMESH::ListOfIDSources &

theList

)

References SMESH::DumpArray().

TPythonDump & SMESH::TPythonDump::operator<<

(

const SMESH::CoincidentFreeBorders &

theCFB

)

References SMESH::FreeBorderPart::border, SMESH::CoincidentFreeBorders::borders, SMESH::CoincidentFreeBorders::coincidentGroups, myStream, SMESH::FreeBorderPart::node1, SMESH::FreeBorderPart::node2, SMESH::FreeBorder::nodeIDs, and SMESH::FreeBorderPart::nodeLast.

TPythonDump & SMESH::TPythonDump::operator<<

(

const std::string &

theArg

)

References myStream.

static const char* SMESH::TPythonDump::SMESHGenName ( )

static

Referenced by SMESH_Gen_i::DumpPython_impl(), and operator<<().

Field Documentation

size_t SMESH::TPythonDump::myCounter = 0

staticprivate

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

std::ostringstream SMESH::TPythonDump::myStream

private

Referenced by operator<<(), and ~TPythonDump().

int SMESH::TPythonDump::myVarsCounter

private

Referenced by operator<<().