FDO .NET API Reference Feature Data Objects

mgNetworkClass.h

Go to the documentation of this file.
00001 /*
00002 * Copyright (C) 2004-2006  Autodesk, Inc.
00003 * 
00004 * This library is free software; you can redistribute it and/or
00005 * modify it under the terms of version 2.1 of the GNU Lesser
00006 * General Public License as published by the Free Software Foundation.
00007 * 
00008 * This library is distributed in the hope that it will be useful,
00009 * but WITHOUT ANY WARRANTY; without even the implied warranty of
00010 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00011 * Lesser General Public License for more details.
00012 * 
00013 * You should have received a copy of the GNU Lesser General Public
00014 * License along with this library; if not, write to the Free Software
00015 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00016 *
00017 */
00018 
00019 #pragma  once
00020 
00021 #include "FDO\Schema\mgClassDefinition.h"
00022 #include "FDO\Schema\mgClassType.h"
00023 
00024 class FdoNetworkClass;
00025 
00026 BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
00027 public __gc class NetworkLayerClass;
00028 
00029 /// \ingroup (OSGeoFDOSchema)
00030 /// \brief
00031 /// The NetworkClass derives from ClassDefinition and can be used to represent a 
00032 /// linear network. The NetworkClass has 2 pre-defined base properties. The first is a Boolean 
00033 /// type called "Directed". And the second is a ObjectPropertyDefinition of an ordered collection called "Layers".
00034 /// The "Directed" property is used to indicate if the network is directed or undirected. 
00035 /// The network is directed if the Directed property is set to true. Otherwise, it is undirected. The Layers property
00036 /// is used to contain the ordered list of layers. The class of the layers object property must be of type NetworkLayer.
00037 /// <p><b>Note:</b> <span class="red_text">This Help topic is provided for informational use only. There is
00038 /// no interface or support provided. OSGeo reserves the right to change
00039 /// the software related to the content herein.</span>
00040 public __gc class NetworkClass : public NAMESPACE_OSGEO_FDO_SCHEMA::ClassDefinition
00041 {
00042 public:
00043     /// \brief
00044     /// Constructs a default instance of an NetworkClass.
00045     /// 
00046     NetworkClass();
00047 
00048     /// \brief
00049     /// Constructs an instance of an NetworkClass using the specified arguments.
00050     /// 
00051     /// \param name 
00052     /// Input name
00053     /// \param description 
00054     /// Input description
00055     /// 
00056     NetworkClass(System::String* name, System::String* description);
00057 
00058     /// \brief
00059     /// Gets the concrete class type.
00060     /// 
00061     /// \return
00062     /// Returns class type
00063     /// 
00064     __property NAMESPACE_OSGEO_FDO_SCHEMA::ClassType get_ClassType();
00065 
00066     /// \brief
00067     /// Gets a reference to the layer class.
00068     /// 
00069     /// \return
00070     /// Returns a network layer class definition
00071     /// 
00072     __property  NAMESPACE_OSGEO_FDO_SCHEMA::NetworkLayerClass* get_LayerClass();
00073 
00074     /// \brief
00075     /// Sets a reference to the layer class. The layer class is used to define the system
00076     /// layers ordered collection object  property.
00077     /// 
00078     /// \param value 
00079     /// Input an network layer class
00080     /// 
00081     /// \return
00082     /// Returns nothing
00083     /// 
00084     __property  System::Void set_LayerClass(NAMESPACE_OSGEO_FDO_SCHEMA::NetworkLayerClass* value);
00085 
00086     /// \brief
00087     /// Constructs a NetworkClass object based on an unmanaged instance of the object
00088     /// 
00089     /// \param unmanaged 
00090     /// Input A Pointer to the unmanaged object.
00091     /// 
00092     /// \param autoDelete 
00093     /// Input Indicates if the constructed object should be automatically deleted 
00094     /// once it no longer referenced.
00095     /// 
00096     NetworkClass(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_SCHEMA::ClassDefinition(unmanaged, autoDelete)
00097     {
00098 
00099     }
00100 
00101 public private:
00102     inline FdoNetworkClass* GetImpObj();
00103 };
00104 
00105 END_NAMESPACE_OSGEO_FDO_SCHEMA
00106 
00107 

Comments or suggestions? Send us feedback.