Files
OCCT/src/Storage/Storage_Root.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

81 lines
3.3 KiB
Plaintext

-- Created on: 1997-02-24
-- Created by: Kernel
-- Copyright (c) 1997-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 Root from Storage
inherits TShared from MMgt
---Purpose:
-- A root object extracted from a Storage_Data object.
-- A Storage_Root encapsulates a persistent
-- object which is a root of a Storage_Data object.
-- It contains additional information: the name and
-- the data type of the persistent object.
-- When retrieving a Storage_Data object from a
-- container (for example, a file) you access its
-- roots with the function Roots which returns a
-- sequence of root objects. The provided functions
-- allow you to request information about each root of the sequence.
-- You do not create explicit roots: when inserting
-- data in a Storage_Data object, you just provide
-- the persistent object and optionally its name to the function AddRoot.
uses AsciiString from TCollection
is
Create returns Root from Storage;
Create(aName : AsciiString from TCollection;
anObject : Persistent from Standard) returns Root from Storage;
SetName(me : mutable; aName : AsciiString from TCollection);
Name(me) returns AsciiString from TCollection;
---Purpose:
-- Returns the name of this root object.
-- The name may have been given explicitly when
-- the root was inserted into the Storage_Data
-- object. If not, the name is a reference number
-- which was assigned automatically by the driver
-- when writing the set of data into the container.
-- When naming the roots, it is easier to retrieve
-- objects by significant references rather than by
-- references without any semantic values.
-- Warning
-- The returned string will be empty if you call this
-- function before having named this root object,
-- either explicitly, or when writing the set of data
-- into the container.
SetObject(me : mutable; anObject : Persistent from Standard);
Object(me) returns Persistent from Standard;
---Purpose:
-- Returns the persistent object encapsulated by this root.
Type(me) returns AsciiString from TCollection;
---Purpose: Returns the name of this root type.
SetReference(me : mutable; aRef : Integer from Standard) is private;
Reference(me) returns Integer from Standard is private;
SetType(me : mutable; aType : AsciiString from TCollection) is private;
fields
myName : AsciiString from TCollection;
myType : AsciiString from TCollection;
myObject : Persistent from Standard;
myRef : Integer from Standard;
friends class Schema from Storage
end;