# DataExchange
TKIGES
IGESData

# IGESData_DirChecker Class Reference

This class centralizes general Checks upon an IGES Entity's
Directory Part. That is : such field Ignored or Required,
or Required with a given Value (for an Integer field)
More precise checks can be performed as necessary, by each
Entity (method OwnCheck).
Each class of Entity defines its DirChecker (method DirChecker)
and the DirChecker is able to perform its Checks on an Entity
A Required Value or presence of a field causes a Fail Message
if criterium is not satisfied
An Ignored field causes a Correction Message if the field is
not null/zero
.

`#include <IGESData_DirChecker.hxx>`

## Public Member Functions

void * | operator new (size_t, void *anAddress)
void * | operator new (size_t size)
void | operator delete (void *anAddress)
Standard_EXPORT | IGESData_DirChecker ()
| Returns a DirChecker, with no criterium at all to be checked .
Standard_EXPORT | IGESData_DirChecker (const Standard_Integer atype)
| Returns a DirChecker, with no criterium except Required Type .
Standard_EXPORT | IGESData_DirChecker (const Standard_Integer atype, const Standard_Integer aform)
| Returns a DirChecker, with no criterium except Required values for Type and Form numbers .
Standard_EXPORT | IGESData_DirChecker (const Standard_Integer atype, const Standard_Integer aform1, const Standard_Integer aform2)
| Returns a DirChecker, with no criterium except Required values for Type number (atype), and Required Range for Form number (which must be between aform1 and aform2 included) .
Standard_EXPORT Standard_Boolean | IsSet () const
| Returns True if at least one criterium has already been set Allows user to store a DirChecker (static variable) then ask if it has been set before setting it .
Standard_EXPORT void | SetDefault ()
| Sets a DirChecker with most current criteria, that is : Structure Ignored ( worths call Structure(crit = DefVoid) ) .
Standard_EXPORT void | Structure (const IGESData_DefType crit)
| Sets Structure criterium. If crit is DefVoid, Ignored : should not be defined If crit is DefReference, Required : must be defined Other values are not taken in account .
Standard_EXPORT void | LineFont (const IGESData_DefType crit)
| Sets LineFont criterium If crit is DefVoid, Ignored : should not be defined If crit is DefAny, Required : must be defined (value or ref) If crit is DefValue, Required as a Value (error if Reference) Other values are not taken in account .
Standard_EXPORT void | LineWeight (const IGESData_DefType crit)
| Sets LineWeight criterium If crit is DefVoid, Ignored : should not be defined If crit is DefValue, Required Other values are not taken in account .
Standard_EXPORT void | Color (const IGESData_DefType crit)
| Sets Color criterium If crit is DefVoid, Ignored : should not be defined If crit is DefAny, Required : must be defined (value or ref) Other values are not taken in account .
Standard_EXPORT void | GraphicsIgnored (const Standard_Integer hierarchy=-1)
| Sets Graphics data (LineFont, LineWeight, Color, Level, View) to be ignored according value of Hierarchy status : If hierarchy is not given, they are Ignored any way (that is, they should not be defined) If hierarchy is given, Graphics are Ignored if the Hierarchy status has the value given in argument "hierarchy" .
Standard_EXPORT void | BlankStatusIgnored ()
| Sets Blank Status to be ignored (should not be defined, or its value should be 0) .
Standard_EXPORT void | BlankStatusRequired (const Standard_Integer val)
| Sets Blank Status to be required at a given value .
Standard_EXPORT void | SubordinateStatusIgnored ()
| Sets Subordinate Status to be ignored (should not be defined, or its value should be 0) .
Standard_EXPORT void | SubordinateStatusRequired (const Standard_Integer val)
| Sets Subordinate Status to be required at a given value .
Standard_EXPORT void | UseFlagIgnored ()
| Sets Blank Status to be ignored (should not be defined, or its value should be 0) .
Standard_EXPORT void | UseFlagRequired (const Standard_Integer val)
| Sets Blank Status to be required at a given value Give -1 to demand UseFlag not zero (but no precise value req.) .
Standard_EXPORT void | HierarchyStatusIgnored ()
| Sets Hierarchy Status to be ignored (should not be defined, or its value should be 0) .
Standard_EXPORT void | HierarchyStatusRequired (const Standard_Integer val)
| Sets Hierarchy Status to be required at a given value .
Standard_EXPORT void | Check (Handle(Interface_Check)&ach, const Handle(IGESData_IGESEntity)&ent) const
| Performs the Checks on an IGESEntity, according to the recorded criteria In addition, does minimal Checks, such as admitted range for Status, or presence of Error status in some data (Color, ...) .
Standard_EXPORT void | CheckTypeAndForm (Handle(Interface_Check)&ach, const Handle(IGESData_IGESEntity)&ent) const
| Performs a Check only on Values of Type Number and Form Number This allows to do a check on an Entity not yet completely filled but of which Type and Form Number have been already set .
Standard_EXPORT Standard_Boolean | Correct (const Handle(IGESData_IGESEntity)&ent) const

