IGESDraw_NetworkSubfigureDef Class Reference

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

#include <IGESDraw_NetworkSubfigureDef.hxx>

Inheritance diagram for IGESDraw_NetworkSubfigureDef:

Public Member Functions
	IGESDraw_NetworkSubfigureDef ()
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
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.
Handle_TCollection_HAsciiString	Name () const
	returns the Subfigure Name
Standard_Integer	NbEntities () const
	returns Number of Associated(child) entries in subfigure exclusive of primary reference designator and Control Points
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_Integer	TypeFlag () const
	return value = 0 : Not Specified = 1 : Logical design = 2 : Physical design
Handle_TCollection_HAsciiString	Designator () const
	returns Primary Reference Designator
Standard_Boolean	HasDesignatorTemplate () const
	returns True if Text Display Template is specified for primary designator else returns False
Handle_IGESGraph_TextDisplayTemplate	DesignatorTemplate () const
	if Text Display Template specified then return TextDisplayTemplate else return NULL Handle
Standard_Integer	NbPointEntities () const
	returns the Number Of Associated(child) Connect Point Entities
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
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()

---

Constructor & Destructor Documentation

IGESDraw_NetworkSubfigureDef::IGESDraw_NetworkSubfigureDef

(

)

---

Member Function Documentation

Standard_Integer IGESDraw_NetworkSubfigureDef::Depth

(

)

const

Handle_TCollection_HAsciiString IGESDraw_NetworkSubfigureDef::Designator

(

)

const

Handle_IGESGraph_TextDisplayTemplate IGESDraw_NetworkSubfigureDef::DesignatorTemplate

(

)

const

Handle_IGESData_IGESEntity IGESDraw_NetworkSubfigureDef::Entity

(

const Standard_Integer

Index

)

const

Standard_Boolean IGESDraw_NetworkSubfigureDef::HasDesignatorTemplate

(

)

const

Standard_Boolean IGESDraw_NetworkSubfigureDef::HasPointEntity

(

const Standard_Integer

Index

)

const

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
	)

• 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
  

Handle_TCollection_HAsciiString IGESDraw_NetworkSubfigureDef::Name

(

)

const

Standard_Integer IGESDraw_NetworkSubfigureDef::NbEntities

(

)

const

Standard_Integer IGESDraw_NetworkSubfigureDef::NbPointEntities

(

)

const

Handle_IGESDraw_ConnectPoint IGESDraw_NetworkSubfigureDef::PointEntity

(

const Standard_Integer

Index

)

const

Standard_Integer IGESDraw_NetworkSubfigureDef::TypeFlag

(

)

const

---

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

• IGESDraw_NetworkSubfigureDef.hxx