include/opencascade/StepRepr_ShapeAspectRelationship.hxx

0001 // Created on: 2000-04-18
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 _StepRepr_ShapeAspectRelationship_HeaderFile
0017 #define _StepRepr_ShapeAspectRelationship_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_Type.hxx>
0021
0022 #include <Standard_Transient.hxx>
0023 class TCollection_HAsciiString;
0024 class StepRepr_ShapeAspect;
0025
0026 class StepRepr_ShapeAspectRelationship;
0027 DEFINE_STANDARD_HANDLE(StepRepr_ShapeAspectRelationship, Standard_Transient)
0028
0029 //! Representation of STEP entity ShapeAspectRelationship
0030 class StepRepr_ShapeAspectRelationship : public Standard_Transient
0031 {
0032
0033 public:
0034   //! Empty constructor
0035   Standard_EXPORT StepRepr_ShapeAspectRelationship();
0036
0037   //! Initialize all fields (own and inherited)
0038   Standard_EXPORT void Init(const Handle(TCollection_HAsciiString)& aName,
0039                             const Standard_Boolean                  hasDescription,
0040                             const Handle(TCollection_HAsciiString)& aDescription,
0041                             const Handle(StepRepr_ShapeAspect)&     aRelatingShapeAspect,
0042                             const Handle(StepRepr_ShapeAspect)&     aRelatedShapeAspect);
0043
0044   //! Returns field Name
0045   Standard_EXPORT Handle(TCollection_HAsciiString) Name() const;
0046
0047   //! Set field Name
0048   Standard_EXPORT void SetName(const Handle(TCollection_HAsciiString)& Name);
0049
0050   //! Returns field Description
0051   Standard_EXPORT Handle(TCollection_HAsciiString) Description() const;
0052
0053   //! Set field Description
0054   Standard_EXPORT void SetDescription(const Handle(TCollection_HAsciiString)& Description);
0055
0056   //! Returns True if optional field Description is defined
0057   Standard_EXPORT Standard_Boolean HasDescription() const;
0058
0059   //! Returns field RelatingShapeAspect
0060   Standard_EXPORT Handle(StepRepr_ShapeAspect) RelatingShapeAspect() const;
0061
0062   //! Set field RelatingShapeAspect
0063   Standard_EXPORT void SetRelatingShapeAspect(
0064     const Handle(StepRepr_ShapeAspect)& RelatingShapeAspect);
0065
0066   //! Returns field RelatedShapeAspect
0067   Standard_EXPORT Handle(StepRepr_ShapeAspect) RelatedShapeAspect() const;
0068
0069   //! Set field RelatedShapeAspect
0070   Standard_EXPORT void SetRelatedShapeAspect(
0071     const Handle(StepRepr_ShapeAspect)& RelatedShapeAspect);
0072
0073   DEFINE_STANDARD_RTTIEXT(StepRepr_ShapeAspectRelationship, Standard_Transient)
0074
0075 protected:
0076 private:
0077   Handle(TCollection_HAsciiString) theName;
0078   Handle(TCollection_HAsciiString) theDescription;
0079   Handle(StepRepr_ShapeAspect)     theRelatingShapeAspect;
0080   Handle(StepRepr_ShapeAspect)     theRelatedShapeAspect;
0081   Standard_Boolean                 defDescription;
0082 };
0083
0084 #endif // _StepRepr_ShapeAspectRelationship_HeaderFile