OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.
    Open CASCADE Technology Reference Manual 8.0.1
    XCAFDoc_AssemblyItemId Class Reference

    Unique item identifier in the hierarchical product structure. A full path to an assembly component in the "part-of" graph starting from the root node. More...

    #include <XCAFDoc_AssemblyItemId.hxx>

    Public Member Functions

     XCAFDoc_AssemblyItemId ()
     Constructs an empty item ID.
     XCAFDoc_AssemblyItemId (const NCollection_List< TCollection_AsciiString > &thePath)
     Constructs an item ID from a list of strings, where every string is a label entry.
     XCAFDoc_AssemblyItemId (const TCollection_AsciiString &theString)
     Constructs an item ID from a formatted path, where label entries are separated by '/' symbol.
    void Init (const NCollection_List< TCollection_AsciiString > &thePath)
     Initializes the item ID from a list of strings, where every string is a label entry.
    void Init (const TCollection_AsciiString &theString)
     Initializes the item ID from a formatted path, where label entries are separated by '/' symbol.
    bool IsNull () const
     Returns true if the full path is empty, otherwise - false.
    void Nullify ()
     Clears the full path.
    bool IsChild (const XCAFDoc_AssemblyItemId &theOther) const
     Checks if this item is a child of the given item.
    bool IsDirectChild (const XCAFDoc_AssemblyItemId &theOther) const
     Checks if this item is a direct child of the given item.
    bool IsEqual (const XCAFDoc_AssemblyItemId &theOther) const
     Checks for item IDs equality.
    const NCollection_List< TCollection_AsciiString > & GetPath () const
     Returns the full path as a list of label entries.
    TCollection_AsciiString ToString () const
     Returns the full pass as a formatted string.
    virtual void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
     Dumps the content of me into the stream.
    bool operator== (const XCAFDoc_AssemblyItemId &theOther) const

    Detailed Description

    Unique item identifier in the hierarchical product structure. A full path to an assembly component in the "part-of" graph starting from the root node.

    Constructor & Destructor Documentation

    ◆ XCAFDoc_AssemblyItemId() [1/3]

    XCAFDoc_AssemblyItemId::XCAFDoc_AssemblyItemId ( )

    Constructs an empty item ID.

    ◆ XCAFDoc_AssemblyItemId() [2/3]

    XCAFDoc_AssemblyItemId::XCAFDoc_AssemblyItemId ( const NCollection_List< TCollection_AsciiString > & thePath)

    Constructs an item ID from a list of strings, where every string is a label entry.

    Parameters
    [in]thePath- list of label entries.

    ◆ XCAFDoc_AssemblyItemId() [3/3]

    XCAFDoc_AssemblyItemId::XCAFDoc_AssemblyItemId ( const TCollection_AsciiString & theString)

    Constructs an item ID from a formatted path, where label entries are separated by '/' symbol.

    Parameters
    [in]theString- formatted full path.

    Member Function Documentation

    ◆ DumpJson()

    virtual void XCAFDoc_AssemblyItemId::DumpJson ( Standard_OStream & theOStream,
    int theDepth = -1 ) const
    		virtual

    Dumps the content of me into the stream.

    ◆ GetPath()

    const NCollection_List< TCollection_AsciiString > & XCAFDoc_AssemblyItemId::GetPath ( ) const

    Returns the full path as a list of label entries.

    ◆ Init() [1/2]

    void XCAFDoc_AssemblyItemId::Init ( const NCollection_List< TCollection_AsciiString > & thePath)

    Initializes the item ID from a list of strings, where every string is a label entry.

    Parameters
    [in]thePath- list of label entries.

    ◆ Init() [2/2]

    void XCAFDoc_AssemblyItemId::Init ( const TCollection_AsciiString & theString)

    Initializes the item ID from a formatted path, where label entries are separated by '/' symbol.

    Parameters
    [in]theString- formatted full path.

    ◆ IsChild()

    bool XCAFDoc_AssemblyItemId::IsChild ( const XCAFDoc_AssemblyItemId & theOther) const

    Checks if this item is a child of the given item.

    Parameters
    [in]theOther- potentially ancestor item.
    Returns
    true if the item is a child of theOther item, otherwise - false.

    ◆ IsDirectChild()

    bool XCAFDoc_AssemblyItemId::IsDirectChild ( const XCAFDoc_AssemblyItemId & theOther) const

    Checks if this item is a direct child of the given item.

    Parameters
    [in]theOther- potentially parent item.
    Returns
    true if the item is a direct child of theOther item, otherwise - false.

    ◆ IsEqual()

    bool XCAFDoc_AssemblyItemId::IsEqual ( const XCAFDoc_AssemblyItemId & theOther) const

    Checks for item IDs equality.

    Parameters
    [in]theOther- the item ID to check equality with.
    Returns
    true if this ID is equal to theOther, otherwise - false.

    ◆ IsNull()

    bool XCAFDoc_AssemblyItemId::IsNull ( ) const

    Returns true if the full path is empty, otherwise - false.

    ◆ Nullify()

    void XCAFDoc_AssemblyItemId::Nullify ( )

    Clears the full path.

    ◆ operator==()

    bool XCAFDoc_AssemblyItemId::operator== ( const XCAFDoc_AssemblyItemId & theOther) const
    		inline

    ◆ ToString()

    TCollection_AsciiString XCAFDoc_AssemblyItemId::ToString ( ) const

    Returns the full pass as a formatted string.

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