Open CASCADE Technology  7.7.0
Data Structures | Public Types | Public Member Functions | Data Fields

STEPCAFControl_ConfigurationNode Class Reference

The purpose of this class is to configure the transfer process for STEP format Stores the necessary settings for STEPCAFControl_Provider. Configures and creates special provider to transfer STEP files. More...

#include <STEPCAFControl_ConfigurationNode.hxx>

Inheritance diagram for STEPCAFControl_ConfigurationNode:
Inheritance graph
[legend]

Data Structures

struct  STEPCAFControl_InternalSection
 

Public Types

enum  ReadMode_BSplineContinuity { ReadMode_BSplineContinuity_C0 = 0 , ReadMode_BSplineContinuity_C1 , ReadMode_BSplineContinuity_C2 }
 
enum  ReadMode_Precision { ReadMode_Precision_File = 0 , ReadMode_Precision_User }
 
enum  ReadMode_MaxPrecision { ReadMode_MaxPrecision_Preferred = 0 , ReadMode_MaxPrecision_Forced }
 
enum  ReadMode_SurfaceCurve {
  ReadMode_SurfaceCurve_Default = 0 , ReadMode_SurfaceCurve_2DUse_Preferred = 2 , ReadMode_SurfaceCurve_2DUse_Forced = -2 , ReadMode_SurfaceCurve_3DUse_Preferred = 3 ,
  ReadMode_SurfaceCurve_3DUse_Forced = -3
}
 
enum  AngleUnitMode { AngleUnitMode_File = 0 , AngleUnitMode_Rad , AngleUnitMode_Deg }
 
enum  ReadMode_ProductContext { ReadMode_ProductContext_All = 1 , ReadMode_ProductContext_Design , ReadMode_ProductContext_Analysis }
 
enum  ReadMode_ShapeRepr {
  ReadMode_ShapeRepr_All = 1 , ReadMode_ShapeRepr_ABSR , ReadMode_ShapeRepr_MSSR , ReadMode_ShapeRepr_GBSSR ,
  ReadMode_ShapeRepr_FBSR , ReadMode_ShapeRepr_EBWSR , ReadMode_ShapeRepr_GBWSR
}
 
enum  ReadMode_AssemblyLevel { ReadMode_AssemblyLevel_All = 1 , ReadMode_AssemblyLevel_Assembly , ReadMode_AssemblyLevel_Structure , ReadMode_AssemblyLevel_Shape }
 
enum  RWMode_Tessellated { RWMode_Tessellated_Off = 0 , RWMode_Tessellated_On , RWMode_Tessellated_OnNoBRep }
 
enum  WriteMode_PrecisionMode { WriteMode_PrecisionMode_Least = -1 , WriteMode_PrecisionMode_Average = 0 , WriteMode_PrecisionMode_Greatest = 1 , WriteMode_PrecisionMode_Session = 2 }
 
enum  WriteMode_Assembly { WriteMode_Assembly_Off = 0 , WriteMode_Assembly_On , WriteMode_Assembly_Auto }
 
enum  WriteMode_StepSchema {
  WriteMode_StepSchema_AP214CD = 1 , WriteMode_StepSchema_AP214DIS , WriteMode_StepSchema_AP203 , WriteMode_StepSchema_AP214IS ,
  WriteMode_StepSchema_AP242DIS
}
 
enum  WriteMode_VertexMode { WriteMode_VertexMode_OneCompound = 0 , WriteMode_VertexMode_SingleVertex }
 
- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Public Member Functions

 STEPCAFControl_ConfigurationNode ()
 Initializes all field by default. More...
 
 STEPCAFControl_ConfigurationNode (const Handle< STEPCAFControl_ConfigurationNode > &theNode)
 Copies values of all fields. More...
 
virtual bool Load (const Handle< DE_ConfigurationContext > &theResource) override
 Updates values according the resource. More...
 
virtual TCollection_AsciiString Save () const override
 Writes configuration to the string. More...
 
virtual Handle< DE_ConfigurationNodeCopy () const override
 Copies values of all fields. More...
 
virtual Handle< DE_ProviderBuildProvider () override
 Creates new provider for the own format. More...
 
virtual bool IsImportSupported () const override
 Checks the import supporting. More...
 
