STEPConstruct_UnitContext Class Reference

Tool for creation (encoding) and decoding (for writing and reading accordingly) context defining units and tolerances (uncerntanties). More...

#include <STEPConstruct_UnitContext.hxx>

Public Member Functions
	STEPConstruct_UnitContext ()
	Creates empty tool.
void	Init (const double Tol3d, const occ::handle< StepData_StepModel > &theModel, const StepData_Factors &theLocalFactors=StepData_Factors())
	Creates new context (units are MM and radians, uncertainty equal to Tol3d).
bool	IsDone () const
	Returns True if Init was called successfully.
occ::handle< StepGeom_GeomRepContextAndGlobUnitAssCtxAndGlobUncertaintyAssCtx >	Value () const
	Returns context (or Null if not done).
int	ComputeFactors (const occ::handle< StepRepr_GlobalUnitAssignedContext > &aContext, const StepData_Factors &theLocalFactors=StepData_Factors())
	Computes the length, plane angle and solid angle conversion factor. Returns a status, 0 if OK.
int	ComputeFactors (const occ::handle< StepBasic_NamedUnit > &aUnit, const StepData_Factors &theLocalFactors=StepData_Factors())
int	ComputeTolerance (const occ::handle< StepRepr_GlobalUncertaintyAssignedContext > &aContext)
	Computes the uncertainty value (for length).
double	LengthFactor () const
	Returns the lengthFactor.
double	PlaneAngleFactor () const
	Returns the planeAngleFactor.
double	SolidAngleFactor () const
	Returns the solidAngleFactor.
double	Uncertainty () const
	Returns the Uncertainty value (for length) It has been converted with LengthFactor.
double	AreaFactor () const
	Returns the areaFactor.
double	VolumeFactor () const
	Returns the volumeFactor.
bool	HasUncertainty () const
	Tells if a Uncertainty (for length) is recorded.
bool	LengthDone () const
	Returns true if ComputeFactors has calculated a LengthFactor.
bool	PlaneAngleDone () const
	Returns true if ComputeFactors has calculated a PlaneAngleFactor.
bool	SolidAngleDone () const
	Returns true if ComputeFactors has calculated a SolidAngleFactor.
bool	AreaDone () const
	Returns true if areaFactor is computed.
bool	VolumeDone () const
	Returns true if volumeFactor is computed.
const char *	StatusMessage (const int status) const
	Returns a message for a given status (0 - empty) This message can then be added as warning for transfer.

Static Public Member Functions
static double	ConvertSiPrefix (const StepBasic_SiPrefix aPrefix)
	Convert SI prefix defined by enumeration to corresponding real factor (e.g. 1e6 for mega).

Detailed Description

Tool for creation (encoding) and decoding (for writing and reading accordingly) context defining units and tolerances (uncerntanties).

Constructor & Destructor Documentation

STEPConstruct_UnitContext()

STEPConstruct_UnitContext::STEPConstruct_UnitContext

(

)

Creates empty tool.

Member Function Documentation

AreaDone()

bool STEPConstruct_UnitContext::AreaDone

(

)

const

Returns true if areaFactor is computed.

AreaFactor()

double STEPConstruct_UnitContext::AreaFactor

(

)

const

Returns the areaFactor.

ComputeFactors() [1/2]

int STEPConstruct_UnitContext::ComputeFactors	(	const occ::handle< StepBasic_NamedUnit > &	aUnit,
		const StepData_Factors &	theLocalFactors = StepData_Factors() )

ComputeFactors() [2/2]

int STEPConstruct_UnitContext::ComputeFactors	(	const occ::handle< StepRepr_GlobalUnitAssignedContext > &	aContext,
		const StepData_Factors &	theLocalFactors = StepData_Factors() )

Computes the length, plane angle and solid angle conversion factor. Returns a status, 0 if OK.

ComputeTolerance()

int STEPConstruct_UnitContext::ComputeTolerance

(

const occ::handle< StepRepr_GlobalUncertaintyAssignedContext > &

aContext

)

Computes the uncertainty value (for length).

ConvertSiPrefix()

double STEPConstruct_UnitContext::ConvertSiPrefix ( const StepBasic_SiPrefix aPrefix )

static

Convert SI prefix defined by enumeration to corresponding real factor (e.g. 1e6 for mega).

HasUncertainty()

bool STEPConstruct_UnitContext::HasUncertainty

(

)

const

Tells if a Uncertainty (for length) is recorded.

Init()

void STEPConstruct_UnitContext::Init	(	const double	Tol3d,
		const occ::handle< StepData_StepModel > &	theModel,
		const StepData_Factors &	theLocalFactors = StepData_Factors() )

Creates new context (units are MM and radians, uncertainty equal to Tol3d).

IsDone()

bool STEPConstruct_UnitContext::IsDone

(

)

const

Returns True if Init was called successfully.

LengthDone()

bool STEPConstruct_UnitContext::LengthDone

(

)

const

Returns true if ComputeFactors has calculated a LengthFactor.

LengthFactor()

double STEPConstruct_UnitContext::LengthFactor

(

)

const

Returns the lengthFactor.

PlaneAngleDone()

bool STEPConstruct_UnitContext::PlaneAngleDone

(

)

const

Returns true if ComputeFactors has calculated a PlaneAngleFactor.

PlaneAngleFactor()

double STEPConstruct_UnitContext::PlaneAngleFactor

(

)

const

Returns the planeAngleFactor.

SolidAngleDone()

bool STEPConstruct_UnitContext::SolidAngleDone

(

)

const

Returns true if ComputeFactors has calculated a SolidAngleFactor.

SolidAngleFactor()

double STEPConstruct_UnitContext::SolidAngleFactor

(

)

const

Returns the solidAngleFactor.

StatusMessage()

const char * STEPConstruct_UnitContext::StatusMessage

(

const int

status

)

const

Returns a message for a given status (0 - empty) This message can then be added as warning for transfer.

Uncertainty()

double STEPConstruct_UnitContext::Uncertainty

(

)

const

Returns the Uncertainty value (for length) It has been converted with LengthFactor.

Value()

occ::handle< StepGeom_GeomRepContextAndGlobUnitAssCtxAndGlobUncertaintyAssCtx > STEPConstruct_UnitContext::Value

(

)

const

Returns context (or Null if not done).

VolumeDone()

bool STEPConstruct_UnitContext::VolumeDone

(

)

const

Returns true if volumeFactor is computed.

VolumeFactor()

double STEPConstruct_UnitContext::VolumeFactor

(

)

const

Returns the volumeFactor.

---

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

• STEPConstruct_UnitContext.hxx