IGESData_BasicEditor Class Reference

This class provides various functions of basic edition, such as : More...

#include <IGESData_BasicEditor.hxx>

Public Member Functions
	IGESData_BasicEditor ()
	Creates an empty Basic Editor which should be initialized via Init() method.
	IGESData_BasicEditor (const occ::handle< IGESData_Protocol > &protocol)
	Creates a Basic Editor, with a new IGESModel, ready to run.
	IGESData_BasicEditor (const occ::handle< IGESData_IGESModel > &model, const occ::handle< IGESData_Protocol > &protocol)
	Creates a Basic Editor for IGES Data, ready to run.
void	Init (const occ::handle< IGESData_Protocol > &protocol)
	Initialize a Basic Editor, with a new IGESModel, ready to run.
void	Init (const occ::handle< IGESData_IGESModel > &model, const occ::handle< IGESData_Protocol > &protocol)
	Initialize a Basic Editor for IGES Data, ready to run.
occ::handle< IGESData_IGESModel >	Model () const
	Returns the designated model.
bool	SetUnitFlag (const int flag)
	Sets a new unit from its flag (param 14 of Global Section) Returns True if done, False if <flag> is incorrect.
bool	SetUnitValue (const double val)
	Sets a new unit from its value in meters (rounded to the closest one, max gap 1%) Returns True if done, False if <val> is too far from a suitable value.
bool	SetUnitName (const char *const name)
	Sets a new unit from its name (param 15 of Global Section) Returns True if done, False if <name> is incorrect Remark : if <flag> has been set to 3 (user defined), <name> is then free.
void	ApplyUnit (const bool enforce=false)
	Applies unit value to convert header data : Resolution, MaxCoord, MaxLineWeight Applies unit only once after SetUnit... has been called, if <enforce> is given as True. It can be called just before writing the model to a file, i.e. when definitive values are finally known.
void	ComputeStatus ()
	Performs the re-computation of status on the whole model (Subordinate Status and Use Flag of each IGES Entity), which can have required values according the way they are referenced (see definitions of Logical use, Physical use, etc...)
bool	AutoCorrect (const occ::handle< IGESData_IGESEntity > &ent)
	Performs auto-correction on an IGESEntity Returns True if something has changed, False if nothing done.
int	AutoCorrectModel ()
	Performs auto-correction on the whole Model Returns the count of modified entities.

Static Public Member Functions
static int	UnitNameFlag (const char *const name)
	From the name of unit, computes flag number, 0 if incorrect (in this case, user defined entity remains possible)
static double	UnitFlagValue (const int flag)
	From the flag of unit, determines value in MM, 0 if incorrect.
static const char *	UnitFlagName (const int flag)
	From the flag of unit, determines its name, "" if incorrect.
static const char *	IGESVersionName (const int flag)
	From the flag of IGES version, returns name, "" if incorrect.
static int	IGESVersionMax ()
	Returns the maximum allowed value for IGESVersion Flag.
static const char *	DraftingName (const int flag)
	From the flag of drafting standard, returns name, "" if incorrect.
static int	DraftingMax ()
	Returns the maximum allowed value for Drafting Flag.
static int	GetFlagByValue (const double theValue)
	Returns Flag corresponding to the scaling theValue. Returns 0 if there's no such flag.

Detailed Description

This class provides various functions of basic edition, such as :

• setting header unit (WARNING : DOES NOT convert entities)
• computation of the status (Subordinate, UseFlag) of entities of IGES Entities on a whole model
• auto correction of IGES Entities, defined both by DirChecker and by specific service AutoCorrect (this auto correction performs non-ambigious, rather logic, editions)

Constructor & Destructor Documentation

IGESData_BasicEditor() [1/3]

IGESData_BasicEditor::IGESData_BasicEditor

(

)

Creates an empty Basic Editor which should be initialized via Init() method.

IGESData_BasicEditor() [2/3]

IGESData_BasicEditor::IGESData_BasicEditor

(

const occ::handle< IGESData_Protocol > &

protocol

)

Creates a Basic Editor, with a new IGESModel, ready to run.

IGESData_BasicEditor() [3/3]

