include/opencascade/StepBasic_ProductDefinitionRelationship.hxx

0001 // Created on: 2000-07-03
0002 // Created by: Andrey BETENEV
0003 // Copyright (c) 2000-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _StepBasic_ProductDefinitionRelationship_HeaderFile
0017 #define _StepBasic_ProductDefinitionRelationship_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_Type.hxx>
0021
0022 #include <Standard_Transient.hxx>
0023 #include <StepBasic_ProductDefinitionOrReference.hxx>
0024 class TCollection_HAsciiString;
0025 class StepBasic_ProductDefinition;
0026
0027 //! Representation of STEP entity ProductDefinitionRelationship
0028 class StepBasic_ProductDefinitionRelationship : public Standard_Transient
0029 {
0030
0031 public:
0032   //! Empty constructor
0033   Standard_EXPORT StepBasic_ProductDefinitionRelationship();
0034
0035   //! Initialize all fields (own and inherited)
0036   Standard_EXPORT void Init(
0037     const occ::handle<TCollection_HAsciiString>&    aId,
0038     const occ::handle<TCollection_HAsciiString>&    aName,
0039     const bool                                      hasDescription,
0040     const occ::handle<TCollection_HAsciiString>&    aDescription,
0041     const occ::handle<StepBasic_ProductDefinition>& aRelatingProductDefinition,
0042     const occ::handle<StepBasic_ProductDefinition>& aRelatedProductDefinition);
0043
0044   //! Initialize all fields (own and inherited)
0045   Standard_EXPORT void Init(
0046     const occ::handle<TCollection_HAsciiString>&  aId,
0047     const occ::handle<TCollection_HAsciiString>&  aName,
0048     const bool                                    hasDescription,
0049     const occ::handle<TCollection_HAsciiString>&  aDescription,
0050     const StepBasic_ProductDefinitionOrReference& aRelatingProductDefinition,
0051     const StepBasic_ProductDefinitionOrReference& aRelatedProductDefinition);
0052
0053   //! Returns field Id
0054   Standard_EXPORT occ::handle<TCollection_HAsciiString> Id() const;
0055
0056   //! Set field Id
0057   Standard_EXPORT void SetId(const occ::handle<TCollection_HAsciiString>& Id);
0058
0059   //! Returns field Name
0060   Standard_EXPORT occ::handle<TCollection_HAsciiString> Name() const;
0061
0062   //! Set field Name
0063   Standard_EXPORT void SetName(const occ::handle<TCollection_HAsciiString>& Name);
0064
0065   //! Returns field Description
0066   Standard_EXPORT occ::handle<TCollection_HAsciiString> Description() const;
0067
0068   //! Set field Description
0069   Standard_EXPORT void SetDescription(const occ::handle<TCollection_HAsciiString>& Description);
0070
0071   //! Returns True if optional field Description is defined
0072   Standard_EXPORT bool HasDescription() const;
0073
0074   //! Returns field RelatingProductDefinition
0075   Standard_EXPORT occ::handle<StepBasic_ProductDefinition> RelatingProductDefinition() const;
0076
0077   //! Returns field RelatingProductDefinition in AP242
0078   Standard_EXPORT StepBasic_ProductDefinitionOrReference RelatingProductDefinitionAP242() const;
0079
0080   //! Set field RelatingProductDefinition
0081   Standard_EXPORT void SetRelatingProductDefinition(
0082     const occ::handle<StepBasic_ProductDefinition>& RelatingProductDefinition);
0083
0084   //! Set field RelatingProductDefinition in AP242
0085   Standard_EXPORT void SetRelatingProductDefinition(
0086     const StepBasic_ProductDefinitionOrReference& RelatingProductDefinition);
0087
0088   //! Returns field RelatedProductDefinition
0089   Standard_EXPORT occ::handle<StepBasic_ProductDefinition> RelatedProductDefinition() const;
0090
0091   //! Returns field RelatedProductDefinition in AP242
0092   Standard_EXPORT StepBasic_ProductDefinitionOrReference RelatedProductDefinitionAP242() const;
0093
0094   //! Set field RelatedProductDefinition
0095   Standard_EXPORT void SetRelatedProductDefinition(
0096     const occ::handle<StepBasic_ProductDefinition>& RelatedProductDefinition);
0097
0098   //! Set field RelatedProductDefinition in AP242
0099   Standard_EXPORT void SetRelatedProductDefinition(
0100     const StepBasic_ProductDefinitionOrReference& RelatedProductDefinition);
0101
0102   DEFINE_STANDARD_RTTIEXT(StepBasic_ProductDefinitionRelationship, Standard_Transient)
0103
0104 private:
0105   occ::handle<TCollection_HAsciiString>  theId;
0106   occ::handle<TCollection_HAsciiString>  theName;
0107   occ::handle<TCollection_HAsciiString>  theDescription;
0108   StepBasic_ProductDefinitionOrReference theRelatingProductDefinition;
0109   StepBasic_ProductDefinitionOrReference theRelatedProductDefinition;
0110   bool                                   defDescription;
0111 };
0112
0113 #endif // _StepBasic_ProductDefinitionRelationship_HeaderFile