catiav5w::FileDescription Class Reference

This class provides several informations about a CatiaV5 File.
It can be used with catiav5w::InitPart and catiav5w::InitProduct functions to specify file properties. More...

Public Types
enum	ProductSourceType { Unknown = 0, Made, Bought }

Public Member Functions
void	AddBooleanProperty (const Dtk_string &inPropertyName, const Dtk_bool &inValue)
	Adds an additional integer property. More...
void	AddDoubleProperty (const Dtk_string &inPropertyName, const double &inValue)
	Adds an additional double property. More...
void	AddIntegerProperty (const Dtk_string &inPropertyName, const Dtk_Int32 &inValue)
	Adds an additional integer property. More...
void	AddStringProperty (const Dtk_string &inPropertyName, const Dtk_string &inValue)
	Adds an additional integer property. More...
	FileDescription ()
	Default constructor. More...
const Dtk_string &	GetDefinition () const
	Retrieves the file definition - read only -. More...
const Dtk_string &	GetDescription () const
	Retrieves the file description - read only -. More...
const Dtk_PropertiesPtr &	GetIthAdditionalProperties (const Dtk_Size_t &inPos) const
	Retrieves the file source type - read only -. More...
const Dtk_string &	GetNomenclature () const
	Retrieves the file nomenclature - read only -. More...
Dtk_Size_t	GetNumAdditionalProperties () const
	Retrieves the file source type - read only -. More...
const catiav5w::Material &	GetPartMaterial () const
	Retrieves the file root material - read only -. More...
const Dtk_string &	GetRevision () const
	Retrieves the file revision - read only -. More...
const ProductSourceType &	GetSourceType () const
	Retrieves the file source type - read only -. More...
	SetAsDeprecated ("2023.4", "Use GetPartMaterial method instead.") inline Dtk_Double64 GetPartDensity() const
	Retrieves the Part Density - read only -. More...
	SetAsDeprecated ("2023.4", "Use SetPartMaterial with Analysis::Density instead.") inline void SetPartDensity(const Dtk_Double64 inPartDensity)
	Sets the Part Density. More...
void	SetDefinition (const Dtk_string &inDefinition)
	Sets the file definition. More...
void	SetDescription (const Dtk_string &inDescription)
	Sets the file description. More...
void	SetNomenclature (const Dtk_string &inNomenclature)
	Sets the file nomenclature. More...
void	SetPartMaterial (const catiav5w::Material &inMaterial)
	Sets the file root material. More...
void	SetRevision (const Dtk_string &inRevision)
	Sets the file revision. More...
void	SetSourceType (const ProductSourceType &inSourceType)
	Sets the file source type. More...
	~FileDescription ()
	Destructor. More...

Protected Attributes
Dtk_tab< Dtk_PropertiesPtr >	_AdditionalProperties
Dtk_string	_Definition
	Definition of the CatiaV5 File. More...
Dtk_string	_Description
	Description of the CatiaV5 File. More...
Dtk_string	_Nomenclature
	Nomenclature of the CatiaV5 File. More...
Dtk_Double64	_PartDensity
Dtk_string	_Revision
	Revision of the CatiaV5 File. More...
ProductSourceType	_SourceType
	Source Type of the CatiaV5 File. More...
Material	m_PartMaterial

Detailed Description

This class provides several informations about a CatiaV5 File.
It can be used with catiav5w::InitPart and catiav5w::InitProduct functions to specify file properties.

//...
catiav5w::FileDescription Desc;
Desc.SetDefinition(L"MyDef");
Desc.SetDescription(L"MyDesc");
Desc.SetRevision(L"MyRev");
Desc.SetNomenclature(L"MyNom");
Desc.SetSourceType(catiav5w::FileDescription::Bought);
Dtk_UUID PartUUID = catiav5w::InitPart( inOutputFile, inReferenceName, Desc);
//...

Member Enumeration Documentation

