Open CASCADE Technology 6.6.0
Public Member Functions
IGESDefs_AttributeDef Class Reference

defines IGES Attribute Table Definition Entity,
Type <322> Form [0, 1, 2] in package IGESDefs.
This is class is used to support the concept of well
defined collection of attributes, whether it is a table
or a single row of attributes.

#include <IGESDefs_AttributeDef.hxx>

Inheritance diagram for IGESDefs_AttributeDef:
Inheritance graph
[legend]

Public Member Functions

 IGESDefs_AttributeDef ()
void Init (const Handle< TCollection_HAsciiString > &aName, const Standard_Integer aListType, const Handle< TColStd_HArray1OfInteger > &attrTypes, const Handle< TColStd_HArray1OfInteger > &attrValueDataTypes, const Handle< TColStd_HArray1OfInteger > &attrValueCounts, const Handle< TColStd_HArray1OfTransient > &attrValues, const Handle< IGESDefs_HArray1OfHArray1OfTextDisplayTemplate > &attrValuePointers)
Standard_Boolean HasTableName () const
 Returns True if a Table Name is defined

Handle_TCollection_HAsciiString TableName () const
 returns the Attribute Table name, or comment
(default = null, no name : seeHasTableName)

Standard_Integer ListType () const
 returns the Attribute List Type

Standard_Integer NbAttributes () const
 returns the Number of Attributes

Standard_Integer AttributeType (const Standard_Integer num) const
 returns the num'th Attribute Type
raises exception if num <= 0 or num > NbAttributes()

Standard_Integer AttributeValueDataType (const Standard_Integer num) const
 returns the num'th Attribute value data type
raises exception if num <= 0 or num > NbAttributes()

Standard_Integer AttributeValueCount (const Standard_Integer num) const
 returns the num'th Attribute value count
raises exception if num <= 0 or num > NbAttributes()

Standard_Boolean HasValues () const
 returns false if Values are defined (i.e. for Form = 1 or 2)

Standard_Boolean HasTextDisplay () const
 returns false if TextDisplays are defined (i.e. for Form = 2)

Handle_IGESGraph_TextDisplayTemplate AttributeTextDisplay (const Standard_Integer AttrNum, const Standard_Integer PointerNum) const
Handle_Standard_Transient AttributeList (const Standard_Integer AttrNum) const
 Returns the List of Attributes <AttrNum>, as a Transient.
//! Its effective Type depends of the Type of Attribute :
HArray1OfInteger for Integer, Logical(0-1),
HArray1OfReal for Real, HArray1OfHSaciiString for String,
HArray1OfIGESEntity for Entity (Pointer)
See methods AttributeAs... for an accurate access

Standard_Integer AttributeAsInteger (const Standard_Integer AttrNum, const Standard_Integer ValueNum) const
 Returns Attribute Value <AttrNum, rank ValueNum> as an Integer
//! Error if Indices out of Range, or no Value defined, or not an Integer

Standard_Real AttributeAsReal (const Standard_Integer AttrNum, const Standard_Integer ValueNum) const
 Returns Attribute Value <AttrNum, rank ValueNum> as a Real
//! Error if Indices out of Range, or no Value defined, or not a Real

Handle_TCollection_HAsciiString AttributeAsString (const Standard_Integer AttrNum, const Standard_Integer ValueNum) const
 Returns Attribute Value <AttrNum, rank ValueNum> as an Integer

Handle_IGESData_IGESEntity AttributeAsEntity (const Standard_Integer AttrNum, const Standard_Integer ValueNum) const
 Returns Attribute Value <AttrNum, rank ValueNum> as an Entity
//! Error if Indices out of Range, or no Value defined, or not a Entity

Standard_Boolean AttributeAsLogical (const Standard_Integer AttrNum, const Standard_Integer ValueNum) const
 Returns Attribute Value <AttrNum, rank ValueNum> as a Boolean
//! Error if Indices out of Range, or no Value defined, or not a Logical


Constructor & Destructor Documentation

IGESDefs_AttributeDef::IGESDefs_AttributeDef ( )

Member Function Documentation

Handle_IGESData_IGESEntity IGESDefs_AttributeDef::AttributeAsEntity ( const Standard_Integer  AttrNum,
const Standard_Integer  ValueNum 
) const
Standard_Integer IGESDefs_AttributeDef::AttributeAsInteger ( const Standard_Integer  AttrNum,
const Standard_Integer  ValueNum 
) const
Standard_Boolean IGESDefs_AttributeDef::AttributeAsLogical ( const Standard_Integer  AttrNum,
const Standard_Integer  ValueNum 
) const
Standard_Real IGESDefs_AttributeDef::AttributeAsReal ( const Standard_Integer  AttrNum,
const Standard_Integer  ValueNum 
) const
Handle_TCollection_HAsciiString IGESDefs_AttributeDef::AttributeAsString ( const Standard_Integer  AttrNum,
const Standard_Integer  ValueNum 
) const
Handle_Standard_Transient IGESDefs_AttributeDef::AttributeList ( const Standard_Integer  AttrNum) const
Handle_IGESGraph_TextDisplayTemplate IGESDefs_AttributeDef::AttributeTextDisplay ( const Standard_Integer  AttrNum,
const Standard_Integer  PointerNum 
) const
Standard_Integer IGESDefs_AttributeDef::AttributeType ( const Standard_Integer  num) const
Standard_Integer IGESDefs_AttributeDef::AttributeValueCount ( const Standard_Integer  num) const
Standard_Integer IGESDefs_AttributeDef::AttributeValueDataType ( const Standard_Integer  num) const
Standard_Boolean IGESDefs_AttributeDef::HasTableName ( ) const
Standard_Boolean IGESDefs_AttributeDef::HasTextDisplay ( ) const
Standard_Boolean IGESDefs_AttributeDef::HasValues ( ) const
void IGESDefs_AttributeDef::Init ( const Handle< TCollection_HAsciiString > &  aName,
const Standard_Integer  aListType,
const Handle< TColStd_HArray1OfInteger > &  attrTypes,
const Handle< TColStd_HArray1OfInteger > &  attrValueDataTypes,
const Handle< TColStd_HArray1OfInteger > &  attrValueCounts,
const Handle< TColStd_HArray1OfTransient > &  attrValues,
const Handle< IGESDefs_HArray1OfHArray1OfTextDisplayTemplate > &  attrValuePointers 
)
Standard_Integer IGESDefs_AttributeDef::ListType ( ) const
Standard_Integer IGESDefs_AttributeDef::NbAttributes ( ) const
Handle_TCollection_HAsciiString IGESDefs_AttributeDef::TableName ( ) const

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines