defines a single data item which was may be exported to a single existing output file. It encapsulates information being found on this data item in the specific file. It can further be configured to be exported. More...

Public Types
enum	DataSource { EXISTING = 0, RANDOM_FIELD, FMOP }
	defines the data source of the exported object More...

enum	enum_format_type { LSDYNA = 0, NASTRAN, QIMAGE, PERMAS, CSV_EXPORT, CSV_ELEMENT_DATA_EXPORT, CSV_NODE_DATA_EXPORT, CSV_SINGLE_SIGNAL_EXPORT, ABAQUS, ANSYS_MECHANICAL_DAT, STL, EXTDATA_COOR, EXTDATA_NODE_DATA, EXTDATA_ELEMENT_DATA }
	defines the format of a file More...

typedef std::set< ExportItemInfo >	ItemSet
	a sorted container of items

typedef std::vector< ExportItemInfo >	ItemVector
	a vector of items

enum	Type { NODE_COOR_X = 0, NODE_COOR_Y, NODE_COOR_Z, NODE_COOR_DEVIATION_X, NODE_COOR_DEVIATION_Y, NODE_COOR_DEVIATION_Z, ELEMENT_SHELL_THICKNESS, ELEMENT_INITIAL_STRAIN_SHELL_XX, ELEMENT_INITIAL_STRAIN_SHELL_YY, ELEMENT_INITIAL_STRAIN_SHELL_ZZ, ELEMENT_INITIAL_STRAIN_SHELL_XY, ELEMENT_INITIAL_STRAIN_SHELL_XZ, ELEMENT_INITIAL_STRAIN_SHELL_YZ, ELEMENT_INITIAL_STRESS_SHELL_XX, ELEMENT_INITIAL_STRESS_SHELL_YY, ELEMENT_INITIAL_STRESS_SHELL_ZZ, ELEMENT_INITIAL_STRESS_SHELL_XY, ELEMENT_INITIAL_STRESS_SHELL_XZ, ELEMENT_INITIAL_STRESS_SHELL_YZ, ELEMENT_INITIAL_STRESS_SHELL_PEEQ, PIXEL_COLOR_RED, PIXEL_COLOR_GREEN, PIXEL_COLOR_BLUE, PIXEL_COLOR_ALPHA, NODE_COOR_DEVIATION_NORM, ALL_SCALAR_QUANTITIES, ELEMENT_DATA, NODE_DATA }
	defines the type of data item (it may be that not all of them are supported by each exporter) More...

Public Member Functions
	ExportItemInfo (string par_filename, enum_format_type par_file_format, bool par_new_file, Type par_data_type, dataobject_types par_object_type, string par_quantity_ident="", string par_design_ident="", DataSource par_data_source=EXISTING)
	constructor More...

	ExportItemInfo (ExportItemInfo other)
	copy constructor More...

	ExportItemInfo ()
	default constructor More...

ExportItemInfo	operator= (ExportItemInfo other)
	copy-assign operator More...

Static Public Member Functions
static string	toScript (Type type)

static ItemSet	toSet (ItemVector items)

static string	toString (Type type)

static string	toString (enum_format_type type)

static string	toString (DataSource type)

static ItemVector	toVector (ItemSet items)

Public Attributes
DataSource	data_source
	defines how the data is to be created (from database, from FMOP, from random field)

Type	data_type
	the kind of data

string	design_ident
	the design ident of the data item to be exported; if empty, then the current design number is token.

enum_format_type	file_format
	the source file format

string	filename
	the name of the source file relative to the base path

	immutable

	mutable

bool	new_file
	do we modify an existing file or do we export to a new file ?

dataobject_types	object_type
	the type of input object (NODE/ELEMENT...)

string	quantity_ident
	the quantity ident of the data item to be exported; if empty, then this item will not be exported. (except for scalar data)

Detailed Description

defines a single data item which was may be exported to a single existing output file. It encapsulates information being found on this data item in the specific file. It can further be configured to be exported.

Member Enumeration Documentation

◆ DataSource

enum DataSource

defines the data source of the exported object

Enumerator
EXISTING	the data object is existing in the data base
RANDOM_FIELD	the data must be created using random field and amplitudes
FMOP	the data must be created using FMOP and input parameters

◆ enum_format_type

enum enum_format_type

defines the format of a file

Note: In order to stay compatible with existing script files, do only append new items to this list! This list will directly influence the sort order in the item vector

Enumerator
LSDYNA	LS-DYNA Dynain format.
NASTRAN	Nastran.
QIMAGE	All image formats supported by the QImage class (bmp, jpg, jpeg, png ...)
PERMAS	Permas.
CSV_EXPORT	CSV file (write from scratch; all scalars will be exported)
CSV_ELEMENT_DATA_EXPORT	CSV file (write from scratch; all scalars will be exported)
CSV_NODE_DATA_EXPORT	CSV file (write from scratch; all scalars will be exported)
CSV_SINGLE_SIGNAL_EXPORT	CSV file (write from scratch; all scalars will be exported)
ABAQUS	Abaqus.
ANSYS_MECHANICAL_DAT	ANSYS Meachnial input file format.
STL	STL binary format.
EXTDATA_COOR	CSV for ANSYS External Data: coordinates and displacements.
EXTDATA_NODE_DATA	CSV for ANSYS External Data: node data.
EXTDATA_ELEMENT_DATA	CSV for ANSYS External Data: element data.

◆ Type

enum Type

