1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-07 18:30:55 +03:00
occt/src/StepData/StepData_Plex.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

104 lines
3.6 KiB
Plaintext
Executable File

-- Created on: 1997-05-09
-- Created by: Christian CAILLET
-- Copyright (c) 1997-1999 Matra Datavision
-- Copyright (c) 1999-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 Plex from StepData inherits Described from StepData
---Purpose : A Plex (for Complex) Entity is defined as a list of Simple
-- Members ("external mapping")
-- The types of these members must be in alphabetic order
uses CString,
SequenceOfTransient from TColStd,
HSequenceOfAsciiString from TColStd,
Check from Interface, EntityIterator from Interface,
ECDescr from StepData, Simple from StepData, Field from StepData
raises InterfaceMismatch
is
Create (descr : ECDescr) returns mutable Plex;
---Purpose : Creates a Plex (empty). The complete creation is made by the
-- ECDescr itself, by calling Add
Add (me : mutable; member : Simple);
---Purpose : Adds a member to <me>
ECDescr (me) returns ECDescr;
---Purpose : Returns the Description as for a Plex
-- inherited
IsComplex (me) returns Boolean;
---Purpose : Returns False
Matches (me; steptype : CString) returns Boolean;
---Purpose : Tells if a step type is matched by <me>
-- For a Simple Entity : own type or super type
-- For a Complex Entity : one of the members
As (me; steptype : CString) returns mutable Simple;
---Purpose : Returns a Simple Entity which matches with a Type in <me> :
-- For a Simple Entity : me if it matches, else a null handle
-- For a Complex Entity : the member which matches, else null
HasField (me; name : CString) returns Boolean;
---Purpose : Tells if a Field brings a given name
Field (me; name : CString) returns Field
---Purpose : Returns a Field from its name; read-only
raises InterfaceMismatch;
-- raises if no Field for <name>
---C++ : return const &
CField (me : mutable; name : CString) returns Field
---Purpose : Returns a Field from its name; read or write
raises InterfaceMismatch;
-- raises if no Field for <name>
---C++ : return &
-- more specific
NbMembers (me) returns Integer;
---Purpose : Returns the count of simple members
Member (me; num : Integer) returns Simple;
---Purpose : Returns a simple member from its rank
TypeList (me) returns HSequenceOfAsciiString;
---Purpose : Returns the actual list of members types
--
Check (me; ach : in out Check from Interface);
---Purpose : Fills a Check by using its Description
Shared (me; list : in out EntityIterator from Interface);
---Purpose : Fills an EntityIterator with entities shared by <me>
fields
themembers : SequenceOfTransient;
end Plex;