OCC Main Page | DataExchange | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

DataExchange
TKXSBase
StepData


StepData_StepModel Class Reference

Gives access to
- entities in a STEP file,
- the STEP file header.
.

#include <StepData_StepModel.hxx>

Inheritance diagram for StepData_StepModel:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT StepData_StepModel ()
 Creates an empty STEP model with an empty header.
.
virtual Standard_EXPORT void Reservate (const Standard_Integer nbent)
 The standard reservation is completed for the map (id-num)
.
Standard_EXPORT Handle_Standard_Transient Entity (const Standard_Integer num) const
 returns entity given its rank.
Same as InterfaceEntity, but with a shorter name

Standard_EXPORT void GetFromAnother (const Handle(Interface_InterfaceModel)&other)
 gets header from another Model (uses Header Protocol)

Standard_EXPORT Handle_Interface_InterfaceModel NewEmptyModel () const
 Returns a New Empty Model, same type as <me>, i.e. StepModel
.
Standard_EXPORT Interface_EntityIterator Header () const
 returns Header entities under the form of an iterator

Standard_EXPORT Standard_Boolean HasHeaderEntity (const Handle(Standard_Type)&atype) const
 says if a Header entity has a specifed type

Standard_EXPORT Handle_Standard_Transient HeaderEntity (const Handle(Standard_Type)&atype) const
 Returns Header entity with specified type, if there is
.
Standard_EXPORT void ClearHeader ()
 Clears the Header
.
Standard_EXPORT void AddHeaderEntity (const Handle(Standard_Transient)&ent)
 Adds an Entity to the Header
.
virtual Standard_EXPORT void VerifyCheck (Handle(Interface_Check)&ach) const
 Specific Check, checks Header Items with HeaderProtocol
.
Standard_EXPORT void DumpHeader (const Handle(Message_Messenger)&S, const Standard_Integer level=0) const
 Dumps the Header, with the Header Protocol of StepData.
If the Header Protocol is not defined, for each Header Entity,
prints its Type. Else sends the Header under the form of
HEADER Section of an Ascii Step File
<level> is not used because Header is not so big
.
Standard_EXPORT void ClearLabels ()
 erases specific labels, i.e. clears the map (entity-ident)

Standard_EXPORT void SetIdentLabel (const Handle(Standard_Transient)&ent, const Standard_Integer ident)
 Attaches an ident to an entity to produce a label
(does nothing if <ent> is not in <me>)
.
Standard_EXPORT Standard_Integer IdentLabel (const Handle(Standard_Transient)&ent) const
 returns the label ident attached to an entity, 0 if not in me

Standard_EXPORT void PrintLabel (const Handle(Standard_Transient)&ent, const Handle(Message_Messenger)&S) const
 Prints label specific to STEP norm for a given entity, i.e.
if a LabelIdent has been recorded, its value with '#', else
the number in the model with '#' and between ()
.
Standard_EXPORT Handle_TCollection_HAsciiString StringLabel (const Handle(Standard_Transient)&ent) const
 Returns a string with the label attached to a given entity,
same form as for PrintLabel
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Private Attributes

Interface_EntityList theheader
Interface_DataMapOfTransientInteger theidnums

Constructor & Destructor Documentation

Standard_EXPORT StepData_StepModel::StepData_StepModel  ) 
 


Member Function Documentation

Standard_EXPORT void StepData_StepModel::AddHeaderEntity const Handle(Standard_Transient)&  ent  ) 
 

Standard_EXPORT void StepData_StepModel::ClearHeader  )  [virtual]
 

Implements Interface_InterfaceModel.

Standard_EXPORT void StepData_StepModel::ClearLabels  )  [virtual]
 

Implements Interface_InterfaceModel.

Standard_EXPORT void StepData_StepModel::DumpHeader const Handle(Message_Messenger)&  S,
const Standard_Integer  level = 0
const [virtual]
 

Implements Interface_InterfaceModel.

Standard_EXPORT Handle_Standard_Transient StepData_StepModel::Entity const Standard_Integer  num  )  const
 

Standard_EXPORT void StepData_StepModel::GetFromAnother const Handle(Interface_InterfaceModel)&  other  )  [virtual]
 

Implements Interface_InterfaceModel.

Standard_EXPORT const StepData_StepModel::Handle Standard_Type   )  const
 

Reimplemented from Interface_InterfaceModel.

Standard_EXPORT Standard_Boolean StepData_StepModel::HasHeaderEntity const Handle(Standard_Type)&  atype  )  const
 

Standard_EXPORT Interface_EntityIterator StepData_StepModel::Header  )  const
 

Standard_EXPORT Handle_Standard_Transient StepData_StepModel::HeaderEntity const Handle(Standard_Type)&  atype  )  const
 

Standard_EXPORT Standard_Integer StepData_StepModel::IdentLabel const Handle(Standard_Transient)&  ent  )  const
 

Standard_EXPORT Handle_Interface_InterfaceModel StepData_StepModel::NewEmptyModel  )  const [virtual]
 

Implements Interface_InterfaceModel.

Standard_EXPORT void StepData_StepModel::PrintLabel const Handle(Standard_Transient)&  ent,
const Handle(Message_Messenger)&  S
const [virtual]
 

Implements Interface_InterfaceModel.

virtual Standard_EXPORT void StepData_StepModel::Reservate const Standard_Integer  nbent  )  [virtual]
 

Reimplemented from Interface_InterfaceModel.

Standard_EXPORT void StepData_StepModel::SetIdentLabel const Handle(Standard_Transient)&  ent,
const Standard_Integer  ident
 

Standard_EXPORT Handle_TCollection_HAsciiString StepData_StepModel::StringLabel const Handle(Standard_Transient)&  ent  )  const [virtual]
 

Implements Interface_InterfaceModel.

virtual Standard_EXPORT void StepData_StepModel::VerifyCheck Handle(Interface_Check)&  ach  )  const [virtual]
 

Reimplemented from Interface_InterfaceModel.


Field Documentation

Interface_EntityList StepData_StepModel::theheader [private]
 

Interface_DataMapOfTransientInteger StepData_StepModel::theidnums [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 14:43:13 2008 for OpenCASCADE by  doxygen 1.4.1