SReportData Class Reference

Class to store reporting data. Reporting data corresponds to a chapter of a report. SReportData are used to fill a SReport. More...

Inheritance diagram for SReportData:

Public Types
enum	AngleUnit {   Radian , Degree , Gradian , Percent ,   Minute , Second }
enum	AreaUnit {   SquareMicrometer , SquareMillimeter , SquareCentimeter , SquareMeter ,   SquareKilometer , SquareMicroinch , SquareMilliinch , SquareInch ,   SquareFeet , SquareSurveyFeet , SquareYard , SquareMiles }
enum	LengthUnit {   Micrometer , Millimeter , Centimeter , Meter ,   Kilometer , Microinch , Milliinch , Inch ,   Feet , SurveyFeet , Yard , Miles }
enum	VolumeUnit {   CubicMicrometer , CubicMillimeter , CubicCentimeter , CubicMeter ,   CubicKilometer , CubicMicroinch , CubicMilliinch , CubicInch ,   CubicFeet , CubicSurveyFeet , CubicYard , CubicMiles ,   Liter , US_LiquidGallon , US_DryGallon , US_LiquidBarrel ,   US_DryBarrel , US_OilBarrel }
Public Types inherited from SComp
enum	RepresentationTypeEnum {   SMOOTH , FLAT , WIRE , SMOOTH_WIRE ,   FLAT_WIRE , SMOOTH_ROTWIRE , FLAT_ROTWIRE , TEXTURE ,   INSPECTION }
	The different representation types for inherited classes. Use (inherited class).SMOOTH. Example: for a cloud, use SCloud.SMOOTH. More...

Public Slots
	AddAngle (String iName, AngleUnit angleUnit, Number iAngle)
	Add a data corresponding to an angle to a SReportData. More...
	AddArea (String iName, AreaUnit areaUnit, Number iArea)
	Add a data corresponding to an area to a SReportData. More...
	AddImage (String iName, SImage iImage)
	Add a data corresponding to an internal image to a SReportData. More...
	AddImageFromDisk (String iName, String iImageFilePath)
	Add a data corresponding to an external image (provided its file path) to a SReportData. More...
Array	AddLabels (String iName, Array< SLabel > iLabelTable)
	Add a data corresponding to a table of labels to a SReportData. The labels table must contain labels with the same definition. More...
	AddLength (String iName, LengthUnit lengthUnit, Number iLength)
	Add a data corresponding to a length to a SReportData. More...
	AddNumber (String iName, Number iNumber)
	Add a data corresponding to a number without unit to a SReportData. More...
	AddPoint (String iName, LengthUnit lengthUnit, SPoint iPoint)
	Add a data corresponding to a point to a SReportData. More...
	AddText (String iName, String iText)
	Add a data corresponding to a text to a SReportData. More...
	AddToDoc ()
	Add the report data to the current document. More...
	AddVector (String iName, LengthUnit lengthUnit, SVector iVector)
	Add a data corresponding to a vector to a SReportData. More...
	AddViewset (String iName, SViewSet iViewset)
	Add a data corresponding to a ViewSet to a SReportData. More...
	AddVolume (String iName, VolumeUnit volumeUnit, Number iVolume)
	Add a data corresponding to a volume to a SReportData. More...
	ExportDataXML (String iFilePath)
	Export all data as a XML file. More...
Array	ExportTableCSV (String iFilesFolder)
	Export a table as CSV file. More...
static Array	FromName (String iName)
	To get all the selected SReportData corresponding to the given name. More...
Number	GetAngle (String iName)
	Get an angle from a SReportData. More...
Number	GetArea (String iName)
	Get an area from a SReportData. More...
Number	GetLength (String iName)
	Get a length from a SReportData. More...
Number	GetNumber (String iName)
	Get a number from a SReportData. More...
SPoint	GetPoint (String iName)
	Get a point from a SReportData. More...
String	GetText (String iKey)
	Get a text from a SReportData. More...
SVector	GetVector (String iName)
	Get a vector from a SReportData. More...
Number	GetVolume (String iName)
	Get a volume from a SReportData. More...
static SReportData	New (String iName)
	Create an empty report data. More...
static String	toString ()
	Get the type of the variable. More...
	UpdateMainViewSet ()
	Update the main view of a report data with the current 3D view. More...
Public Slots inherited from SComp
	AddToDoc ()
	To add the object to the document. More...
static Array	All (Number VisCrit)
	To get all the SComp in the document. More...
	ApplyTransformation (SMatrix iMatrix)
	To apply a geometric transformation to the current object by making a product with the given matrix. More...
	Clear ()
	To deallocate object memory. More...