ProductSourceType

enum catiav5w::FileDescription::ProductSourceType

Enumerator
Unknown
Made
Bought

          {
               Unknown = 0,
               Made,
               Bought
          };

Constructor & Destructor Documentation

FileDescription()

catiav5w::FileDescription::FileDescription

(

)

Default constructor.

          {
               _SourceType = Unknown; _PartDensity = -1.0;
          }

~FileDescription()

catiav5w::FileDescription::~FileDescription

(

)

Destructor.

          {
          }

Member Function Documentation

AddBooleanProperty()

void catiav5w::FileDescription::AddBooleanProperty	(	const Dtk_string &	inPropertyName,
		const Dtk_bool &	inValue
	)

Adds an additional integer property.

          {
               Dtk_string TmpValue;
               TmpValue.convert_from_int( inValue );
               Dtk_PropertiesPtr TmpProp = Dtk_Properties::create();
               TmpProp->SetTitle( inPropertyName );
               TmpProp->SetAsBoolean();
               TmpProp->SetValue( TmpValue );
 
               _AdditionalProperties.push_back( TmpProp );
          }

AddDoubleProperty()

void catiav5w::FileDescription::AddDoubleProperty	(	const Dtk_string &	inPropertyName,
		const double &	inValue
	)

Adds an additional double property.

          {
               Dtk_string TmpValue = inValue;
               Dtk_PropertiesPtr TmpProp = Dtk_Properties::create();
               TmpProp->SetTitle( inPropertyName );
               TmpProp->SetAsReal();
               TmpProp->SetValue( TmpValue );
 
               _AdditionalProperties.push_back( TmpProp );
          }

AddIntegerProperty()

void catiav5w::FileDescription::AddIntegerProperty	(	const Dtk_string &	inPropertyName,
		const Dtk_Int32 &	inValue
	)

Adds an additional integer property.

          {
               Dtk_string TmpValue;
               TmpValue.convert_from_int( inValue );
               Dtk_PropertiesPtr TmpProp = Dtk_Properties::create();
               TmpProp->SetTitle( inPropertyName );
               TmpProp->SetAsInteger();
               TmpProp->SetValue( TmpValue );
 
               _AdditionalProperties.push_back( TmpProp );
          }

AddStringProperty()

void catiav5w::FileDescription::AddStringProperty	(	const Dtk_string &	inPropertyName,
		const Dtk_string &	inValue
	)

Adds an additional integer property.

          {
               Dtk_PropertiesPtr TmpProp = Dtk_Properties::create();
               TmpProp->SetTitle( inPropertyName );
               TmpProp->SetType( L"STRING" );
               TmpProp->SetValue( inValue );
 
               _AdditionalProperties.push_back( TmpProp );
          }

GetDefinition()

const Dtk_string& catiav5w::FileDescription::GetDefinition

(

)

const

Retrieves the file definition - read only -.

Returns

The file definition

See also

SetDefinition()

          {
               return _Definition;
          }

GetDescription()

const Dtk_string& catiav5w::FileDescription::GetDescription

(

)

const

Retrieves the file description - read only -.

Returns

The file description

See also

SetDescription()

          {
               return _Description;
          }

GetIthAdditionalProperties()

const Dtk_PropertiesPtr& catiav5w::FileDescription::GetIthAdditionalProperties

(

const Dtk_Size_t &

inPos

)

const

Retrieves the file source type - read only -.

Returns

The file source type

See also

SetSourceType()

          {
               return _AdditionalProperties[ inPos ];
          }

GetNomenclature()

const Dtk_string& catiav5w::FileDescription::GetNomenclature

(

)

const

Retrieves the file nomenclature - read only -.

Returns

The file nomenclature

See also

SetNomenclature()

          {
               return _Nomenclature;
          }

GetNumAdditionalProperties()

Dtk_Size_t catiav5w::FileDescription::GetNumAdditionalProperties

(

)

