SPAIDocumentHeaderInfo Class Reference

The SPAIDocumentHeaderInfo class. More...

#include <SPAIDocumentHeaderInfo.h>

Inheritance diagram for SPAIDocumentHeaderInfo:

[legend]

Collaboration diagram for SPAIDocumentHeaderInfo:

[legend]

List of all members.

Public Member Functions
virtual SPAIResult	GetActiveConfiguration (SPAIValue &oValue) const
virtual SPAIResult	GetAuthor (SPAIValue &oValue) const
	Returns the author of the accessed document.
virtual SPAIResult	GetComment (SPAIValue &oValue) const
	Returns the user comment or description stored in the accessed document.
virtual SPAIResult	GetConfigurationsCount (SPAIValue &oValue) const
	Returns the number of configurations in a configuration list.
void *	GetData () const
	For Spatial Corp.
virtual SPAIResult	GetDocumentType (SPAIValue &oValue) const
	Returns the type of the document Using this document type information, representation type can be decided.
virtual SPAIResult	GetFileName (SPAIValue &oValue) const
	Returns the file system name of the accessed document.
virtual SPAIResult	GetIthConfiguration (int iConfigNumber, SPAIValue &oValue) const
	Returns the configurations, each configuration is separated by a semicolon.
virtual int	GetModelsCount ()
	Returns the number of models in the document.
virtual SPAIResult	GetModificationDate (SPAIValue &oValue) const
	Returns the last modification date of the accessed document.
virtual SPAIResult	GetOrganization (SPAIValue &oValue) const
	Returns the organization that created the accessed document.
virtual SPAIResult	GetSourceSystem (SPAIValue &oValue) const
	Returns the computer system that created the accessed document.
virtual SPAIResult	GetTolerance (SPAIValue &oValue) const
	Returns the tolerance set for the accessed document.
virtual SPAIResult	GetUnits (SPAIValue &oValue) const
	Returns the unit used by the accessed document.
virtual SPAIResult	GetVersion (SPAIValue &oValue) const
	Returns the version number of the computer system that created the accessed document.
virtual bool	IsValid () const
SPAIDocumentHeaderInfo &	operator= (const SPAIDocumentHeaderInfo &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.
	SPAIDocumentHeaderInfo ()
	Constructor.
virtual	~SPAIDocumentHeaderInfo ()
	Destructor.
Protected Member Functions
int	Ref ()
int	Unref ()
Protected Attributes
SPAIObjectType	_type

---

Detailed Description

The SPAIDocumentHeaderInfo class.

The SPAIDocumentHeaderInfo class returns information about the header content of a document.

---

Constructor & Destructor Documentation

SPAIDocumentHeaderInfo::SPAIDocumentHeaderInfo

(

)

Constructor.

virtual SPAIDocumentHeaderInfo::~SPAIDocumentHeaderInfo

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual SPAIResult SPAIDocumentHeaderInfo::GetActiveConfiguration

(

SPAIValue &

oValue

)

const [virtual]

Parameters:

oValue

the returned active configurations

virtual SPAIResult SPAIDocumentHeaderInfo::GetAuthor

(

SPAIValue &

oValue

)

const [virtual]

Returns the author of the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentHeaderInfo::GetComment

(

SPAIValue &

oValue

)

const [virtual]

Returns the user comment or description stored in the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentHeaderInfo::GetConfigurationsCount

(

SPAIValue &

oValue

)

const [virtual]

Returns the number of configurations in a configuration list.

Parameters:

oValue

the returned value.

void* SPAIObject::GetData

(

)

const [inherited]

For Spatial Corp.

internal use only.

virtual SPAIResult SPAIDocumentHeaderInfo::GetDocumentType

(

SPAIValue &

oValue

)

const [virtual]

Returns the type of the document Using this document type information, representation type can be decided.

Parameters:

oValue

the returned value of document type. The value can be one of the following. "Part" if document contains part data. The applicatble representation type can be either "BRep" ( in combination with "PMI") or "Visualization" or "Mesh" "Assembly" if document contains assembly data. The applicable representation type is "Assembly" (in combination with "PMI") "Part+Assembly" if document contains both part as well as assembly data. The applicable representation type is "BRep+Assembly" (in combination with "PMI")

• "Unknown" if the document type can not be determined at the time of loading header. In this case it advisable to set representation type as "BRep+Assembly" It returns success of failure through SPAIResult

virtual SPAIResult SPAIDocumentHeaderInfo::GetFileName

(

SPAIValue &

oValue

)

const [virtual]

Returns the file system name of the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentHeaderInfo::GetIthConfiguration	(	int	iConfigNumber,
		SPAIValue &	oValue
	)			const [virtual]

Returns the configurations, each configuration is separated by a semicolon.

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 SPAIDocumentHeaderInfo::GetModificationDate

(

SPAIValue &

oValue

)

const [virtual]

Returns the last modification date of the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentHeaderInfo::GetOrganization

(

SPAIValue &

oValue

)

const [virtual]

Returns the organization that created the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentHeaderInfo::GetSourceSystem

(

SPAIValue &

oValue

)

const [virtual]

Returns the computer system that created the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentHeaderInfo::GetTolerance

(

SPAIValue &

oValue

)

const [virtual]

Returns the tolerance set for the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentHeaderInfo::GetUnits

(

SPAIValue &

oValue

)

const [virtual]

Returns the unit used by the accessed document.

Parameters:

oValue

the returned value.

virtual SPAIResult SPAIDocumentHeaderInfo::GetVersion

(

SPAIValue &

oValue

)

const [virtual]

Returns the version number of the computer system that created 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.

SPAIDocumentHeaderInfo& SPAIDocumentHeaderInfo::operator=

(

const SPAIDocumentHeaderInfo &

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]