static Array	FromClick ()
	Displays a dialog box to select an SComp in the scene. More...
static Array	FromName (String Name)
	Search all the component with the given name. More...
static Array	FromSel ()
	To get all the selected SComp. More...
Array	GetBoundingBox ()
	Calculates the bounding box of the component. More...
Array	GetColors ()
	To get the colors of the component. More...
String	GetFolderName ()
String	GetName ()
	Invert ()
	Normal of the component is inverted. More...
Boolean	IsInDoc ()
	Return if the component is in the document or not. More...
Boolean	IsVisible ()
	MoveToGroup (String GroupPath, Boolean MoveInsideTopParent)
	Move the object to the document group represent by the given path. If some groups, in the path, don't exist, they will be created. More...
	RemoveFromDoc ()
	To remove the object from the document. More...
	SetClippable (Boolean clipping)
	Set clippable or not. More...
	SetColors (Number Red, Number Green, Number Blue)
	Sets the colors of the component. More...
	SetName (String ComponentName)
	To set the component's name. More...
	SetRepresentationType (RepresentationTypeEnum Representation)
	The shading type of the component is modified. More...
	SetTransparency (Number Alpha)
	Sets the transparency of the component. More...
	SetVisibility (Boolean Visible)
	Sets the component to be visible, or not visible. More...
String	toString ()
	Get the type of the variable. More...
String	toString ()
	Get the type of the variable. More...
	Translate (SVector Vector)
	To make a translation of the current object with an SVector. More...
Public Slots inherited from SObject
	Clear ()
	To deallocate memory of the object. More...
String	toString ()
	Get the type of the variable. More...

Detailed Description

Class to store reporting data. Reporting data corresponds to a chapter of a report. SReportData are used to fill a SReport.

Member Enumeration Documentation

AngleUnit

enum SReportData::AngleUnit

Enumerator
Radian
Degree
Gradian
Percent
Minute
Second

AreaUnit

enum SReportData::AreaUnit

Enumerator
SquareMicrometer
SquareMillimeter
SquareCentimeter
SquareMeter
SquareKilometer
SquareMicroinch
SquareMilliinch
SquareInch
SquareFeet
SquareSurveyFeet
SquareYard
SquareMiles

LengthUnit

enum SReportData::LengthUnit

Enumerator
Micrometer
Millimeter
Centimeter
Meter
Kilometer
Microinch
Milliinch
Inch
Feet
SurveyFeet
Yard
Miles

VolumeUnit

enum SReportData::VolumeUnit

Enumerator
CubicMicrometer
CubicMillimeter
CubicCentimeter
CubicMeter
CubicKilometer
CubicMicroinch
CubicMilliinch
CubicInch
CubicFeet
CubicSurveyFeet
CubicYard
CubicMiles
Liter
US_LiquidGallon
US_DryGallon
US_LiquidBarrel
US_DryBarrel
US_OilBarrel

Member Function Documentation

AddAngle

SReportData::AddAngle ( String  iName, AngleUnit  angleUnit, Number  iAngle  )

slot

Add a data corresponding to an angle to a SReportData.

Parameters

[in]	iName	The name of the data
[in]	angleUnit	The unit of the angle (see AngleUnit enum)
[in]	iAngle	The value of the angle data

AddArea

SReportData::AddArea ( String  iName, AreaUnit  areaUnit, Number  iArea  )

slot

Add a data corresponding to an area to a SReportData.

Parameters

[in]	iName	The name of the data
[in]	areaUnit	The unit of the area (see AreaUnit enum)
[in]	iArea	The value of the area data

AddImage

SReportData::AddImage ( String  iName, SImage  iImage  )

slot

Add a data corresponding to an internal image to a SReportData.

Parameters

iName	[in] The name of the data.
iImage	[in] The image object to add (see SImage).

AddImageFromDisk

SReportData::AddImageFromDisk ( String  iName, String  iImageFilePath  )

slot

Add a data corresponding to an external image (provided its file path) to a SReportData.

Parameters

iName	[in] The name of the data.
iImageFilePath	[in] The path to the image file.

AddLabels

Array SReportData::AddLabels ( String  iName, Array< SLabel >  iLabelTable  )

slot

Add a data corresponding to a table of labels to a SReportData. The labels table must contain labels with the same definition.

Return values

Array.ErrorCode

The error code 0, Ok no error 1, Invalid labels table.

Parameters

[in]	iName	The name of the data
[in]	iLabelTable	The table of labels to add

