dtk_StepReader.hpp

Go to the documentation of this file.

/**********************************************************
   STR_VR.H
***********************************************************/
#ifndef _DTK_STEP_READER_H_
#define _DTK_STEP_READER_H_
#include "util/dtk_reader.hpp"
#include "def/define.h"
 
class StepReader: public Dtk_Reader {
 
  public :
 
StepReader();
virtual ~StepReader();
 
 
static Dtk_bool Enable();
 
//  ====    General inherited actions    ====
 
Dtk_ErrorStatus CreateDocument(const Dtk_string& inInputFile, Dtk_MainDocPtr& outDocument);
Dtk_ErrorStatus GetFileVersion(const Dtk_string &inInputFile, Dtk_string& outVersion);
 
Dtk_ErrorStatus PopulateComponentsTree
     (const Dtk_string& inInputFile,Dtk_MainDocPtr& inoutDocument,Dtk_ComponentPtr& outRootComponent);
Dtk_ErrorStatus PopulateComponentsTree(const Dtk_tab< Dtk_StreamPtr >& inArrayStream, Dtk_MainDocPtr& inoutDocument, Dtk_ComponentPtr& outRootComponent );
Dtk_ErrorStatus EndPopulateComponentsTree();
 
Dtk_ErrorStatus ReadComponent
     (const Dtk_ComponentPtr& inComponent, Dtk_NodePtr& outRootNode);
 
Dtk_ErrorStatus EndComponent( Dtk_ComponentPtr& inComponent );
 
Dtk_ErrorStatus ReadEntity(Dtk_Node & inNode, Dtk_EntityPtr& outEntity);
Dtk_ErrorStatus ReadAdditionalInfos(Dtk_Node & inNode, Dtk_ObjectPtr &outEntity);
 
Dtk_ErrorStatus GetConnectorsPointingToThisComponent(Dtk_Component& inCompo,Dtk_tab<Dtk_NodeConnectorPtr> &outConnectedEntities);
Dtk_ErrorStatus GetAssociatedEntities(Dtk_Node& inNode, Dtk_tab< Dtk_NodeConnectorPtr > &outAssociatedEntities);
 
Dtk_ErrorStatus ActivateReader();
 
Dtk_ErrorStatus DesactivateReader();
 
Dtk_Int32 GetVersion();
 
 
//  ====    Specific settings for STEP Read    ====
 
 
static Dtk_ErrorStatus SetParseMode(const int inModeReader);
 
static Dtk_ErrorStatus SetComponentNameMode(const int inModeName);
 
static Dtk_ErrorStatus SetModeReadFDT(const int inMode);
 
static Dtk_ErrorStatus SetModeProperty(const int inModeProp, const int inModeValProp = 0);
 
static Dtk_ErrorStatus SetReadExtendedAsciiMode(const int inMode);
 
static Dtk_ErrorStatus SetModeColorUnlisted(const int inMode);
 
static Dtk_ErrorStatus SetModeOrphanBody(const int inMode);
 
static Dtk_ErrorStatus SetModePropagateColor(const Dtk_bool inMode);
 
static Dtk_ErrorStatus SetLayerDescriptionMode(const Dtk_bool inMode);
 
static Dtk_ErrorStatus SetAllowReadInvalidFiles( const Dtk_bool inMode );
 
//  ====    Fields and internal actions    ====
 
  protected:
 
class StepReader_Handle;
StepReader_Handle* _Private;
 
void _Init();
Dtk_ErrorStatus InitReader(const Dtk_string& inInputFile);
 
};
 
//  ====    General settings  - legacy form   ====
 
SetAsDeprecated("2022.2", "Use StepReader::SetParseMode method instead.")
int stepr_SetParseMode (const int inModeReader);
 
SetAsDeprecated("2022.2", "Use StepReader::SetComponentNameMode method instead.")
int stepr_SetComponentNameMode (const int inModeName);
 
SetAsDeprecated("2022.2", "Use StepReader::SetModeReadFDT method instead.")
int  stepr_SetModeReadFDT(const int inMode);
 
SetAsDeprecated("2022.2", "Use StepReader::SetModeProperty method instead.")
int stepr_SetModeProperty (const int inMode);
 
SetAsDeprecated("2022.2", "Use  StepReader::SetReadExtendedAsciiMode method instead.")
int stepr_SetReadExtendedAsciiMode (const int inModeExtAscii);
 
SetAsDeprecated("2022.2", "Use StepReader::SetModeColorUnlisted method instead.")
Dtk_ErrorStatus StepReader_SetModeColorUnlisted(const int inMode);
 
SetAsDeprecated("2022.2", "Use StepReader::SetModeOrphanBody method instead.")
Dtk_ErrorStatus StepReader_SetModeOrphanBody(const int inMode);
 
#endif