StepBasic_DocumentFile Class Reference

Representation of STEP entity DocumentFile. More...

#include <StepBasic_DocumentFile.hxx>

Inheritance diagram for StepBasic_DocumentFile:

Public Member Functions
	StepBasic_DocumentFile ()
	Empty constructor. More...
void	Init (const Handle< TCollection_HAsciiString > &aDocument_Id, const Handle< TCollection_HAsciiString > &aDocument_Name, const Standard_Boolean hasDocument_Description, const Handle< TCollection_HAsciiString > &aDocument_Description, const Handle< StepBasic_DocumentType > &aDocument_Kind, const Handle< TCollection_HAsciiString > &aCharacterizedObject_Name, const Standard_Boolean hasCharacterizedObject_Description, const Handle< TCollection_HAsciiString > &aCharacterizedObject_Description)
	Initialize all fields (own and inherited) More...
Handle< StepBasic_CharacterizedObject >	CharacterizedObject () const
	Returns data for supertype CharacterizedObject. More...
void	SetCharacterizedObject (const Handle< StepBasic_CharacterizedObject > &CharacterizedObject)
	Set data for supertype CharacterizedObject. More...
Public Member Functions inherited from StepBasic_Document
	StepBasic_Document ()
	Empty constructor. More...
void	Init (const Handle< TCollection_HAsciiString > &aId, const Handle< TCollection_HAsciiString > &aName, const Standard_Boolean hasDescription, const Handle< TCollection_HAsciiString > &aDescription, const Handle< StepBasic_DocumentType > &aKind)
	Initialize all fields (own and inherited) More...
Handle< TCollection_HAsciiString >	Id () const
	Returns field Id. More...
void	SetId (const Handle< TCollection_HAsciiString > &Id)
	Set field Id. More...
Handle< TCollection_HAsciiString >	Name () const
	Returns field Name. More...
void	SetName (const Handle< TCollection_HAsciiString > &Name)
	Set field Name. More...
Handle< TCollection_HAsciiString >	Description () const
	Returns field Description. More...
void	SetDescription (const Handle< TCollection_HAsciiString > &Description)
	Set field Description. More...
Standard_Boolean	HasDescription () const
	Returns True if optional field Description is defined. More...
Handle< StepBasic_DocumentType >	Kind () const
	Returns field Kind. More...
void	SetKind (const Handle< StepBasic_DocumentType > &Kind)
	Set field Kind. More...
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing. More...
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter. More...
virtual	~Standard_Transient ()
	Destructor must be virtual. More...
virtual void	Delete () const
	Memory deallocator for transient classes. More...
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object. More...
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type. More...
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName. More...
Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
Standard_Integer	GetRefCount () const
	Get the reference counter of this object. More...
void	IncrementRefCounter () const
	Increments the reference counter of this object. More...
Standard_Integer	DecrementRefCounter () const
	Decrements the reference counter of this object; returns the decremented value. More...

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object. More...
Static Public Member Functions inherited from Standard_Transient
static const char *	get_type_name ()
	Returns a type descriptor about this object. More...
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class. More...

Detailed Description

Representation of STEP entity DocumentFile.

Constructor & Destructor Documentation

StepBasic_DocumentFile()

StepBasic_DocumentFile::StepBasic_DocumentFile

(

)

Empty constructor.

Member Function Documentation

CharacterizedObject()

Handle< StepBasic_CharacterizedObject > StepBasic_DocumentFile::CharacterizedObject

(

)

const

Returns data for supertype CharacterizedObject.

Init()

void StepBasic_DocumentFile::Init	(	const Handle< TCollection_HAsciiString > &	aDocument_Id,
		const Handle< TCollection_HAsciiString > &	aDocument_Name,
		const Standard_Boolean	hasDocument_Description,
		const Handle< TCollection_HAsciiString > &	aDocument_Description,
		const Handle< StepBasic_DocumentType > &	aDocument_Kind,
		const Handle< TCollection_HAsciiString > &	aCharacterizedObject_Name,
		const Standard_Boolean	hasCharacterizedObject_Description,
		const Handle< TCollection_HAsciiString > &	aCharacterizedObject_Description
	)

Initialize all fields (own and inherited)

SetCharacterizedObject()

void StepBasic_DocumentFile::SetCharacterizedObject

(

const Handle< StepBasic_CharacterizedObject > &

CharacterizedObject

)

Set data for supertype CharacterizedObject.

---

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

• StepBasic_DocumentFile.hxx