CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdTraceCollaborator Struct Reference

#include <OdTraceRuntime.h>

Public Member Functions

void setVisible (const OdDb::Visibility visibility)
 
OdDb::Visibility isVisible () const
 
OdString getFirstName () const
 
OdString getLastName () const
 
OdString getUserName () const
 
OdString getTraceFile () const
 
OdString getOxygenId () const
 

Friends

class OdDbTraceRuntimeObject
 

Detailed Description

This class represents information about the collaborator user. This class is intended to be used with methods from OdTraceRuntime class. Corresponding C++ library: AcTrace

<group !!RECORDS_tdrawings_apiref>

Definition at line 52 of file OdTraceRuntime.h.

Member Function Documentation

◆ getFirstName()

OdString OdTraceCollaborator::getFirstName ( ) const
inline

Returns A string contains a first name of collaborator.

Returns
A string contains a first name of collaborator.

Definition at line 95 of file OdTraceRuntime.h.

◆ getLastName()

OdString OdTraceCollaborator::getLastName ( ) const
inline

Returns a string contains a last name of collaborator.

Returns
A string contains a last name of collaborator.

Definition at line 102 of file OdTraceRuntime.h.

◆ getOxygenId()

OdString OdTraceCollaborator::getOxygenId ( ) const
inline

Returns A string contains a user unique hash code.

Returns
A string contains a user unique hash code.

Definition at line 123 of file OdTraceRuntime.h.

◆ getTraceFile()

OdString OdTraceCollaborator::getTraceFile ( ) const
inline

Returns A string contains a trace file name of collaborator.

Returns
A string contains a trace file name of collaborator.

Definition at line 116 of file OdTraceRuntime.h.

◆ getUserName()

OdString OdTraceCollaborator::getUserName ( ) const
inline

Returns A string contains a user name of collaborator.

Returns
A string contains a user name of collaborator.

Definition at line 109 of file OdTraceRuntime.h.

◆ isVisible()

OdDb::Visibility OdTraceCollaborator::isVisible ( ) const
inline

Returns A enum value indicating whether this collaborator's changes are reflected in traces.

Returns
kVisible if collaborator's changes are reflected in traces, otherwise return kInvisible.

Definition at line 88 of file OdTraceRuntime.h.

◆ setVisible()

void OdTraceCollaborator::setVisible ( const OdDb::Visibility visibility)
inline

Sets whether to show this collaborator's changes in the trace.

Parameters
visibility[in] set kVisible to shown this collaborator changes in the trace, otherwise set kInvisible.
Remarks
OdTraceRuntime::showOpenTraceCollaborators(OdArray<OdTraceCollaborator>) is used to display changes, in which in dependence of this flag will turn on / off the display of changes of collaborators

Definition at line 81 of file OdTraceRuntime.h.

Friends And Related Symbol Documentation

◆ OdDbTraceRuntimeObject

friend class OdDbTraceRuntimeObject
friend

Definition at line 126 of file OdTraceRuntime.h.


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