Representation of STEP entity Document. More...
#include <StepBasic_Document.hxx>
Inheritance diagram for StepBasic_Document:
Public Member Functions | |
| StepBasic_Document () | |
| Empty constructor. | |
| 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) | |
| Handle< TCollection_HAsciiString > | Id () const |
| Returns field Id. | |
| void | SetId (const Handle< TCollection_HAsciiString > &Id) |
| Set field Id. | |
| Handle< TCollection_HAsciiString > | Name () const |
| Returns field Name. | |
| void | SetName (const Handle< TCollection_HAsciiString > &Name) |
| Set field Name. | |
| Handle< TCollection_HAsciiString > | Description () const |
| Returns field Description. | |
| void | SetDescription (const Handle< TCollection_HAsciiString > &Description) |
| Set field Description. | |
| Standard_Boolean | HasDescription () const |
| Returns True if optional field Description is defined. | |
| Handle< StepBasic_DocumentType > | Kind () const |
| Returns field Kind. | |
| void | SetKind (const Handle< StepBasic_DocumentType > &Kind) |
| Set field Kind. | |
 Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| 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. | |
| 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. | |
| 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. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
| Static Public Member Functions inherited from Standard_Transient | |
| static constexpr const char * | get_type_name () |
| Returns a type descriptor about this object. | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. | |
Detailed Description
Representation of STEP entity Document.
Constructor & Destructor Documentation
◆ StepBasic_Document()
| StepBasic_Document::StepBasic_Document | ( | ) |
Empty constructor.
Member Function Documentation
◆ Description()
| Handle< TCollection_HAsciiString > StepBasic_Document::Description | ( | ) | const |
Returns field Description.
◆ HasDescription()
| Standard_Boolean StepBasic_Document::HasDescription | ( | ) | const |
Returns True if optional field Description is defined.
◆ Id()
| Handle< TCollection_HAsciiString > StepBasic_Document::Id | ( | ) | const |
Returns field Id.
◆ Init()
| void StepBasic_Document::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)
◆ Kind()
| Handle< StepBasic_DocumentType > StepBasic_Document::Kind | ( | ) | const |
Returns field Kind.
◆ Name()
| Handle< TCollection_HAsciiString > StepBasic_Document::Name | ( | ) | const |
Returns field Name.
◆ SetDescription()
| void StepBasic_Document::SetDescription | ( | const Handle< TCollection_HAsciiString > & | Description | ) |
Set field Description.
◆ SetId()
| void StepBasic_Document::SetId | ( | const Handle< TCollection_HAsciiString > & | Id | ) |
Set field Id.
◆ SetKind()
| void StepBasic_Document::SetKind | ( | const Handle< StepBasic_DocumentType > & | Kind | ) |
Set field Kind.
◆ SetName()
| void StepBasic_Document::SetName | ( | const Handle< TCollection_HAsciiString > & | Name | ) |
Set field Name.
The documentation for this class was generated from the following file:
