Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
IGESData_FreeFormatEntity Class Reference

This class allows to create IGES Entities in a literal form :
their definition is free, but they are not recognized as
instances of specific classes.

This is a way to define test files without having to create
and fill specific classes of Entities, or creating an IGES
File ex nihilo, with respect for all format constraints
(such a way is very difficult to run and to master).

This class has the same content as an UndefinedEntity, only
it gives way to act on its content

#include <IGESData_FreeFormatEntity.hxx>

Inheritance diagram for IGESData_FreeFormatEntity:
Inheritance graph
[legend]

Public Member Functions

 IGESData_FreeFormatEntity ()
 Creates a completely empty FreeFormatEntity

void SetTypeNumber (const Standard_Integer typenum)
 Sets Type Number to a new Value, and Form Number to Zero

void SetFormNumber (const Standard_Integer formnum)
 Sets Form Number to a new Value (to called after SetTypeNumber)

Standard_Integer NbParams () const
 Gives count of recorded parameters

Standard_Boolean ParamData (const Standard_Integer num, Interface_ParamType &ptype, Handle< IGESData_IGESEntity > &ent, Handle< TCollection_HAsciiString > &val) const
 Returns data of a Parameter : its type, and the entity if it
designates en entity ("ent") or its literal value else ("str")
Returned value (Boolean) : True if it is an Entity, False else

Interface_ParamType ParamType (const Standard_Integer num) const
 Returns the ParamType of a Param, given its rank
Error if num is not between 1 and NbParams

Standard_Boolean IsParamEntity (const Standard_Integer num) const
 Returns True if a Parameter is recorded as an entity
Error if num is not between 1 and NbParams

Handle_IGESData_IGESEntity ParamEntity (const Standard_Integer num) const
 Returns Entity corresponding to a Param, given its rank
Error if out of range or if Param num does not designate
an Entity

Standard_Boolean IsNegativePointer (const Standard_Integer num) const
 Returns True if <num> is noted as for a "Negative Pointer"
(see AddEntity for details). Senseful only if IsParamEntity
answers True for <num>, else returns False.

Handle_TCollection_HAsciiString ParamValue (const Standard_Integer num) const
 Returns litteral value of a Parameter, given its rank
Error if num is out of range, or if Parameter is not literal

Handle_TColStd_HSequenceOfInteger NegativePointers () const
 Returns the complete list of Ramks of Parameters which have
been noted as Negative Pointers
Warning : It is returned as a Null Handle if none was noted

void AddLiteral (const Interface_ParamType ptype, const Handle< TCollection_HAsciiString > &val)
 Adds a literal Parameter to the list (as such)

void AddLiteral (const Interface_ParamType ptype, const Standard_CString val)
 Adds a literal Parameter to the list (builds an HAsciiString)

void AddEntity (const Interface_ParamType ptype, const Handle< IGESData_IGESEntity > &ent, const Standard_Boolean negative=Standard_False)
 Adds a Parameter which references an Entity. If the Entity is
Null, the added parameter will define a "Null Pointer" (0)
If <negative> is given True, this will command Sending to File
(see IGESWriter) to produce a "Negative Pointer"
(Default is False)

void AddEntities (const Handle< IGESData_HArray1OfIGESEntity > &ents)
 Adds a set of Entities, given as a HArray1OfIGESEntity
Causes creation of : an Integer Parameter which gives count
of Entities, then the list of Entities of the Array
Error if an Entity is not an IGESEntity
All these Entities will be interpreted as "Positive Pointers"
by IGESWriter

void AddNegativePointers (const Handle< TColStd_HSequenceOfInteger > &list)
 Adds a list of Ranks of Parameters to be noted as Negative
Pointers (this will be taken into account for Parameters
which are Entities)

void ClearNegativePointers ()
 Clears all informations about Negative Pointers, hence every
Entity kind Parameter will be send normally, as Positive

virtual void WriteOwnParams (IGESData_IGESWriter &IW) const
 WriteOwnParams is redefined for FreeFormatEntity to take
into account the supplementary information "Negative Pointer"


Constructor & Destructor Documentation


Member Function Documentation

Handle_TColStd_HSequenceOfInteger IGESData_FreeFormatEntity::NegativePointers ( ) const
Handle_IGESData_IGESEntity IGESData_FreeFormatEntity::ParamEntity ( const Standard_Integer  num) const
Handle_TCollection_HAsciiString IGESData_FreeFormatEntity::ParamValue ( const Standard_Integer  num) const

Reimplemented from IGESData_UndefinedEntity.


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