# DataExchange
TKIGES
IGESData

# 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:

[legend]

## Public Member Functions

Standard_EXPORT | IGESData_FreeFormatEntity ()
| Creates a completely empty FreeFormatEntity .
Standard_EXPORT void | SetTypeNumber (const Standard_Integer typenum)
| Sets Type Number to a new Value, and Form Number to Zero .
Standard_EXPORT void | SetFormNumber (const Standard_Integer formnum)
| Sets Form Number to a new Value (to called after SetTypeNumber) .
Standard_EXPORT Standard_Integer | NbParams () const
| Gives count of recorded parameters .
Standard_EXPORT 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 .
Standard_EXPORT 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_EXPORT 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 .
Standard_EXPORT 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_EXPORT 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. .
Standard_EXPORT 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 .
Standard_EXPORT 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 .
Standard_EXPORT void | AddLiteral (const Interface_ParamType ptype, const Handle(TCollection_HAsciiString)&val)
| Adds a literal Parameter to the list (as such) .
Standard_EXPORT void | AddLiteral (const Interface_ParamType ptype, const Standard_CString val)
| Adds a literal Parameter to the list (builds an HAsciiString) .
Standard_EXPORT 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) .
Standard_EXPORT 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 .
Standard_EXPORT 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) .
Standard_EXPORT void | ClearNegativePointers ()
| Clears all informations about Negative Pointers, hence every Entity kind Parameter will be send normally, as Positive .
virtual Standard_EXPORT void | WriteOwnParams (IGESData_IGESWriter &IW) const
| WriteOwnParams is redefined for FreeFormatEntity to take into account the supplementary information "Negative Pointer" .
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const

## Private Attributes

Handle_TColStd_HSequenceOfInteger | thenegptrs

## Constructor & Destructor Documentation

Standard_EXPORT IGESData_FreeFormatEntity::IGESData_FreeFormatEntity | ( |  | ) |

## Member Function Documentation

Standard_EXPORT void IGESData_FreeFormatEntity::AddEntities | ( | const Handle(IGESData_HArray1OfIGESEntity)& | ents | ) |

Standard_EXPORT void IGESData_FreeFormatEntity::AddEntity | ( | const Interface_ParamType | ptype,
|  | const Handle(IGESData_IGESEntity)& | ent,
|  | const Standard_Boolean | negative = `Standard_False`
| ) |

Standard_EXPORT void IGESData_FreeFormatEntity::AddLiteral | ( | const Interface_ParamType | ptype,
|  | const Standard_CString | val
| ) |

Standard_EXPORT void IGESData_FreeFormatEntity::AddLiteral | ( | const Interface_ParamType | ptype,
|  | const Handle(TCollection_HAsciiString)& | val
| ) |

Standard_EXPORT void IGESData_FreeFormatEntity::AddNegativePointers | ( | const Handle(TColStd_HSequenceOfInteger)& | list | ) |

Standard_EXPORT void IGESData_FreeFormatEntity::ClearNegativePointers | ( |  | ) |

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

| Reimplemented from IGESData_UndefinedEntity.

Standard_EXPORT Standard_Boolean IGESData_FreeFormatEntity::IsNegativePointer | ( | const Standard_Integer | num | ) | const

Standard_EXPORT Standard_Boolean IGESData_FreeFormatEntity::IsParamEntity | ( | const Standard_Integer | num | ) | const

Standard_EXPORT Standard_Integer IGESData_FreeFormatEntity::NbParams | ( |  | ) | const

Standard_EXPORT Handle_TColStd_HSequenceOfInteger IGESData_FreeFormatEntity::NegativePointers | ( |  | ) | const

Standard_EXPORT Standard_Boolean IGESData_FreeFormatEntity::ParamData | ( | const Standard_Integer | num,
|  | Interface_ParamType & | ptype,
|  | Handle(IGESData_IGESEntity)& | ent,
|  | Handle(TCollection_HAsciiString)& | val
| ) | const

Standard_EXPORT Handle_IGESData_IGESEntity IGESData_FreeFormatEntity::ParamEntity | ( | const Standard_Integer | num | ) | const

Standard_EXPORT Interface_ParamType IGESData_FreeFormatEntity::ParamType | ( | const Standard_Integer | num | ) | const

Standard_EXPORT Handle_TCollection_HAsciiString IGESData_FreeFormatEntity::ParamValue | ( | const Standard_Integer | num | ) | const

Standard_EXPORT void IGESData_FreeFormatEntity::SetFormNumber | ( | const Standard_Integer | formnum | ) |

Standard_EXPORT void IGESData_FreeFormatEntity::SetTypeNumber | ( | const Standard_Integer | typenum | ) |

virtual Standard_EXPORT void IGESData_FreeFormatEntity::WriteOwnParams | ( | IGESData_IGESWriter & | IW | ) | const`[virtual]`

| Reimplemented from IGESData_UndefinedEntity.

## Field Documentation

Handle_TColStd_HSequenceOfInteger IGESData_FreeFormatEntity::thenegptrs `[private]`

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

- IGESData_FreeFormatEntity.hxx