# DataExchange
TKIGES
IGESDraw

# IGESDraw_NetworkSubfigureDef Class Reference

defines IGESNetworkSubfigureDef,
Type <320> Form Number <0> in package IGESDraw

`#include <IGESDraw_NetworkSubfigureDef.hxx>`

Inheritance diagram for IGESDraw_NetworkSubfigureDef:

[legend]

## Public Member Functions

Standard_EXPORT | IGESDraw_NetworkSubfigureDef ()
Standard_EXPORT void | Init (const Standard_Integer aDepth, const Handle(TCollection_HAsciiString)&aName, const Handle(IGESData_HArray1OfIGESEntity)&allEntities, const Standard_Integer aTypeFlag, const Handle(TCollection_HAsciiString)&aDesignator, const Handle(IGESGraph_TextDisplayTemplate)&aTemplate, const Handle(IGESDraw_HArray1OfConnectPoint)&allPointEntities)

This method is used to set fields of the class
NetworkSubfigureDef
- aDepth : Depth of Subfigure
(indicating the amount of nesting)
- aName : Subfigure Name
- allEntities : Associated subfigures Entities exclusive
of primary reference designator and
Control Points.
- aTypeFlag : Type flag determines which Entity
belongs in which design
(Logical design or Physical design)
- aDesignator : Designator HAsciiString and its Template
- allPointEntities : Associated Connect Point Entities
.

Standard_EXPORT Standard_Integer | Depth () const
| returns Depth of Subfigure(indication the amount of nesting) Note : The Depth is inclusive of both Network Subfigure Definition Entity and the Ordinary Subfigure Definition Entity. Thus, the two may be nested.
Standard_EXPORT Handle_TCollection_HAsciiString | Name () const
| returns the Subfigure Name
Standard_EXPORT Standard_Integer | NbEntities () const
| returns Number of Associated(child) entries in subfigure exclusive of primary reference designator and Control Points
Standard_EXPORT Handle_IGESData_IGESEntity | Entity (const Standard_Integer Index) const
| returns the Index'th IGESEntity in subfigure exclusive of primary reference designator and Control Points raises exception if Index <=0 or Index > NbEntities()
Standard_EXPORT Standard_Integer | TypeFlag () const
| return value = 0 : Not Specified = 1 : Logical design = 2 : Physical design
Standard_EXPORT Handle_TCollection_HAsciiString | Designator () const
| returns Primary Reference Designator
Standard_EXPORT Standard_Boolean | HasDesignatorTemplate () const
| returns True if Text Display Template is specified for primary designator else returns False
Standard_EXPORT Handle_IGESGraph_TextDisplayTemplate | DesignatorTemplate () const
| if Text Display Template specified then return TextDisplayTemplate else return NULL Handle
Standard_EXPORT Standard_Integer | NbPointEntities () const
| returns the Number Of Associated(child) Connect Point Entities
Standard_EXPORT Standard_Boolean | HasPointEntity (const Standard_Integer Index) const
| returns True is Index'th Associated Connect Point Entity is present else returns False raises exception if Index is out of bound
Standard_EXPORT Handle_IGESDraw_ConnectPoint | PointEntity (const Standard_Integer Index) const
| returns the Index'th Associated Connect Point Entity raises exception if Index <= 0 or Index > NbPointEntities()
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const

## Private Attributes

Standard_Integer | theDepth
Handle_TCollection_HAsciiString | theName
Handle_IGESData_HArray1OfIGESEntity | theEntities
Standard_Integer | theTypeFlag
Handle_TCollection_HAsciiString | theDesignator
Handle_IGESGraph_TextDisplayTemplate | theDesignatorTemplate
Handle_IGESDraw_HArray1OfConnectPoint | thePointEntities

## Constructor & Destructor Documentation

Standard_EXPORT IGESDraw_NetworkSubfigureDef::IGESDraw_NetworkSubfigureDef | ( |  | ) |

## Member Function Documentation

Standard_EXPORT Standard_Integer IGESDraw_NetworkSubfigureDef::Depth | ( |  | ) | const

Standard_EXPORT Handle_TCollection_HAsciiString IGESDraw_NetworkSubfigureDef::Designator | ( |  | ) | const

Standard_EXPORT Handle_IGESGraph_TextDisplayTemplate IGESDraw_NetworkSubfigureDef::DesignatorTemplate | ( |  | ) | const

Standard_EXPORT Handle_IGESData_IGESEntity IGESDraw_NetworkSubfigureDef::Entity | ( | const Standard_Integer | Index | ) | const

Standard_EXPORT const IGESDraw_NetworkSubfigureDef::Handle | ( | Standard_Type |  | ) | const

| Reimplemented from IGESData_IGESEntity.

Standard_EXPORT Standard_Boolean IGESDraw_NetworkSubfigureDef::HasDesignatorTemplate | ( |  | ) | const

Standard_EXPORT Standard_Boolean IGESDraw_NetworkSubfigureDef::HasPointEntity | ( | const Standard_Integer | Index | ) | const

Standard_EXPORT void IGESDraw_NetworkSubfigureDef::Init | ( | const Standard_Integer | aDepth,
|  | const Handle(TCollection_HAsciiString)& | aName,
|  | const Handle(IGESData_HArray1OfIGESEntity)& | allEntities,
|  | const Standard_Integer | aTypeFlag,
|  | const Handle(TCollection_HAsciiString)& | aDesignator,
|  | const Handle(IGESGraph_TextDisplayTemplate)& | aTemplate,
|  | const Handle(IGESDraw_HArray1OfConnectPoint)& | allPointEntities
| ) |

Standard_EXPORT Handle_TCollection_HAsciiString IGESDraw_NetworkSubfigureDef::Name | ( |  | ) | const

Standard_EXPORT Standard_Integer IGESDraw_NetworkSubfigureDef::NbEntities | ( |  | ) | const

Standard_EXPORT Standard_Integer IGESDraw_NetworkSubfigureDef::NbPointEntities | ( |  | ) | const

Standard_EXPORT Handle_IGESDraw_ConnectPoint IGESDraw_NetworkSubfigureDef::PointEntity | ( | const Standard_Integer | Index | ) | const

Standard_EXPORT Standard_Integer IGESDraw_NetworkSubfigureDef::TypeFlag | ( |  | ) | const

## Field Documentation

Standard_Integer IGESDraw_NetworkSubfigureDef::theDepth`[private]`

Handle_TCollection_HAsciiString IGESDraw_NetworkSubfigureDef::theDesignator`[private]`

Handle_IGESGraph_TextDisplayTemplate IGESDraw_NetworkSubfigureDef::theDesignatorTemplate`[private]`

Handle_IGESData_HArray1OfIGESEntity IGESDraw_NetworkSubfigureDef::theEntities`[private]`

Handle_TCollection_HAsciiString IGESDraw_NetworkSubfigureDef::theName`[private]`

Handle_IGESDraw_HArray1OfConnectPoint IGESDraw_NetworkSubfigureDef::thePointEntities`[private]`

Standard_Integer IGESDraw_NetworkSubfigureDef::theTypeFlag`[private]`

The documentation for this class was generated from the following file:

- IGESDraw_NetworkSubfigureDef.hxx