AddLength

SReportData::AddLength ( String  iName, LengthUnit  lengthUnit, Number  iLength  )

slot

Add a data corresponding to a length to a SReportData.

Parameters

[in]	iName	The name of the data
[in]	lengthUnit	The unit of the length (see LengthUnit enum)
[in]	iLength	The value of the length data

AddNumber

SReportData::AddNumber ( String  iName, Number  iNumber  )

slot

Add a data corresponding to a number without unit to a SReportData.

Parameters

[in]	iName	The name of the data
[in]	iNumber	The value of the data

AddPoint

SReportData::AddPoint ( String  iName, LengthUnit  lengthUnit, SPoint  iPoint  )

slot

Add a data corresponding to a point to a SReportData.

Parameters

[in]	iName	The name of the data
[in]	lengthUnit	The unit of the point coordinates (see LengthUnit enum)
[in]	iPoint	The point to add

AddText

SReportData::AddText ( String  iName, String  iText  )

slot

Add a data corresponding to a text to a SReportData.

Parameters

[in]	iName	The name of the data
[in]	iText	The text to add

AddToDoc

SReportData::AddToDoc ( )

slot

Add the report data to the current document.

AddVector

SReportData::AddVector ( String  iName, LengthUnit  lengthUnit, SVector  iVector  )

slot

Add a data corresponding to a vector to a SReportData.

Parameters

[in]	iName	The name of the data
[in]	lengthUnit	The unit of the vector coordinates (see LengtUnit enum)
[in]	iVector	The vector to add

AddViewset

SReportData::AddViewset ( String  iName, SViewSet  iViewset  )

slot

Add a data corresponding to a ViewSet to a SReportData.

Parameters

[in]	iName	The name of the data
[in]	iViewset	The view set to add

AddVolume

SReportData::AddVolume ( String  iName, VolumeUnit  volumeUnit, Number  iVolume  )

slot

Add a data corresponding to a volume to a SReportData.

Parameters

[in]	iName	The name of the data
[in]	volumeUnit	The unit of the volume (see VolumeUnit enum)
[in]	iVolume	The value of the volume data

ExportDataXML

SReportData::ExportDataXML ( String  iFilePath )

slot

Export all data as a XML file.

Parameters

[in]

iFilePath

The complete path of the file

ExportTableCSV

Array SReportData::ExportTableCSV ( String  iFilesFolder )

slot

Export a table as CSV file.

Note

The path given to the function must be the path of the repertory where all CSV tables contained in the SReportData must be added. One CSV file will be created for each table inside the SReportData.

Return values

Array.ErrorCode	the error code 0, Ok no error 1, No available table to export in this report data 2, No file name 3, An error occurred during the export
Array.FilesList	the list of all files path

Parameters

[in]

iFilesFolder

The path to the repertory

FromName

static Array SReportData::FromName ( String  iName )

inlinestaticslot

To get all the selected SReportData corresponding to the given name.

Parameters

[in]

iName

The name of the searched SReportData

GetAngle

Number SReportData::GetAngle ( String  iName )

slot

Get an angle from a SReportData.

Parameters

[in]

iName

The name of the data to get

GetArea

Number SReportData::GetArea ( String  iName )

slot

Get an area from a SReportData.

Parameters

[in]

iName

The name of the data to get

GetLength

Number SReportData::GetLength ( String  iName )

slot

Get a length from a SReportData.

Parameters

[in]

iName

The name of the data to get

GetNumber

Number SReportData::GetNumber ( String  iName )

slot

Get a number from a SReportData.

Parameters

[in]

iName

The name of the data to get

GetPoint

SPoint SReportData::GetPoint ( String  iName )

slot

Get a point from a SReportData.

Parameters

[in]

iName

The name of the data to get

GetText

String SReportData::GetText ( String  iKey )

slot

Get a text from a SReportData.

Parameters

[in]

iKey

The name of the data to get

GetVector

SVector SReportData::GetVector ( String  iName )

slot

Get a vector from a SReportData.

Parameters

[in]

iName

The name of the data to get

GetVolume

Number SReportData::GetVolume ( String  iName )

slot

Get a volume from a SReportData.

Parameters

[in]

iName

The name of the data to get

New

static SReportData SReportData::New ( String  iName )

staticslot

Create an empty report data.

Parameters

[in]

iName

The name of the created SReportData

toString

static String SReportData::toString ( )

staticslot

Get the type of the variable.

UpdateMainViewSet

SReportData::UpdateMainViewSet ( )

slot

Update the main view of a report data with the current 3D view.