FDO API Reference Feature Data Objects

IMultiPoint.h

Go to the documentation of this file.
00001 #ifndef _IMULTIPOINT_H_
00002 #define _IMULTIPOINT_H_
00003 
00004 //
00005 // Copyright (C) 2004-2006  Autodesk, Inc.
00006 // 
00007 // This library is free software; you can redistribute it and/or
00008 // modify it under the terms of version 2.1 of the GNU Lesser
00009 // General Public License as published by the Free Software Foundation.
00010 // 
00011 // This library is distributed in the hope that it will be useful,
00012 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00013 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014 // Lesser General Public License for more details.
00015 // 
00016 // You should have received a copy of the GNU Lesser General Public
00017 // License along with this library; if not, write to the Free Software
00018 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00019 //
00020 
00021 
00022 
00023 #ifdef _WIN32
00024 #pragma once
00025 #endif
00026 
00027 #include <Geometry/IGeometricAggregateAbstract.h>
00028 #include <Geometry/IPoint.h>
00029 
00030 /// \brief
00031 /// The FdoIMultiPoint class is a multi-point aggregate Geometry type.
00032 class FdoIMultiPoint : public FdoIGeometricAggregateAbstract
00033 {
00034 public:
00035 
00036     /// \brief
00037     /// Gets a point at the given zero-based index.
00038     /// 
00039     /// \param index 
00040     /// Input Zero-based index in the object's list of points.
00041     /// 
00042     /// \return
00043     /// Returns a point
00044     /// 
00045     FDO_GEOM_API virtual FdoIPoint* GetItem(
00046         FdoInt32 index) const = 0;
00047 
00048     /// \brief
00049     /// Gets the ordinates as an array.
00050     /// 
00051     /// \remarks
00052     /// The caller must not free the returned array.
00053     /// The ordinates are in the order XYZMXYZM..., with only those present 
00054     /// according to the dimensionality.
00055     /// 
00056     /// \return
00057     /// Returns the ordinates
00058     /// 
00059     FDO_GEOM_API virtual const double * GetOrdinates() = 0;
00060 
00061 protected:
00062 
00063     /// \brief
00064     /// Constructs a default instance.
00065     /// 
00066     /// \return
00067     /// Returns nothing
00068     /// 
00069     FDO_GEOM_API FdoIMultiPoint() {};
00070 
00071     /// \brief
00072     /// Default destructor.
00073     /// 
00074     /// \return
00075     /// Returns nothing
00076     /// 
00077     FDO_GEOM_API virtual ~FdoIMultiPoint() {};
00078 };
00079 #endif
00080 
00081 

Comments or suggestions? Send us feedback.