IGESData_BasicEditor::IGESData_BasicEditor	(	const occ::handle< IGESData_IGESModel > &	model,
		const occ::handle< IGESData_Protocol > &	protocol )

Creates a Basic Editor for IGES Data, ready to run.

Member Function Documentation

ApplyUnit()

void IGESData_BasicEditor::ApplyUnit

(

const bool

enforce = false

)

Applies unit value to convert header data : Resolution, MaxCoord, MaxLineWeight Applies unit only once after SetUnit... has been called, if <enforce> is given as True. It can be called just before writing the model to a file, i.e. when definitive values are finally known.

AutoCorrect()

bool IGESData_BasicEditor::AutoCorrect

(

const occ::handle< IGESData_IGESEntity > &

ent

)

Performs auto-correction on an IGESEntity Returns True if something has changed, False if nothing done.

Works with the specific IGES Services : DirChecker which allows to correct data in "Directory Part" of Entities (such as required values for status, or references to be null), and the specific IGES service OwnCorrect, which is specialised for each type of entity.

AutoCorrectModel()

int IGESData_BasicEditor::AutoCorrectModel

(

)

Performs auto-correction on the whole Model Returns the count of modified entities.

ComputeStatus()

void IGESData_BasicEditor::ComputeStatus

(

)

Performs the re-computation of status on the whole model (Subordinate Status and Use Flag of each IGES Entity), which can have required values according the way they are referenced (see definitions of Logical use, Physical use, etc...)

DraftingMax()

static int IGESData_BasicEditor::DraftingMax ( )

static

Returns the maximum allowed value for Drafting Flag.

DraftingName()

static const char * IGESData_BasicEditor::DraftingName ( const int flag )

static

From the flag of drafting standard, returns name, "" if incorrect.

GetFlagByValue()

static int IGESData_BasicEditor::GetFlagByValue ( const double theValue )

static

Returns Flag corresponding to the scaling theValue. Returns 0 if there's no such flag.

IGESVersionMax()

static int IGESData_BasicEditor::IGESVersionMax ( )

static

Returns the maximum allowed value for IGESVersion Flag.

IGESVersionName()

static const char * IGESData_BasicEditor::IGESVersionName ( const int flag )

static

From the flag of IGES version, returns name, "" if incorrect.

Init() [1/2]

void IGESData_BasicEditor::Init	(	const occ::handle< IGESData_IGESModel > &	model,
		const occ::handle< IGESData_Protocol > &	protocol )

Initialize a Basic Editor for IGES Data, ready to run.

Init() [2/2]

void IGESData_BasicEditor::Init

(

const occ::handle< IGESData_Protocol > &

protocol

)

Initialize a Basic Editor, with a new IGESModel, ready to run.

Model()

occ::handle< IGESData_IGESModel > IGESData_BasicEditor::Model

(

)

const

Returns the designated model.

SetUnitFlag()

bool IGESData_BasicEditor::SetUnitFlag

(

const int

flag

)

Sets a new unit from its flag (param 14 of Global Section) Returns True if done, False if <flag> is incorrect.

SetUnitName()

bool IGESData_BasicEditor::SetUnitName

(

const char *const

name

)

Sets a new unit from its name (param 15 of Global Section) Returns True if done, False if <name> is incorrect Remark : if <flag> has been set to 3 (user defined), <name> is then free.

SetUnitValue()

bool IGESData_BasicEditor::SetUnitValue

(

const double

val

)

Sets a new unit from its value in meters (rounded to the closest one, max gap 1%) Returns True if done, False if <val> is too far from a suitable value.

UnitFlagName()

static const char * IGESData_BasicEditor::UnitFlagName ( const int flag )

static

From the flag of unit, determines its name, "" if incorrect.

UnitFlagValue()

static double IGESData_BasicEditor::UnitFlagValue ( const int flag )

static

From the flag of unit, determines value in MM, 0 if incorrect.

UnitNameFlag()

static int IGESData_BasicEditor::UnitNameFlag ( const char *const name )

static

From the name of unit, computes flag number, 0 if incorrect (in this case, user defined entity remains possible)

---

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

• IGESData_BasicEditor.hxx