SPAIDocumentBRepInfo Class Reference

The SPAIDocumentBRepInfo class. More...

#include <SPAIDocumentBRepInfo.h>

Inheritance diagram for SPAIDocumentBRepInfo:

[legend]

Collaboration diagram for SPAIDocumentBRepInfo:

[legend]

List of all members.

Public Member Functions
virtual SPAIResult	GetAcornBodiesVertexCount (SPAIValue &oValue) const
	Returns the number of wire bodies vertices in the accessed document.
virtual SPAIResult	GetAcornBodyCount (SPAIValue &oValue) const
	Returns the number of vertex bodies in the accessed document.
virtual SPAIResult	GetBodyCount (SPAIValue &oValue) const
	Returns the number of bodies in the accessed document.
void *	GetData () const
	For Spatial Corp.
virtual SPAIResult	GetFreeCurvesCount (SPAIValue &oValue) const
	Returns the number of free curves in the accessed document.
virtual SPAIResult	GetFreePointsCount (SPAIValue &oValue) const
	Returns the number of free points in the accessed document.
virtual SPAIResult	GetFreeSurfacesCount (SPAIValue &oValue) const
	Returns the number of free surfaces in the accessed document.
virtual SPAIResult	GetLocalCoordinateSystemCount (SPAIValue &oValue) const
	Returns the number of local coordinate systems in the accessed document.
virtual SPAIResult	GetMixedBodiesCoedgeCount (SPAIValue &oValue) const
	Returns the number of mix bodies coedges in the accessed document.
virtual SPAIResult	GetMixedBodiesEdgeCount (SPAIValue &oValue) const
	Returns the number of mix bodies edges in the accessed document.
virtual SPAIResult	GetMixedBodiesFaceCount (SPAIValue &oValue) const
	Returns the number of mix bodies faces in the accessed document.
virtual SPAIResult	GetMixedBodiesLoopCount (SPAIValue &oValue) const
	Returns the number of mix bodies loops in the accessed document.
virtual SPAIResult	GetMixedBodiesLumpCount (SPAIValue &oValue) const
	Returns the number of mix bodies lumps in the accessed document.
virtual SPAIResult	GetMixedBodiesShellCount (SPAIValue &oValue) const
	Returns the number of mix bodies shells in the accessed document.
virtual SPAIResult	GetMixedBodiesVertexCount (SPAIValue &oValue) const
	Returns the number of mix bodies vertices in the accessed document.
virtual SPAIResult	GetMixedBodyCount (SPAIValue &oValue) const
	Returns the number of mix bodies in the accessed document.
virtual int	GetModelsCount ()
	Returns the number of models in the document.
virtual SPAIResult	GetSheetBodiesCoedgeCount (SPAIValue &oValue) const
	Returns the number of sheet bodies coedges in the accessed document.
virtual SPAIResult	GetSheetBodiesEdgeCount (SPAIValue &oValue) const
	Returns the number of sheet bodies edges in the accessed document.
virtual SPAIResult	GetSheetBodiesFaceCount (SPAIValue &oValue) const
	Returns the number of sheet bodies faces in the accessed document.
virtual SPAIResult	GetSheetBodiesLoopCount (SPAIValue &oValue) const
	Returns the number of sheet bodies loops in the accessed document.
virtual SPAIResult	GetSheetBodiesShellCount (SPAIValue &oValue) const
	Returns the number of sheet bodies shells in the accessed document.
virtual SPAIResult	GetSheetBodiesVertexCount (SPAIValue &oValue) const
	Returns the number of sheet bodies vertices in the accessed document.
virtual SPAIResult	GetSheetBodyCount (SPAIValue &oValue) const
	Returns the number of sheet bodies in the accessed document.
virtual SPAIResult	GetSolidBodiesCoedgeCount (SPAIValue &oValue) const
	Returns the number of solid bodies coedges in the accessed document.
virtual SPAIResult	GetSolidBodiesEdgeCount (SPAIValue &oValue) const
	Returns the number of solid bodies edges in the accessed document.
virtual SPAIResult	GetSolidBodiesFaceCount (SPAIValue &oValue) const
	Returns the number of solid bodies faces in the accessed document.
virtual SPAIResult	GetSolidBodiesLoopCount (SPAIValue &oValue) const
	Returns the number of solid bodies loops in the accessed document.
virtual SPAIResult	GetSolidBodiesLumpCount (SPAIValue &oValue) const
	Returns the number of solid bodies lumps in the accessed document.
virtual SPAIResult	GetSolidBodiesShellCount (SPAIValue &oValue) const
	Returns the number of solid bodies shells in the accessed document.
virtual SPAIResult	GetSolidBodiesVertexCount (SPAIValue &oValue) const
	Returns the number of solid bodies vertices in the accessed document.
virtual SPAIResult	GetSolidBodyCount (SPAIValue &oValue) const
	Returns the number of solid bodies in the accessed document.