virtual bool IsExportSupported () const override
 Checks the export supporting. More...
 
virtual TCollection_AsciiString GetFormat () const override
 Gets CAD format name of associated provider. More...
 
virtual TCollection_AsciiString GetVendor () const override
 Gets provider's vendor name of associated provider. More...
 
virtual TColStd_ListOfAsciiString GetExtensions () const override
 Gets list of supported file extensions. More...
 
virtual bool CheckContent (const Handle< NCollection_Buffer > &theBuffer) const override
 Checks the file content to verify a format. More...
 
- Public Member Functions inherited from DE_ConfigurationNode
 DE_ConfigurationNode ()
 Initializes all field by default. More...
 
 DE_ConfigurationNode (const Handle< DE_ConfigurationNode > &theConfigurationNode)
 Copies values of all fields. More...
 
virtual bool Load (const TCollection_AsciiString &theResourcePath="")
 Updates values according the resource file. More...
 
bool Save (const TCollection_AsciiString &theResourcePath) const
 Writes configuration to the resource file. More...
 
virtual bool UpdateLoad ()
 Update loading status. Checking for the license. More...
 
virtual bool CheckExtension (const TCollection_AsciiString &theExtension) const
 Checks the file extension to verify a format. More...
 
Standard_Boolean IsEnabled () const
 Gets the provider loading status. More...
 
void SetEnabled (const Standard_Boolean theIsLoaded)
 Sets the provider loading status. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Data Fields

struct STEPCAFControl_ConfigurationNode::STEPCAFControl_InternalSection InternalParameters
 
- Data Fields inherited from DE_ConfigurationNode
struct DE_ConfigurationNode::DE_SectionGlobal GlobalParameters
 

Additional Inherited Members

- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

The purpose of this class is to configure the transfer process for STEP format Stores the necessary settings for STEPCAFControl_Provider. Configures and creates special provider to transfer STEP files.

Nodes grouped by Vendor name and Format type. The Vendor name is "OCC" The Format type is "STEP" The supported CAD extensions are ".stp", ".step", ".stpz" The import process is supported. The export process is supported.

Member Enumeration Documentation

◆ AngleUnitMode

Enumerator
AngleUnitMode_File 
AngleUnitMode_Rad 
AngleUnitMode_Deg 

◆ ReadMode_AssemblyLevel

Enumerator
ReadMode_AssemblyLevel_All 
ReadMode_AssemblyLevel_Assembly 
ReadMode_AssemblyLevel_Structure 
ReadMode_AssemblyLevel_Shape 

◆ ReadMode_BSplineContinuity

Enumerator
ReadMode_BSplineContinuity_C0 
ReadMode_BSplineContinuity_C1 
ReadMode_BSplineContinuity_C2 

◆ ReadMode_MaxPrecision

Enumerator
ReadMode_MaxPrecision_Preferred 
ReadMode_MaxPrecision_Forced 

◆ ReadMode_Precision

Enumerator
ReadMode_Precision_File 
ReadMode_Precision_User 

◆ ReadMode_ProductContext

Enumerator
ReadMode_ProductContext_All 
ReadMode_ProductContext_Design 
ReadMode_ProductContext_Analysis 

◆ ReadMode_ShapeRepr

Enumerator
ReadMode_ShapeRepr_All 
ReadMode_ShapeRepr_ABSR 
ReadMode_ShapeRepr_MSSR 
ReadMode_ShapeRepr_GBSSR 
ReadMode_ShapeRepr_FBSR 
ReadMode_ShapeRepr_EBWSR 
ReadMode_ShapeRepr_GBWSR 

◆ ReadMode_SurfaceCurve

Enumerator
ReadMode_SurfaceCurve_Default 
ReadMode_SurfaceCurve_2DUse_Preferred 
ReadMode_SurfaceCurve_2DUse_Forced 
ReadMode_SurfaceCurve_3DUse_Preferred 
ReadMode_SurfaceCurve_3DUse_Forced 

◆ RWMode_Tessellated

Enumerator
RWMode_Tessellated_Off 
RWMode_Tessellated_On 
RWMode_Tessellated_OnNoBRep 

◆ WriteMode_Assembly

