Open CASCADE Technology
7.7.0
|
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>
Data Structures | |
struct | Hasher |
Public Member Functions | |
XCAFDoc_AssemblyItemId () | |
Constructs an empty item ID. More... | |
XCAFDoc_AssemblyItemId (const TColStd_ListOfAsciiString &thePath) | |
Constructs an item ID from a list of strings, where every string is a label entry. More... | |
XCAFDoc_AssemblyItemId (const TCollection_AsciiString &theString) | |
Constructs an item ID from a formatted path, where label entries are separated by '/' symbol. More... | |
void | Init (const TColStd_ListOfAsciiString &thePath) |
Initializes the item ID from a list of strings, where every string is a label entry. More... | |
void | Init (const TCollection_AsciiString &theString) |
Initializes the item ID from a formatted path, where label entries are separated by '/' symbol. More... | |
Standard_Boolean | IsNull () const |
Returns true if the full path is empty, otherwise - false. More... | |
void | Nullify () |
Clears the full path. More... | |
Standard_Boolean | IsChild (const XCAFDoc_AssemblyItemId &theOther) const |
Checks if this item is a child of the given item. More... | |
Standard_Boolean | IsDirectChild (const XCAFDoc_AssemblyItemId &theOther) const |
Checks if this item is a direct child of the given item. More... | |
Standard_Boolean | IsEqual (const XCAFDoc_AssemblyItemId &theOther) const |
Checks for item IDs equality. More... | |
const TColStd_ListOfAsciiString & | GetPath () const |
Returns the full path as a list of label entries. More... | |
TCollection_AsciiString | ToString () const |
Returns the full pass as a formatted string. More... | |
virtual void | DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const |
Dumps the content of me into the stream. More... | |
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.
XCAFDoc_AssemblyItemId::XCAFDoc_AssemblyItemId | ( | ) |
Constructs an empty item ID.
XCAFDoc_AssemblyItemId::XCAFDoc_AssemblyItemId | ( | const TColStd_ListOfAsciiString & | thePath | ) |
Constructs an item ID from a list of strings, where every string is a label entry.
[in] | thePath | - list of label entries. |
XCAFDoc_AssemblyItemId::XCAFDoc_AssemblyItemId | ( | const TCollection_AsciiString & | theString | ) |
Constructs an item ID from a formatted path, where label entries are separated by '/' symbol.
[in] | theString | - formatted full path. |
|
virtual |
Dumps the content of me into the stream.
const TColStd_ListOfAsciiString& XCAFDoc_AssemblyItemId::GetPath | ( | ) | const |
Returns the full path as a list of label entries.
void XCAFDoc_AssemblyItemId::Init | ( | const TColStd_ListOfAsciiString & | thePath | ) |
Initializes the item ID from a list of strings, where every string is a label entry.
[in] | thePath | - list of label entries. |
void XCAFDoc_AssemblyItemId::Init | ( | const TCollection_AsciiString & | theString | ) |
Initializes the item ID from a formatted path, where label entries are separated by '/' symbol.
[in] | theString | - formatted full path. |
Standard_Boolean XCAFDoc_AssemblyItemId::IsChild | ( | const XCAFDoc_AssemblyItemId & | theOther | ) | const |
Checks if this item is a child of the given item.
[in] | theOther | - potentially ancestor item. |
Standard_Boolean XCAFDoc_AssemblyItemId::IsDirectChild | ( | const XCAFDoc_AssemblyItemId & | theOther | ) | const |
Checks if this item is a direct child of the given item.
[in] | theOther | - potentially parent item. |
Standard_Boolean XCAFDoc_AssemblyItemId::IsEqual | ( | const XCAFDoc_AssemblyItemId & | theOther | ) | const |
Checks for item IDs equality.
[in] | theOther | - the item ID to check equality with. |
Standard_Boolean XCAFDoc_AssemblyItemId::IsNull | ( | ) | const |
Returns true if the full path is empty, otherwise - false.
void XCAFDoc_AssemblyItemId::Nullify | ( | ) |
Clears the full path.
TCollection_AsciiString XCAFDoc_AssemblyItemId::ToString | ( | ) | const |
Returns the full pass as a formatted string.