1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-08-09 13:22:24 +03:00
Files
occt/src/TDataStd/TDataStd_ExtStringArray.cdl
abv 6e33d3ced2 0024830: Remove redundant keyword 'mutable' in CDL declarations
Redundant keyword 'mutable' removed in CDL files.
In IGESConvGeom_GeomBuilder, unused methods MakeXY() and MakeXYZ() removed.
Method StepAP214_AutoDesignGroupAssignment::Init() replicating same method of the base class is removed as it causes CDL extraction error after above (seemingly irrelevant) changes.
2014-05-29 14:58:25 +04:00

138 lines
5.1 KiB
Plaintext

-- Created on: 2002-01-16
-- Created by: Michael PONIKAROV
-- Copyright (c) 2002-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 ExtStringArray from TDataStd inherits Attribute from TDF
---Purpose: ExtStringArray Attribute. Handles an
-- array of UNICODE strings (represented by the
-- TCollection_ExtendedString class).
uses GUID from Standard,
ExtendedString from TCollection,
HArray1OfExtendedString from TColStd,
Attribute from TDF,
Label from TDF,
DeltaOnModification from TDF,
RelocationTable from TDF
is
---Purpose: class methods
-- =============
GetID (myclass)
---C++: return const &
---Purpose: Returns the GUID for the attribute.
returns GUID from Standard;
Set (myclass; label : Label from TDF; lower, upper : Integer from Standard;
isDelta : Boolean from Standard = Standard_False)
---Purpose: Finds, or creates, an ExtStringArray attribute with <lower>
-- and <upper> bounds. The ExtStringArray attribute is returned.
-- If <isDelta> == False, DefaultDeltaOnModification is used.
-- If attribute is already set, all input parameters are refused
-- and the found attribute is returned.
returns ExtStringArray from TDataStd;
---Category: ExtStringArray methods
-- ===============
Init(me : mutable; lower, upper : Integer from Standard);
---Purpose: Initializes the inner array with bounds from <lower> to <upper>
SetValue (me : mutable; Index : Integer from Standard; Value : ExtendedString from TCollection);
---Purpose: Sets the <Index>th element of the array to <Value>
-- OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the internal array.
Value (me; Index : Integer from Standard)
---Purpose: Returns the value of the <Index>th element of the array
--
---C++: return const &
---C++: alias operator ()
returns ExtendedString from TCollection;
Lower (me) returns Integer from Standard;
---Purpose: Return the lower bound.
Upper (me) returns Integer from Standard;
---Purpose: Return the upper bound
Length (me) returns Integer from Standard;
---Purpose: Return the number of elements of <me>.
ChangeArray(me : mutable; newArray : HArray1OfExtendedString from TColStd;
isCheckItems : Boolean = Standard_True);
---Purpose: Sets the inner array <myValue> of the ExtStringArray attribute to <newArray>.
-- If value of <newArray> differs from <myValue>, Backup performed and myValue
-- refers to new instance of HArray1OfExtendedString that holds <newArray> values
-- If <isCheckItems> equal True each item of <newArray> will be checked with each
-- item of <myValue> for coincidence (to avoid backup).
Array(me) returns HArray1OfExtendedString from TColStd;
---Purpose: Return the inner array of the ExtStringArray attribute
---C++: inline
---C++: return const
GetDelta(me) returns Boolean from Standard;
---C++: inline
SetDelta(me : mutable; isDelta : Boolean from Standard);
---C++: inline
---Purpose: for internal use only!
RemoveArray(me : mutable) is private;
---C++: inline
---Category: methodes of TDF_Attribute
-- =========================
Create returns ExtStringArray from TDataStd;
ID (me)
---C++: return const &
returns GUID from Standard;
Restore (me: mutable; With : Attribute from TDF);
NewEmpty (me)
returns Attribute from TDF;
Paste (me; Into : Attribute from TDF;
RT : RelocationTable from TDF);
Dump(me; anOS : in out OStream from Standard)
returns OStream from Standard
is redefined;
---C++: return &
---Category: methods to be added for using in DeltaOn Modification
-- =====================================================
DeltaOnModification(me; anOldAttribute : Attribute from TDF)
returns DeltaOnModification from TDF
---Purpose : Makes a DeltaOnModification between <me> and
-- <anOldAttribute>.
is redefined virtual;
fields
myValue : HArray1OfExtendedString from TColStd;
myIsDelta : Boolean from Standard;
friends
class DeltaOnModificationOfExtStringArray from TDataStd
end ExtStringArray;