Corrects the Directory Entry of an IGES Entity as far as it is
possible according recorded criteria without any ambiguity :
- if a numeric Status is required a given value, this value is
enforced
- if an item is required to be Void, or if it recorded as
Erroneous, it is cleared (set to Void)
- Type Number is enforced
- finally Form Number is enforced only if one and only Value
is admitted (no range, see Constructors of DirChecker)
.

## Private Attributes

Standard_Boolean | isitset
Standard_Integer | thetype
Standard_Integer | theform1
Standard_Integer | theform2
IGESData_DefType | thestructure
IGESData_DefType | thelinefont
IGESData_DefType | thelineweig
IGESData_DefType | thecolor
Standard_Integer | thegraphier
Standard_Integer | theblankst
Standard_Integer | thesubordst
Standard_Integer | theuseflag
Standard_Integer | thehierst

## Constructor & Destructor Documentation

Standard_EXPORT IGESData_DirChecker::IGESData_DirChecker | ( |  | ) |

Standard_EXPORT IGESData_DirChecker::IGESData_DirChecker | ( | const Standard_Integer | atype | ) |

Standard_EXPORT IGESData_DirChecker::IGESData_DirChecker | ( | const Standard_Integer | atype,
|  | const Standard_Integer | aform
| ) |

Standard_EXPORT IGESData_DirChecker::IGESData_DirChecker | ( | const Standard_Integer | atype,
|  | const Standard_Integer | aform1,
|  | const Standard_Integer | aform2
| ) |

## Member Function Documentation

Standard_EXPORT void IGESData_DirChecker::BlankStatusIgnored | ( |  | ) |

Standard_EXPORT void IGESData_DirChecker::BlankStatusRequired | ( | const Standard_Integer | val | ) |

Standard_EXPORT void IGESData_DirChecker::Check | ( | Handle(Interface_Check)& | ach,
|  | const Handle(IGESData_IGESEntity)& | ent
| ) | const

Standard_EXPORT void IGESData_DirChecker::CheckTypeAndForm | ( | Handle(Interface_Check)& | ach,
|  | const Handle(IGESData_IGESEntity)& | ent
| ) | const

Standard_EXPORT void IGESData_DirChecker::Color | ( | const IGESData_DefType | crit | ) |

Standard_EXPORT Standard_Boolean IGESData_DirChecker::Correct | ( | const Handle(IGESData_IGESEntity)& | ent | ) | const

Standard_EXPORT void IGESData_DirChecker::GraphicsIgnored | ( | const Standard_Integer | hierarchy = `-1` | ) |

Standard_EXPORT void IGESData_DirChecker::HierarchyStatusIgnored | ( |  | ) |

Standard_EXPORT void IGESData_DirChecker::HierarchyStatusRequired | ( | const Standard_Integer | val | ) |

Standard_EXPORT Standard_Boolean IGESData_DirChecker::IsSet | ( |  | ) | const

Standard_EXPORT void IGESData_DirChecker::LineFont | ( | const IGESData_DefType | crit | ) |

Standard_EXPORT void IGESData_DirChecker::LineWeight | ( | const IGESData_DefType | crit | ) |

void IGESData_DirChecker::operator delete | ( | void * | anAddress | ) | `[inline]`

void* IGESData_DirChecker::operator new | ( | size_t | size | ) | `[inline]`

void* IGESData_DirChecker::operator new | ( | size_t | ,
|  | void * | anAddress
| ) | `[inline]`

Standard_EXPORT void IGESData_DirChecker::SetDefault | ( |  | ) |

Standard_EXPORT void IGESData_DirChecker::Structure | ( | const IGESData_DefType | crit | ) |

Standard_EXPORT void IGESData_DirChecker::SubordinateStatusIgnored | ( |  | ) |

Standard_EXPORT void IGESData_DirChecker::SubordinateStatusRequired | ( | const Standard_Integer | val | ) |

Standard_EXPORT void IGESData_DirChecker::UseFlagIgnored | ( |  | ) |

Standard_EXPORT void IGESData_DirChecker::UseFlagRequired | ( | const Standard_Integer | val | ) |

## Field Documentation

Standard_Boolean IGESData_DirChecker::isitset`[private]`

Standard_Integer IGESData_DirChecker::theblankst`[private]`

IGESData_DefType IGESData_DirChecker::thecolor`[private]`

Standard_Integer IGESData_DirChecker::theform1`[private]`

Standard_Integer IGESData_DirChecker::theform2`[private]`

Standard_Integer IGESData_DirChecker::thegraphier`[private]`

Standard_Integer IGESData_DirChecker::thehierst`[private]`

IGESData_DefType IGESData_DirChecker::thelinefont`[private]`

IGESData_DefType IGESData_DirChecker::thelineweig`[private]`

IGESData_DefType IGESData_DirChecker::thestructure`[private]`

Standard_Integer IGESData_DirChecker::thesubordst`[private]`

Standard_Integer IGESData_DirChecker::thetype`[private]`

Standard_Integer IGESData_DirChecker::theuseflag`[private]`

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

- IGESData_DirChecker.hxx