Files
OCCT/src/STEPConstruct/STEPConstruct_ContextTool.cdl
ski ff8178ef85 0024784: Move documentation in CDL files to proper location
Mostly duplicated comments were removed and missing ones were moved
into dedicated class CDL files.
Some more duplicated comments were removed from CDL files.
Correction of merge
2014-05-29 16:06:49 +04:00

138 lines
5.0 KiB
Plaintext

-- Created on: 1993-09-14
-- Created by: Frederic MAUPAS
-- Copyright (c) 1993-1999 Matra Datavision
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and/or modify it under
-- the terms of the GNU Lesser General Public License version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.
class ContextTool from STEPConstruct
---Purpose : Maintains global context tool for writing.
-- Gives access to Product Definition Context (one per Model)
-- Maintains ApplicationProtocolDefinition entity (common for all
-- products)
-- Also maintains context specific for AP203 and provides set of
-- methods to work with various STEP constructs as required
-- by Actor
uses
SequenceOfInteger from TColStd,
HSequenceOfTransient from TColStd,
HAsciiString from TCollection,
StepModel from StepData,
ApplicationProtocolDefinition from StepBasic,
ShapeDefinitionRepresentation from StepShape,
Axis2Placement3d from StepGeom,
AP203Context from STEPConstruct,
Assembly from STEPConstruct,
Part from STEPConstruct
is
Create returns ContextTool from STEPConstruct;
Create (aStepModel : StepModel from StepData) returns ContextTool from STEPConstruct;
---Management of ApplicationProtocolDefinition
SetModel (me : in out; aStepModel : StepModel from StepData);
---Purpose: Initialize ApplicationProtocolDefinition by the first
-- entity of that type found in the model
GetAPD(me : in out) returns ApplicationProtocolDefinition from StepBasic;
---Purpose:
AddAPD(me : in out; enforce : Boolean = Standard_False);
IsAP203 (me) returns Boolean;
---Purpose: Returns True if APD.schema_name is config_control_design
IsAP214 (me) returns Boolean;
---Purpose: Returns True if APD.schema_name is automotive_design
-- AC : Application Context
GetACstatus(me : in out) returns HAsciiString from TCollection;
GetACschemaName(me : in out) returns HAsciiString from TCollection;
GetACyear(me : in out) returns Integer;
-- GetACapplication(me : in out)
-- returns HAsciiString from TCollection; via the SDR
GetACname (me : in out) returns HAsciiString from TCollection;
SetACstatus (me: in out; status: HAsciiString from TCollection);
SetACschemaName(me: in out; schemaName: HAsciiString from TCollection);
SetACyear (me: in out; year: Integer);
-- SetACapplication(me : in out;
-- application : HAsciiString from TCollection);
SetACname (me: in out; name : HAsciiString from TCollection);
-- Other context items
GetDefaultAxis (me: in out) returns Axis2Placement3d from StepGeom;
---Purpose: Returns a default axis placement
AP203Context (me: in out) returns AP203Context from STEPConstruct;
---Purpose: Returns tool which maintains context specific for AP203
---C++: return &
-- Management of assembly level for naming products
Level (me) returns Integer;
---Purpose: Returns current assembly level
NextLevel (me: in out);
PrevLevel (me: in out);
SetLevel (me: in out; lev: Integer );
---Purpose: Changes current assembly level
Index (me) returns Integer;
---Purpose: Returns current index of assembly component on current level
NextIndex (me: in out);
PrevIndex (me: in out);
SetIndex (me: in out; ind: Integer );
---Purpose: Changes current index of assembly component on current level
GetProductName (me) returns HAsciiString from TCollection;
---Purpose: Generates a product name basing on write.step.product.name
-- parameter and current position in the assembly structure
-- Methods for collecting all roots corresponding to some constructs
GetRootsForPart (me: in out; SDRTool: Part from STEPConstruct)
returns HSequenceOfTransient from TColStd;
---Purpose: Produces and returns a full list of root entities required
-- for part identified by SDRTool (including SDR itself)
GetRootsForAssemblyLink (me: in out; assembly: Assembly from STEPConstruct)
returns HSequenceOfTransient from TColStd;
---Purpose: Produces and returns a full list of root entities required
-- for assembly link identified by assembly (including NAUO and CDSR)
fields
myLevel : SequenceOfInteger from TColStd; -- level of assembly for auto naming products
theAPD : ApplicationProtocolDefinition from StepBasic;
theAP203 : AP203Context from STEPConstruct;
myAxis : Axis2Placement3d from StepGeom;
end ContextTool;