2 #ifndef HYDROData_Channel_HeaderFile
3 #define HYDROData_Channel_HeaderFile
5 #include "HYDROData_ArtificialObject.h"
7 class Handle(HYDROData_Polyline3D);
8 class Handle(HYDROData_Profile);
10 DEFINE_STANDARD_HANDLE(HYDROData_Channel, HYDROData_ArtificialObject)
12 /**\class HYDROData_Channel
16 class HYDROData_Channel : public HYDROData_ArtificialObject
20 * Enumeration of tags corresponding to the persistent object parameters.
24 DataTag_First = HYDROData_ArtificialObject::DataTag_First + 100, ///< first tag, to reserve
30 DEFINE_STANDARD_RTTI(HYDROData_Channel);
33 * Returns the kind of this object. Must be redefined in all objects of known type.
35 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_CHANNEL;}
38 * Dump object to Python script representation.
40 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
43 * Returns the list of all reference objects of this object.
45 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
48 * Returns the top shape of the object.
50 HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
53 * Returns the 3d shape of the object.
55 HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
58 * Update the shape presentations of stream.
59 * Call this method whenever you made changes for channel data.
61 HYDRODATA_EXPORT virtual void Update();
65 // Public methods to work with Channel
68 * Sets reference guide line object for channel.
70 HYDRODATA_EXPORT virtual bool SetGuideLine( const Handle(HYDROData_Polyline3D)& theGuideLine );
73 * Returns reference guide line object of channel.
75 HYDRODATA_EXPORT virtual Handle(HYDROData_Polyline3D) GetGuideLine() const;
78 * Remove reference guide line object from channel.
80 HYDRODATA_EXPORT virtual void RemoveGuideLine();
84 * Sets reference profile object for channel.
86 HYDRODATA_EXPORT virtual bool SetProfile( const Handle(HYDROData_Profile)& theProfile );
89 * Returns reference profile object of channel.
91 HYDRODATA_EXPORT virtual Handle(HYDROData_Profile) GetProfile() const;
94 * Remove reference profile object from channel.
96 HYDRODATA_EXPORT virtual void RemoveProfile();
101 friend class HYDROData_Iterator;
104 * Creates new object in the internal data structure. Use higher level objects
105 * to create objects with real content.
107 HYDRODATA_EXPORT HYDROData_Channel();
110 * Destructs properties of the object and object itself, removes it from the document.
112 virtual HYDRODATA_EXPORT ~HYDROData_Channel();