virtual SPAIResult	GetWireBodiesEdgeCount (SPAIValue &oValue) const
	Returns the number of wire bodies edges in the accessed document.
virtual SPAIResult	GetWireBodiesVertexCount (SPAIValue &oValue) const
	Returns the number of wire bodies vertices in the accessed document.
virtual SPAIResult	GetWireBodyCount (SPAIValue &oValue) const
	Returns the number of wire bodies in the accessed document.
virtual bool	IsValid () const
SPAIDocumentBRepInfo &	operator= (const SPAIDocumentBRepInfo &iInfo)
	Equal operator.
virtual SPAIResult	SelectModel (int iModel)
	Some specific documents like CATIAV4 exp files may contain more than 1 model.
void	SetData (void *ipData)
	For Spatial Corp.
	SPAIDocumentBRepInfo (const SPAIDocument &iDocument)
	Constructor.
virtual	~SPAIDocumentBRepInfo ()
	Destructor.
Protected Member Functions
int	Ref ()
int	Unref ()
Protected Attributes
SPAIObjectType	_type

---

Detailed Description

The SPAIDocumentBRepInfo class.

The SPAIDocumentBRepInfo class returns information about the BRep content of a document.

---

Constructor & Destructor Documentation

SPAIDocumentBRepInfo::SPAIDocumentBRepInfo

(

const SPAIDocument &

iDocument

)

Constructor.

Parameters:

iDocument,:

the accessed document for which BRep information will be retrieved

virtual SPAIDocumentBRepInfo::~SPAIDocumentBRepInfo

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual SPAIResult SPAIDocumentBRepInfo::GetAcornBodiesVertexCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of wire bodies vertices in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetAcornBodyCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of vertex bodies in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetBodyCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of bodies in the accessed document.

Parameters:

oValue

the returned value.

void* SPAIObject::GetData

(

)

const [inherited]

For Spatial Corp.

internal use only.

virtual SPAIResult SPAIDocumentBRepInfo::GetFreeCurvesCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of free curves in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetFreePointsCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of free points in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetFreeSurfacesCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of free surfaces in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetLocalCoordinateSystemCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of local coordinate systems in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetMixedBodiesCoedgeCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of mix bodies coedges in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetMixedBodiesEdgeCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of mix bodies edges in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetMixedBodiesFaceCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of mix bodies faces in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetMixedBodiesLoopCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of mix bodies loops in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetMixedBodiesLumpCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of mix bodies lumps in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetMixedBodiesShellCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of mix bodies shells in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetMixedBodiesVertexCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of mix bodies vertices in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetMixedBodyCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of mix bodies in the accessed document.

Parameters:

oValue

the returned value.

virtual int SPAIDocumentInfo::GetModelsCount

(

)

[virtual, inherited]

Returns the number of models in the document.

For most documents this method will return 1. Some specific documents like CATIAV4 exp files may contain more than 1 model.

virtual SPAIResult SPAIDocumentBRepInfo::GetSheetBodiesCoedgeCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of sheet bodies coedges in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetSheetBodiesEdgeCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of sheet bodies edges in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetSheetBodiesFaceCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of sheet bodies faces in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetSheetBodiesLoopCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of sheet bodies loops in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetSheetBodiesShellCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of sheet bodies shells in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetSheetBodiesVertexCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of sheet bodies vertices in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetSheetBodyCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of sheet bodies in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetSolidBodiesCoedgeCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of solid bodies coedges in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetSolidBodiesEdgeCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of solid bodies edges in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetSolidBodiesFaceCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of solid bodies faces in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetSolidBodiesLoopCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of solid bodies loops in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetSolidBodiesLumpCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of solid bodies lumps in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetSolidBodiesShellCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of solid bodies shells in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetSolidBodiesVertexCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of solid bodies vertices in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetSolidBodyCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of solid bodies in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetWireBodiesEdgeCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of wire bodies edges in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetWireBodiesVertexCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of wire bodies vertices in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentBRepInfo::GetWireBodyCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of wire bodies in the accessed document.

Parameters:

oValue

the returned value.

virtual bool SPAIObject::IsValid

(

)

const [virtual, inherited]

Returns:

true if this object was correctly initialized ; false otherwise.

SPAIDocumentBRepInfo& SPAIDocumentBRepInfo::operator=

(

const SPAIDocumentBRepInfo &

iInfo

)

Equal operator.

int SPAIObject::Ref

(

)

[protected, inherited]

virtual SPAIResult SPAIDocumentInfo::SelectModel

(

int

iModel

)

[virtual, inherited]

Some specific documents like CATIAV4 exp files may contain more than 1 model.

Selects the model for which information will be queried.

Parameters:

iModel

the model index from 0 included to model count excluded.

void SPAIObject::SetData

(

void *

ipData

)

[inherited]

For Spatial Corp.

internal use only.

int SPAIObject::Unref

(

)

[protected, inherited]

---

Member Data Documentation

SPAIObjectType SPAIObject::_type [protected, inherited]