mirror of
https://github.com/Open-Cascade-SAS/OCCT.git
synced 2026-06-12 01:50:22 +08:00
153 lines
4.9 KiB
Plaintext
Executable File
153 lines
4.9 KiB
Plaintext
Executable File
-- Created on: 2008-01-21
|
|
-- Created by: Vladislav ROMASHKO
|
|
-- Copyright (c) 2008-2012 OPEN CASCADE SAS
|
|
--
|
|
-- The content of this file is subject to the Open CASCADE Technology Public
|
|
-- License Version 6.5 (the "License"). You may not use the content of this file
|
|
-- except in compliance with the License. Please obtain a copy of the License
|
|
-- at http://www.opencascade.org and read it completely before using this file.
|
|
--
|
|
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
|
|
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
|
|
--
|
|
-- The Original Code and all software distributed under the License is
|
|
-- distributed on an "AS IS" basis, without warranty of any kind, and the
|
|
-- Initial Developer hereby disclaims all such warranties, including without
|
|
-- limitation, any warranties of merchantability, fitness for a particular
|
|
-- purpose or non-infringement. Please see the License for the specific terms
|
|
-- and conditions governing the rights and limitations under the License.
|
|
|
|
|
|
class IFunction from TFunction
|
|
|
|
---Purpose: Interface class for usage of Function Mechanism
|
|
|
|
uses
|
|
|
|
Label from TDF,
|
|
GUID from Standard,
|
|
ExecutionStatus from TFunction,
|
|
Driver from TFunction,
|
|
GraphNode from TFunction,
|
|
Logbook from TFunction,
|
|
LabelList from TDF,
|
|
DoubleMapOfIntegerLabel from TFunction
|
|
|
|
is
|
|
|
|
---Category: Static methods
|
|
-- ==============
|
|
|
|
NewFunction (myclass;
|
|
L : Label from TDF;
|
|
ID : GUID from Standard)
|
|
---Purpose: Sets a new function attached to a label <L> with <ID>.
|
|
-- It creates a new TFunction_Function attribute initialized by the <ID>,
|
|
-- a new TFunction_GraphNode with an empty list of dependencies and
|
|
-- the status equal to TFunction_ES_WrongDefinition.
|
|
-- It registers the function in the scope of functions for this document.
|
|
returns Boolean from Standard;
|
|
|
|
DeleteFunction (myclass;
|
|
L : Label from TDF)
|
|
---Purpose: Deletes a function attached to a label <L>.
|
|
-- It deletes a TFunction_Function attribute and a TFunction_GraphNode.
|
|
-- It deletes the functions from the scope of function of this document.
|
|
returns Boolean from Standard;
|
|
|
|
UpdateDependencies (myclass;
|
|
Access : Label from TDF)
|
|
---Purpose: Updates dependencies for all functions of the scope.
|
|
-- It returns false in case of an error.
|
|
returns Boolean from Standard;
|
|
|
|
|
|
---Category: Instant methods
|
|
-- ===============
|
|
|
|
Create
|
|
---Purpose: An empty constructor.
|
|
returns IFunction from TFunction;
|
|
|
|
Create (L : Label from TDF)
|
|
---Purpose: A constructor.
|
|
-- Initializes the interface by the label of function.
|
|
returns IFunction from TFunction;
|
|
|
|
Init (me : in out;
|
|
L : Label from TDF);
|
|
---Purpose: Initializes the interface by the label of function.
|
|
|
|
Label (me)
|
|
---C++: return const &
|
|
---Purpose: Returns a label of the function.
|
|
returns Label from TDF;
|
|
|
|
UpdateDependencies (me)
|
|
---Purpose: Updates the dependencies of this function only.
|
|
returns Boolean from Standard;
|
|
|
|
|
|
---Category: Driver methods
|
|
-- ==============
|
|
|
|
Arguments (me; args : out LabelList from TDF);
|
|
---Purpose: The method fills-in the list by labels,
|
|
-- where the arguments of the function are located.
|
|
|
|
Results (me; res : out LabelList from TDF);
|
|
---Purpose: The method fills-in the list by labels,
|
|
-- where the results of the function are located.
|
|
|
|
|
|
---Category: Graph node methods
|
|
-- ==================
|
|
|
|
GetPrevious (me; prev : out LabelList from TDF);
|
|
---Purpose: Returns a list of previous functions.
|
|
|
|
GetNext (me; prev : out LabelList from TDF);
|
|
---Purpose: Returns a list of next functions.
|
|
|
|
GetStatus (me)
|
|
---Purpose: Returns the execution status of the function.
|
|
returns ExecutionStatus from TFunction;
|
|
|
|
SetStatus (me; status : ExecutionStatus from TFunction);
|
|
---Purpose: Defines an execution status for a function.
|
|
|
|
|
|
---Category: Scope methods
|
|
-- =============
|
|
|
|
GetAllFunctions (me)
|
|
---Purpose: Returns the scope of all functions.
|
|
---C++: return const &
|
|
returns DoubleMapOfIntegerLabel from TFunction;
|
|
|
|
GetLogbook (me)
|
|
---Purpose: Returns the Logbook - keeper of modifications.
|
|
---C++: return &
|
|
returns Logbook from TFunction;
|
|
|
|
|
|
|
|
---Categery: Internal methods (direct access)
|
|
-- ================================
|
|
|
|
GetDriver (me; thread : Integer from Standard = 0)
|
|
---Purpose: Returns a driver of the function.
|
|
returns Driver from TFunction;
|
|
|
|
GetGraphNode (me)
|
|
---Purpose: Returns a graph node of the function.
|
|
returns GraphNode from TFunction;
|
|
|
|
|
|
fields
|
|
|
|
myLabel : Label from TDF;
|
|
|
|
|
|
end IFunction;
|