v_sim.Dump¶

Subclasses:: v_sim.DumpData, v_sim.DumpScene

Methods¶

Inherited:: v_sim.FileFormat (19), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`abinit_getStatic` ()
class	`abinit_useAngularBox` (status)
class	`abinit_useReduceCoordinates` (status)
class	`ascii_commentHiddenNodes` (status)
class	`ascii_deleteHiddenNodes` (status)
class	`ascii_expandBox` (status)
class	`ascii_getStatic` ()
class	`ascii_sortElements` (status)
class	`ascii_useAngularBox` (status)
class	`ascii_useReduceCoordinates` (status)
class	`bitmap_pdf_getStatic` ()
class	`bitmap_ps_getStatic` ()
class	`cairo_pdf_getStatic` ()
class	`cairo_setPostFunc` (func)
class	`cairo_svg_getStatic` ()
class	`jpeg_getStatic` ()
class	`png_getStatic` ()
class	`pool_finalize` ()
class	`pool_getAllModules` ()
class	`tiff_getStatic` ()
class	`xyz_expandBox` (status)
class	`xyz_getStatic` ()
class	`xyz_sortElements` (status)
class	`yaml_commentHiddenNodes` (status)
class	`yaml_deleteHiddenNodes` (status)
class	`yaml_expandBox` (status)
class	`yaml_getStatic` ()
class	`yaml_sortElements` (status)
class	`yaml_useReduceCoordinates` (status)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: v_sim.FileFormat (4)

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`v_sim.FileFormat`	r

Class Details¶

class v_sim.Dump(**kwargs)¶

Bases:: v_sim.FileFormat
Abstract:: No
Structure:: v_sim.DumpClass

This structure is used to store a dumping extension. Such an extension is characterized by its v_sim.FileFormat and a method that can write a file from the current rendered data.

classmethod abinit_getStatic()¶

Returns:: a newly created dump object to create ABINIT files.
Return type:: v_sim.DumpData

This routine returns the ABINIT dump object.

classmethod abinit_useAngularBox(status)¶

Parameters:: status (bool) – a boolean.

Use the angular form to define the bounding box.

New in version 3.9.

classmethod abinit_useReduceCoordinates(status)¶

Parameters:: status (bool) – a boolean.

Use reduced coordinates on exportation.

New in version 3.9.

classmethod ascii_commentHiddenNodes(status)¶

Parameters:: status (bool) – a boolean.

Comment or not hidden nodes on dump.

New in version 3.9.

classmethod ascii_deleteHiddenNodes(status)¶

Parameters:: status (bool) – a boolean.

Export or not hidden nodes on dump.

New in version 3.9.

classmethod ascii_expandBox(status)¶

Parameters:: status (bool) – a boolean.

Create a bounding box in dump using the extension of the box.

New in version 3.9.

classmethod ascii_getStatic()¶

Returns:: the static dump object to create ASCII files.
Return type:: v_sim.DumpData

This routine is used to get the static v_sim.Dump object for ASCII exportation.

classmethod ascii_sortElements(status)¶

Parameters:: status (bool) – a boolean.

Sort nodes following their element.

New in version 3.9.

classmethod ascii_useAngularBox(status)¶

Parameters:: status (bool) – a boolean.

Use the angular form to define the bounding box.

New in version 3.9.

classmethod ascii_useReduceCoordinates(status)¶

Parameters:: status (bool) – a boolean.

Use reduced coordinates on exportation.

New in version 3.9.

classmethod bitmap_pdf_getStatic()¶

Returns:: a newly created dump object to create PDF files.
Return type:: v_sim.Dump

This routine returns the dump object to PDF (bitmap).

classmethod bitmap_ps_getStatic()¶

Returns:: a newly created dump object to create PS files.
Return type:: v_sim.Dump

This routine returns the dump object to PS (bitmap).

classmethod cairo_pdf_getStatic()¶

Returns:: a newly created dump object to create SVG files.
Return type:: v_sim.Dump

This routine returns the dump object to PDF format.

classmethod cairo_setPostFunc(func)¶

Parameters:: func (v_sim.DumpCairoAdd or None) – a v_sim.DumpCairoAdd function or None.

Allow to add a function that will be called on every Cairo exportation after V_Sim rendering to allow post-processing.

New in version 3.7.

classmethod cairo_svg_getStatic()¶

Returns:: a newly created dump object to create SVG files.
Return type:: v_sim.Dump

This routine returns the dump object to SVG format.

classmethod jpeg_getStatic()¶

Returns:: a newly created dump object to create JPEG files.
Return type:: v_sim.Dump

This routine returns the JPG dump object.

classmethod png_getStatic()¶

Returns:: a newly created dump object to create PNG files.
Return type:: v_sim.Dump

This routine returns the PNG dump object.

classmethod pool_finalize()¶: Free the list of v_sim.Dump modules.

New in version 3.8.

classmethod pool_getAllModules()¶

Returns:: a list of all the known dumping extensions. This list is own by V_Sim and should be considered read-only.
Return type:: [v_sim.Dump]

All dumping extensions are stored in an opaque way in V_Sim. But they can be listed by a call to this method.

classmethod tiff_getStatic()¶

Returns:: a newly created dump object to create TIFF files.
Return type:: v_sim.Dump

This routine returns the dump object in TIFF format.

classmethod xyz_expandBox(status)¶

Parameters:: status (bool) – a boolean.

Create a bounding box in dump using the extension of the box.

New in version 3.9.

classmethod xyz_getStatic()¶

Returns:: a newly created dump object to create XYZ files.
Return type:: v_sim.DumpData

This routine returns the dump object for XYZ format.

classmethod xyz_sortElements(status)¶

Parameters:: status (bool) – a boolean.

Sort nodes following their element.

New in version 3.9.

classmethod yaml_commentHiddenNodes(status)¶

Parameters:: status (bool) – a boolean.

Comment or not hidden nodes on dump.

New in version 3.9.

classmethod yaml_deleteHiddenNodes(status)¶

Parameters:: status (bool) – a boolean.

Export or not hidden nodes on dump.

New in version 3.9.

classmethod yaml_expandBox(status)¶

Parameters:: status (bool) – a boolean.

Create a bounding box in dump using the extension of the box.

New in version 3.9.

classmethod yaml_getStatic()¶

Returns:: the static dump object to create YAML files.
Return type:: v_sim.DumpData

This routine is used to get the static v_sim.Dump object for YAML exportation.

classmethod yaml_sortElements(status)¶

Parameters:: status (bool) – a boolean.

Sort nodes following their element.

New in version 3.9.

classmethod yaml_useReduceCoordinates(status)¶

Parameters:: status (bool) – a boolean.

Use reduced coordinates on exportation.

New in version 3.9.