include/opencascade/StepRepr_ConfigurationItem.hxx

0001 // Created on: 1999-11-26
0002 // Created by: Andrey BETENEV
0003 // Copyright (c) 1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _StepRepr_ConfigurationItem_HeaderFile
0018 #define _StepRepr_ConfigurationItem_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Boolean.hxx>
0024 #include <Standard_Transient.hxx>
0025 class TCollection_HAsciiString;
0026 class StepRepr_ProductConcept;
0027
0028 class StepRepr_ConfigurationItem;
0029 DEFINE_STANDARD_HANDLE(StepRepr_ConfigurationItem, Standard_Transient)
0030
0031 //! Representation of STEP entity ConfigurationItem
0032 class StepRepr_ConfigurationItem : public Standard_Transient
0033 {
0034
0035 public:
0036   //! Empty constructor
0037   Standard_EXPORT StepRepr_ConfigurationItem();
0038
0039   //! Initialize all fields (own and inherited)
0040   Standard_EXPORT void Init(const Handle(TCollection_HAsciiString)& aId,
0041                             const Handle(TCollection_HAsciiString)& aName,
0042                             const Standard_Boolean                  hasDescription,
0043                             const Handle(TCollection_HAsciiString)& aDescription,
0044                             const Handle(StepRepr_ProductConcept)&  aItemConcept,
0045                             const Standard_Boolean                  hasPurpose,
0046                             const Handle(TCollection_HAsciiString)& aPurpose);
0047
0048   //! Returns field Id
0049   Standard_EXPORT Handle(TCollection_HAsciiString) Id() const;
0050
0051   //! Set field Id
0052   Standard_EXPORT void SetId(const Handle(TCollection_HAsciiString)& Id);
0053
0054   //! Returns field Name
0055   Standard_EXPORT Handle(TCollection_HAsciiString) Name() const;
0056
0057   //! Set field Name
0058   Standard_EXPORT void SetName(const Handle(TCollection_HAsciiString)& Name);
0059
0060   //! Returns field Description
0061   Standard_EXPORT Handle(TCollection_HAsciiString) Description() const;
0062
0063   //! Set field Description
0064   Standard_EXPORT void SetDescription(const Handle(TCollection_HAsciiString)& Description);
0065
0066   //! Returns True if optional field Description is defined
0067   Standard_EXPORT Standard_Boolean HasDescription() const;
0068
0069   //! Returns field ItemConcept
0070   Standard_EXPORT Handle(StepRepr_ProductConcept) ItemConcept() const;
0071
0072   //! Set field ItemConcept
0073   Standard_EXPORT void SetItemConcept(const Handle(StepRepr_ProductConcept)& ItemConcept);
0074
0075   //! Returns field Purpose
0076   Standard_EXPORT Handle(TCollection_HAsciiString) Purpose() const;
0077
0078   //! Set field Purpose
0079   Standard_EXPORT void SetPurpose(const Handle(TCollection_HAsciiString)& Purpose);
0080
0081   //! Returns True if optional field Purpose is defined
0082   Standard_EXPORT Standard_Boolean HasPurpose() const;
0083
0084   DEFINE_STANDARD_RTTIEXT(StepRepr_ConfigurationItem, Standard_Transient)
0085
0086 protected:
0087 private:
0088   Handle(TCollection_HAsciiString) theId;
0089   Handle(TCollection_HAsciiString) theName;
0090   Handle(TCollection_HAsciiString) theDescription;
0091   Handle(StepRepr_ProductConcept)  theItemConcept;
0092   Handle(TCollection_HAsciiString) thePurpose;
0093   Standard_Boolean                 defDescription;
0094   Standard_Boolean                 defPurpose;
0095 };
0096
0097 #endif // _StepRepr_ConfigurationItem_HeaderFile