Enumerator
WriteMode_Assembly_Off 
WriteMode_Assembly_On 
WriteMode_Assembly_Auto 

◆ WriteMode_PrecisionMode

Enumerator
WriteMode_PrecisionMode_Least 
WriteMode_PrecisionMode_Average 
WriteMode_PrecisionMode_Greatest 
WriteMode_PrecisionMode_Session 

◆ WriteMode_StepSchema

Enumerator
WriteMode_StepSchema_AP214CD 
WriteMode_StepSchema_AP214DIS 
WriteMode_StepSchema_AP203 
WriteMode_StepSchema_AP214IS 
WriteMode_StepSchema_AP242DIS 

◆ WriteMode_VertexMode

Enumerator
WriteMode_VertexMode_OneCompound 
WriteMode_VertexMode_SingleVertex 

Constructor & Destructor Documentation

◆ STEPCAFControl_ConfigurationNode() [1/2]

STEPCAFControl_ConfigurationNode::STEPCAFControl_ConfigurationNode ( )

Initializes all field by default.

◆ STEPCAFControl_ConfigurationNode() [2/2]

STEPCAFControl_ConfigurationNode::STEPCAFControl_ConfigurationNode ( const Handle< STEPCAFControl_ConfigurationNode > &  theNode)

Copies values of all fields.

Parameters
[in]theNodeobject to copy

Member Function Documentation

◆ BuildProvider()

virtual Handle< DE_Provider > STEPCAFControl_ConfigurationNode::BuildProvider ( )
overridevirtual

Creates new provider for the own format.

Returns
new created provider

Implements DE_ConfigurationNode.

◆ CheckContent()

virtual bool STEPCAFControl_ConfigurationNode::CheckContent ( const Handle< NCollection_Buffer > &  theBuffer) const
overridevirtual

Checks the file content to verify a format.

Parameters
[in]theBufferread stream buffer to check content
Returns
Standard_True if file is supported by a current provider

Reimplemented from DE_ConfigurationNode.

◆ Copy()

virtual Handle< DE_ConfigurationNode > STEPCAFControl_ConfigurationNode::Copy ( ) const
overridevirtual

Copies values of all fields.

Returns
new object with the same field values

Implements DE_ConfigurationNode.

◆ GetExtensions()

virtual TColStd_ListOfAsciiString STEPCAFControl_ConfigurationNode::GetExtensions ( ) const
overridevirtual

Gets list of supported file extensions.

Returns
list of extensions

Implements DE_ConfigurationNode.

◆ GetFormat()

virtual TCollection_AsciiString STEPCAFControl_ConfigurationNode::GetFormat ( ) const
overridevirtual

Gets CAD format name of associated provider.

Returns
provider CAD format

Implements DE_ConfigurationNode.

◆ GetVendor()

virtual TCollection_AsciiString STEPCAFControl_ConfigurationNode::GetVendor ( ) const
overridevirtual

Gets provider's vendor name of associated provider.

Returns
provider's vendor name

Implements DE_ConfigurationNode.

◆ IsExportSupported()

virtual bool STEPCAFControl_ConfigurationNode::IsExportSupported ( ) const
overridevirtual

Checks the export supporting.

Returns
true if export is supported

Reimplemented from DE_ConfigurationNode.

◆ IsImportSupported()

virtual bool STEPCAFControl_ConfigurationNode::IsImportSupported ( ) const
overridevirtual

Checks the import supporting.

Returns
true if import is supported

Reimplemented from DE_ConfigurationNode.

◆ Load()

virtual bool STEPCAFControl_ConfigurationNode::Load ( const Handle< DE_ConfigurationContext > &  theResource)
overridevirtual

Updates values according the resource.

Parameters
[in]theResourceinput resource to use
Returns
true if theResource loading has ended correctly

Implements DE_ConfigurationNode.

◆ Save()

virtual TCollection_AsciiString STEPCAFControl_ConfigurationNode::Save ( ) const
overridevirtual

Writes configuration to the string.

Returns
result resource string

Implements DE_ConfigurationNode.

Field Documentation

◆ InternalParameters

struct STEPCAFControl_ConfigurationNode::STEPCAFControl_InternalSection STEPCAFControl_ConfigurationNode::InternalParameters

The documentation for this class was generated from the following file: