1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-05-16 10:54:53 +03:00
occt/src/TDF/TDF_DataSet.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

130 lines
3.7 KiB
Plaintext
Executable File

-- Created by: DAUTRY Philippe
-- 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.
-- ---------------
---Version: 0.0
--Version Date Purpose
-- 0.0 Mar 11 1997 Creation
class DataSet from TDF
inherits TShared from MMgt
---Purpose: This class is a set of TDF informations like
-- labels and attributes.
uses
OStream from Standard,
Label from TDF,
Attribute from TDF,
LabelList from TDF,
LabelMap from TDF,
AttributeMap from TDF
-- raises
is
Create
returns mutable DataSet from TDF;
---Purpose: Creates an empty DataSet object.
Clear(me : mutable);
---Purpose: Clears all information.
IsEmpty(me) returns Boolean from Standard;
---Purpose: Returns true if there is at least one label or one
-- attribute.
---C++: inline
-- Label set informations
AddLabel(me : mutable;
aLabel : Label from TDF);
---Purpose: Adds <aLabel> in the current data set.
---C++: inline
ContainsLabel(me; aLabel : Label from TDF)
returns Boolean from Standard;
---Purpose: Returns true if the label <alabel> is in the data set.
---C++: inline
Labels(me : mutable)
returns LabelMap from TDF;
---Purpose: Returns the map of labels in this data set.
-- This map can be used directly, or updated.
--
---C++: inline
---C++: return &
-- Attribute set informations
AddAttribute(me : mutable;
anAttribute : Attribute from TDF);
---Purpose: Adds <anAttribute> into the current data set.
---C++: inline
ContainsAttribute(me; anAttribute : Attribute from TDF)
returns Boolean from Standard;
---Purpose: Returns true if <anAttribute> is in the data set.
---C++: inline
Attributes(me : mutable)
returns AttributeMap from TDF;
---Purpose: Returns the map of attributes in the current data set.
-- This map can be used directly, or updated.
--
---C++: inline
---C++: return &
-- Root informations
AddRoot(me : mutable; aLabel : Label from TDF);
---Purpose: Adds a root label to <myRootLabels>.
--
---C++: inline
Roots(me : mutable)
returns LabelList from TDF;
---Purpose: Returns <myRootLabels> to be used or updated.
--
---C++: inline
---C++: return &
-- Miscellaneous
Dump(me; anOS : in out OStream from Standard)
returns OStream from Standard;
---Purpose: Dumps the minimum information about <me> on
-- <aStream>.
--
---C++: return &
---C++: alias operator<<
fields
myRootLabels : LabelList from TDF;
myLabelMap : LabelMap from TDF;
myAttributeMap : AttributeMap from TDF;
end DataSet;