const

Retrieves the file source type - read only -.

Returns

The file source type

See also

SetSourceType()

          {
               return _AdditionalProperties.size();
          }

GetPartMaterial()

const catiav5w::Material& catiav5w::FileDescription::GetPartMaterial

(

)

const

Retrieves the file root material - read only -.

Returns

The file root material

See also

SetPartMaterial()

          {
               return m_PartMaterial;
          }

GetRevision()

const Dtk_string& catiav5w::FileDescription::GetRevision

(

)

const

Retrieves the file revision - read only -.

Returns

The file revision

See also

SetRevision()

          {
               return _Revision;
          }

GetSourceType()

const ProductSourceType& catiav5w::FileDescription::GetSourceType

(

)

const

Retrieves the file source type - read only -.

Returns

The file source type

See also

SetSourceType()

          {
               return _SourceType;
          }

SetAsDeprecated() [1/2]

catiav5w::FileDescription::SetAsDeprecated	(	"2023.4"	,
		"Use GetPartMaterial method instead."
	)		const

Retrieves the Part Density - read only -.

Returns

The Part Density

See also

SetPartDensity()

Deprecated:

Use GetPartMaterial method instead.

          {
               return _PartDensity;
          }

SetAsDeprecated() [2/2]

catiav5w::FileDescription::SetAsDeprecated	(	"2023.4"	,
		"Use SetPartMaterial with Analysis::Density instead."
	)		const

Sets the Part Density.

See also

GetPartDensity()

Deprecated:

Use SetPartMaterial with Analysis::Density instead.

          {
               _PartDensity = inPartDensity;
          }

SetDefinition()

void catiav5w::FileDescription::SetDefinition

(

const Dtk_string &

inDefinition

)

Sets the file definition.

See also

GetDefinition()

          {
               _Definition = inDefinition;
          }

SetDescription()

void catiav5w::FileDescription::SetDescription

(

const Dtk_string &

inDescription

)

Sets the file description.

See also

GetDescription()

          {
               _Description = inDescription;
          }

SetNomenclature()

void catiav5w::FileDescription::SetNomenclature

(

const Dtk_string &

inNomenclature

)

Sets the file nomenclature.

See also

GetNomenclature()

          {
               _Nomenclature = inNomenclature;
          }

SetPartMaterial()

void catiav5w::FileDescription::SetPartMaterial

(

const catiav5w::Material &

inMaterial

)

Sets the file root material.

See also

GetPartMaterial()

          {
               m_PartMaterial = inMaterial;
          }

SetRevision()

void catiav5w::FileDescription::SetRevision

(

const Dtk_string &

inRevision

)

Sets the file revision.

See also

GetRevision()

          {
               _Revision = inRevision;
          }

SetSourceType()

void catiav5w::FileDescription::SetSourceType

(

const ProductSourceType &

inSourceType

)

Sets the file source type.

See also

GetSourceType()

          {
               _SourceType = inSourceType;
          }

Field Documentation

_AdditionalProperties

Dtk_tab< Dtk_PropertiesPtr > catiav5w::FileDescription::_AdditionalProperties

protected

_Definition

Dtk_string catiav5w::FileDescription::_Definition

protected

Definition of the CatiaV5 File.

_Description

Dtk_string catiav5w::FileDescription::_Description

protected

Description of the CatiaV5 File.

_Nomenclature

Dtk_string catiav5w::FileDescription::_Nomenclature

protected

Nomenclature of the CatiaV5 File.

_PartDensity

Dtk_Double64 catiav5w::FileDescription::_PartDensity

protected

_Revision

Dtk_string catiav5w::FileDescription::_Revision

protected

Revision of the CatiaV5 File.

_SourceType

ProductSourceType catiav5w::FileDescription::_SourceType

protected

Source Type of the CatiaV5 File.

m_PartMaterial

Material catiav5w::FileDescription::m_PartMaterial

protected