1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-06 18:26:22 +03:00
occt/src/IGESData/IGESData_SpecificLib.hxx
rkv 36b9ff756a 0026595: Lost some comments in OCCT-code after cdl elimination
Recovered comments for instance classes from CDL generic classes.
2015-10-15 14:04:43 +03:00

121 lines
3.8 KiB
C++

// Created on: 1992-04-06
// Created by: Christian CAILLET
// Copyright (c) 1992-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.
#ifndef _IGESData_SpecificLib_HeaderFile
#define _IGESData_SpecificLib_HeaderFile
#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>
#include <Standard_Boolean.hxx>
#include <Standard_Integer.hxx>
class IGESData_NodeOfSpecificLib;
class Standard_NoSuchObject;
class IGESData_IGESEntity;
class IGESData_SpecificModule;
class IGESData_Protocol;
class IGESData_GlobalNodeOfSpecificLib;
class Standard_Transient;
class IGESData_SpecificLib
{
public:
DEFINE_STANDARD_ALLOC
//! Adds a couple (Module-Protocol) into the global definition set
//! for this class of Library.
Standard_EXPORT static void SetGlobal (const Handle(IGESData_SpecificModule)& amodule, const Handle(IGESData_Protocol)& aprotocol);
//! Creates a Library which complies with a Protocol, that is :
//! Same class (criterium IsInstance)
//! This creation gets the Modules from the global set, those
//! which are bound to the given Protocol and its Resources
Standard_EXPORT IGESData_SpecificLib(const Handle(IGESData_Protocol)& aprotocol);
//! Creates an empty Library : it will later by filled by method
//! AddProtocol
Standard_EXPORT IGESData_SpecificLib();
//! Adds a couple (Module-Protocol) to the Library, given the
//! class of a Protocol. Takes Resources into account.
//! (if <aprotocol> is not of type TheProtocol, it is not added)
Standard_EXPORT void AddProtocol (const Handle(Standard_Transient)& aprotocol);
//! Clears the list of Modules of a library (can be used to
//! redefine the order of Modules before action : Clear then
//! refill the Library by calls to AddProtocol)
Standard_EXPORT void Clear();
//! Sets a library to be defined with the complete Global list
//! (all the couples Protocol/Modules recorded in it)
Standard_EXPORT void SetComplete();
//! Selects a Module from the Library, given an Object.
//! Returns True if Select has succeeded, False else.
//! Also Returns (as arguments) the selected Module and the Case
//! Number determined by the associated Protocol.
//! If Select has failed, <module> is Null Handle and CN is zero.
//! (Select can work on any criterium, such as Object DynamicType)
Standard_EXPORT Standard_Boolean Select (const Handle(IGESData_IGESEntity)& obj, Handle(IGESData_SpecificModule)& module, Standard_Integer& CN) const;
//! Starts Iteration on the Modules (sets it on the first one)
Standard_EXPORT void Start();
//! Returns True if there are more Modules to iterate on
Standard_EXPORT Standard_Boolean More() const;
//! Iterates by getting the next Module in the list
//! If there is none, the exception will be raised by Value
Standard_EXPORT void Next();
//! Returns the current Module in the Iteration
Standard_EXPORT const Handle(IGESData_SpecificModule)& Module() const;
//! Returns the current Protocol in the Iteration
Standard_EXPORT const Handle(IGESData_Protocol)& Protocol() const;
protected:
private:
Handle(IGESData_NodeOfSpecificLib) thelist;
Handle(IGESData_NodeOfSpecificLib) thecurr;
};
#endif // _IGESData_SpecificLib_HeaderFile