defines the type of data item (it may be that not all of them are supported by each exporter)

Note: In order to stay compatible with existing script files, do only append new items to this list! This list will directly influence the sort order in the item vector.

Enumerator
NODE_COOR_X	NODE coordinate x.
NODE_COOR_Y	NODE coordinate y.
NODE_COOR_Z	NODE coordinate z.
NODE_COOR_DEVIATION_X	NODE coordinate deviation x.
NODE_COOR_DEVIATION_Y	NODE coordinate deviation y.
NODE_COOR_DEVIATION_Z	NODE coordinate deviation z.
ELEMENT_SHELL_THICKNESS	ELEMENT shell thickness.
ELEMENT_INITIAL_STRAIN_SHELL_XX	ELEMENT shell, initial strain tensor for shell elements, xx.
ELEMENT_INITIAL_STRAIN_SHELL_YY	ELEMENT shell, initial strain tensor for shell elements, yy.
ELEMENT_INITIAL_STRAIN_SHELL_ZZ	ELEMENT shell, initial strain tensor for shell elements, zz.
ELEMENT_INITIAL_STRAIN_SHELL_XY	ELEMENT shell, initial strain tensor for shell elements, xy.
ELEMENT_INITIAL_STRAIN_SHELL_XZ	ELEMENT shell, initial strain tensor for shell elements, xz.
ELEMENT_INITIAL_STRAIN_SHELL_YZ	ELEMENT shell, initial strain tensor for shell elements, yz.
ELEMENT_INITIAL_STRESS_SHELL_XX	ELEMENT shell, initial stress tensor for shell elements, xx.
ELEMENT_INITIAL_STRESS_SHELL_YY	ELEMENT shell, initial stress tensor for shell elements, yy.
ELEMENT_INITIAL_STRESS_SHELL_ZZ	ELEMENT shell, initial stress tensor for shell elements, zz.
ELEMENT_INITIAL_STRESS_SHELL_XY	ELEMENT shell, initial stress tensor for shell elements, xy.
ELEMENT_INITIAL_STRESS_SHELL_XZ	ELEMENT shell, initial stress tensor for shell elements, xz.
ELEMENT_INITIAL_STRESS_SHELL_YZ	ELEMENT shell, initial stress tensor for shell elements, yz.
ELEMENT_INITIAL_STRESS_SHELL_PEEQ	ELEMENT shell, initial plastic strain (property of initial stress tensor)
PIXEL_COLOR_RED	PIXEL, (A)RGB color channel red.
PIXEL_COLOR_GREEN	PIXEL, (A)RGB color channel green.
PIXEL_COLOR_BLUE	PIXEL, (A)RGB color channel blue.
PIXEL_COLOR_ALPHA	PIXEL, ARGB channel alpha part.
NODE_COOR_DEVIATION_NORM	NODE coordinate normal deviation.
ALL_SCALAR_QUANTITIES	SCALAR data - all data will be exported.
ELEMENT_DATA	generic element data object
NODE_DATA	generic node data object

Constructor & Destructor Documentation

◆ ExportItemInfo() [1/3]

ExportItemInfo	(	string	par_filename,
		enum_format_type	par_file_format,
		bool	par_new_file,
		Type	par_data_type,
		dataobject_types	par_object_type,
		string	par_quantity_ident = `""`,
		string	par_design_ident = `""`,
		DataSource	par_data_source = `EXISTING`
	)

constructor

Parameters

par_filename	sets filename
par_file_format	sets file_format
par_data_type	sets data_type
par_object_type	sets object_type
par_quantity_ident	sets quantity_ident
par_design_ident	sets design_ident

◆ ExportItemInfo() [2/3]

ExportItemInfo ( ExportItemInfo other )

copy constructor

Parameters

other the source object

◆ ExportItemInfo() [3/3]

ExportItemInfo ( )

default constructor

Note: do not use it! It is a dummy for usage with SWIG!

Member Function Documentation

◆ operator=()

ExportItemInfo operator= ( ExportItemInfo other )

copy-assign operator

Parameters

other the source object to be copy-assigned

◆ toScript()

static string toScript ( Type type )

static

Returns: a string representation of a given item type in a Lua

Parameters

type	the given item type

◆ toSet()

static ItemSet toSet ( ItemVector items )

static

Returns: a set containing the contents of the given vector

Parameters

items the vector of items to be converted into a set

◆ toString() [1/3]

static string toString ( Type type )

static

Returns: a string representation of a given item type

Parameters

type	the given item type

◆ toString() [2/3]

static string toString ( enum_format_type type )

static

Returns: a string representation of a given file format

Parameters

type	the given file format

◆ toString() [3/3]

static string toString ( DataSource type )

static

Returns: a string representation of a given source type

Parameters

type	the given source type

◆ toVector()

static ItemVector toVector ( ItemSet items )

static

Returns: a vector containing the contents of the given set

Parameters

items the set of items to be converted into a vector

optiSLang 3D Postprocessing Script API 2025 R1

ExportItemInfo Struct Reference

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ DataSource

◆ enum_format_type

◆ Type

Constructor & Destructor Documentation

◆ ExportItemInfo() [1/3]

◆ ExportItemInfo() [2/3]

◆ ExportItemInfo() [3/3]

Member Function Documentation

◆ operator=()

◆ toScript()

◆ toSet()

◆ toString() [1/3]

◆ toString() [2/3]

◆ toString() [3/3]

◆ toVector()

Connect with Ansys