SALOME documentation central

VISU.Result Interface Reference

Interface Result. More...

import "VISU_Gen.idl";

Inheritance diagram for VISU.Result:
Inheritance graph

Public Types

enum  Resolution { FULL, MEDIUM, LOW, HIDDEN }
typedef sequence< EntityEntities
typedef string EntityName
typedef sequence< EntityNameEntityNames
typedef long TimeStampNumber
typedef sequence< TimeStampNumberTimeStampNumbers
typedef sequence< ResolutionResolutions

Public Member Functions

boolean BuildAll ()
boolean Build (in boolean theIsBuildAll, in boolean theIsAtOnce)
boolean IsDone ()
boolean IsEntitiesDone ()
void SetBuildFields (in boolean theIsBuildFields, in boolean theIsCalculateMinMax)
boolean IsFieldsDone ()
void SetBuildGroups (in boolean theIsBuildGroups)
boolean IsGroupsDone ()
boolean IsMinMaxDone ()
boolean IsPartsDone ()
EntityNames GetMeshNames ()
Entities GetEntities (in EntityName theMeshName)
EntityNames GetFamilies (in EntityName theMeshName, in Entity theEntity)
EntityNames GetGroups (in EntityName theMeshName)
EntityNames GetFields (in EntityName theMeshName, in Entity theEntity)
long GetNumberOfComponents (in EntityName theMeshName, in Entity theEntity, in EntityName theFieldName)
TimeStampNumbers GetTimeStampNumbers (in EntityName theMeshName, in Entity theEntity, in EntityName theFieldName)
EntityNames GetPartNames (in EntityName theMeshName)
Resolutions GetResolutions (in EntityName theMeshName, in EntityName thePartName)
Resolution GetResolution (in EntityName theMeshName, in EntityName thePartName)
void SetResolution (in EntityName theMeshName, in EntityName thePartName, in Resolution theResolution)
SALOME_MED::MedFileInfo GetMEDFileInfo ()
boolean ExportMED (in string theFileName)
void RemoveFromStudy ()
IdType GetID ()
VISUType GetType ()

Detailed Description

This interface serves for inner representation of data generated in other sources (MED object or file). This data is needed for further construction of graphical presentations.


Member Typedef Documentation

typedef sequence<Entity> VISU.Result.Entities
typedef string VISU.Result.EntityName

Member Enumeration Documentation

Enumerator:
FULL 
MEDIUM 
LOW 
HIDDEN 

Member Function Documentation

boolean VISU.Result.BuildAll (  ) 

Reads all data from the corresponding sources. By default the data is loaded on demand.

boolean VISU.Result.Build ( in boolean  theIsBuildAll,
in boolean  theIsAtOnce 
)

Start to parse the source MED file and publish all its entities into the study

boolean VISU.Result.IsDone (  ) 

Allow to check is all requested MED entites already loaded or not

boolean VISU.Result.IsEntitiesDone (  ) 

Allow to check is corresponding MED entites already loaded or not

void VISU.Result.SetBuildFields ( in boolean  theIsBuildFields,
in boolean  theIsCalculateMinMax 
)

Choose to parse MED fields and perform global min / max on the MED timestamps.

boolean VISU.Result.IsFieldsDone (  ) 

Allow to check is corresponding MED fields already loaded or not

void VISU.Result.SetBuildGroups ( in boolean  theIsBuildGroups  ) 

Choose to parse MED groups.

boolean VISU.Result.IsGroupsDone (  ) 

Allow to check is corresponding MED groups and families already loaded or not

boolean VISU.Result.IsMinMaxDone (  ) 

Allow to check is min / max calculation over field's components already perfrormed or not

boolean VISU.Result.IsPartsDone (  ) 

Allow to check is corresponding multi resolution structure already loaded or not

EntityNames VISU.Result.GetMeshNames (  ) 

Gets existing mesh names

Entities VISU.Result.GetEntities ( in EntityName  theMeshName  ) 

Gets existing mesh entites for the given mesh name

EntityNames VISU.Result.GetFamilies ( in EntityName  theMeshName,
in Entity  theEntity 
)

Gets existing families for the given mesh name and entity

EntityNames VISU.Result.GetGroups ( in EntityName  theMeshName  ) 

Gets existing families for the given mesh name

EntityNames VISU.Result.GetFields ( in EntityName  theMeshName,
in Entity  theEntity 
)

Gets existing fields for the given mesh name and entity

long VISU.Result.GetNumberOfComponents ( in EntityName  theMeshName,
in Entity  theEntity,
in EntityName  theFieldName 
)

Gets number of components for the given mesh name, entity and name of field

TimeStampNumbers VISU.Result.GetTimeStampNumbers ( in EntityName  theMeshName,
in Entity  theEntity,
in EntityName  theFieldName 
)

Gets existing numbers of time stamps for the given mesh name, entity and name of field

EntityNames VISU.Result.GetPartNames ( in EntityName  theMeshName  ) 

Gets existing parts of multi resolution structure for the given mesh name

Resolutions VISU.Result.GetResolutions ( in EntityName  theMeshName,
in EntityName  thePartName 
)

Gets available resolutions of multi resolution structure for the given mesh and part names

Resolution VISU.Result.GetResolution ( in EntityName  theMeshName,
in EntityName  thePartName 
)

Gets current resolution of multi resolution structure for the given mesh and part names

void VISU.Result.SetResolution ( in EntityName  theMeshName,
in EntityName  thePartName,
in Resolution  theResolution 
)

Gets current resolution of multi resolution structure for the given mesh and part names

SALOME_MED::MedFileInfo VISU.Result.GetMEDFileInfo (  ) 

Gets information about imported MED file

boolean VISU.Result.ExportMED ( in string  theFileName  ) 

Export MED file from temp object.

void VISU.RemovableObject.RemoveFromStudy (  )  [inherited]

Remove object from study.

IdType VISU.Base.GetID (  )  [inherited]

Returns ID of the object.

VISUType VISU.Base.GetType (  )  [inherited]

Returns the type of the presentable object

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator

Copyright © 2007-2008 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS