Search Results for

    Show / Hide Table of Contents

    Interface IOperations

    Gives access to operations.

    Namespace: TopSolid.Kernel.Automating
    Assembly: cs.temp.dll.dll
    Syntax
    [AvailableSinceVersion(7, 6, 0, 0)]
    public interface IOperations
    Remarks

    This interface is available since v7.6.

    Methods

    Activate(ElementId)

    Activates an operation.

    Declaration
    [AvailableSinceVersion(7, 12, 0, 0)]
    void Activate(ElementId inElementId)
    Parameters
    Type Name Description
    ElementId inElementId

    Identifier of the operation to modify.

    Remarks

    StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

    This method is available since v7.12.

    Deactivate(ElementId)

    Deactivates an operation.

    Declaration
    [AvailableSinceVersion(7, 12, 0, 0)]
    void Deactivate(ElementId inElementId)
    Parameters
    Type Name Description
    ElementId inElementId

    Identifier of the operation to modify.

    Remarks

    An exception will be thrown when trying to deactivate an operation that is not deactivable.

    StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

    This method is available since v7.12.

    Freeze(ElementId)

    Freezes an operation.

    Declaration
    [AvailableSinceVersion(7, 12, 0, 0)]
    void Freeze(ElementId inElementId)
    Parameters
    Type Name Description
    ElementId inElementId

    Identifier of the operation to modify.

    Remarks

    An exception will be thrown when trying to freeze an operation that is not freezable.

    StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

    This method is available since v7.12.

    GetChild(ElementId)

    Gets the child element of an operation.

    Declaration
    [AvailableSinceVersion(7, 6, 0, 0)]
    ElementId GetChild(ElementId inElementId)
    Parameters
    Type Name Description
    ElementId inElementId

    Identifier of the operation to analyze.

    Returns
    Type Description
    ElementId

    Identifier of the child element found, or Empty if none.

    Remarks

    The operation must not have several children, otherwise an exception is thrown.

    This method is available since v7.6.

    GetChildren(ElementId)

    Gets the children elements of a an operation.

    Declaration
    [AvailableSinceVersion(7, 6, 0, 0)]
    List<ElementId> GetChildren(ElementId inElementId)
    Parameters
    Type Name Description
    ElementId inElementId

    Identifier of the operation to analyze.

    Returns
    Type Description
    List<ElementId>

    Identifiers of the children elements found.

    Remarks

    This method is available since v7.6.

    GetCondition(ElementId)

    Gets the condition of an operation.

    Declaration
    [AvailableSinceVersion(7, 12, 0, 0)]
    SmartBoolean GetCondition(ElementId inElementId)
    Parameters
    Type Name Description
    ElementId inElementId

    Identifier of the operation to analyze.

    Returns
    Type Description
    SmartBoolean

    Condition of the operation, or null if none.

    Remarks

    This method is available since v7.12.

    GetDefinitionStage(DocumentId)

    Gets the definition stage operation of a document.

    Declaration
    [AvailableSinceVersion(7, 8, 0, 0)]
    ElementId GetDefinitionStage(DocumentId inDocumentId)
    Parameters
    Type Name Description
    DocumentId inDocumentId

    Identifier of the document to analyze.

    Returns
    Type Description
    ElementId

    Identifier of the definition stage operation found, or Empty if none.

    Remarks

    This method is available since v7.8.

    GetFinalStage(DocumentId)

    Gets the final stage operation of a document.

    Declaration
    [AvailableSinceVersion(7, 8, 0, 0)]
    ElementId GetFinalStage(DocumentId inDocumentId)
    Parameters
    Type Name Description
    DocumentId inDocumentId

    Identifier of the document to analyze.

    Returns
    Type Description
    ElementId

    Identifier of the final stage operation.

    Remarks

    This method is available since v7.8.

    GetInitialStage(DocumentId)

    Gets the initial stage operation of a document.

    Declaration
    [AvailableSinceVersion(7, 8, 0, 0)]
    ElementId GetInitialStage(DocumentId inDocumentId)
    Parameters
    Type Name Description
    DocumentId inDocumentId

    Identifier of the document to analyze.

    Returns
    Type Description
    ElementId

    Identifier of the initial stage operation.

    Remarks

    This method is available since v7.8.

    GetInsertionOperation(DocumentId)

    Gets the insertion operation of a document.

    Declaration
    [AvailableSinceVersion(7, 8, 0, 0)]
    ElementId GetInsertionOperation(DocumentId inDocumentId)
    Parameters
    Type Name Description
    DocumentId inDocumentId

    Identifier of the document to analyze.

    Returns
    Type Description
    ElementId

    Identifier of the insertion operation.

    Remarks

    New operations are created before the insertion operation.

    This method is available since v7.8.

    GetModelingStage(DocumentId)

    Gets the modeling stage operation of a document.

    Declaration
    [AvailableSinceVersion(7, 8, 0, 0)]
    ElementId GetModelingStage(DocumentId inDocumentId)
    Parameters
    Type Name Description
    DocumentId inDocumentId

    Identifier of the document to analyze.

    Returns
    Type Description
    ElementId

    Identifier of the modeling stage operation found, or Empty if none.

    Remarks

    This method is available since v7.8.

    GetModelingTolerances(ElementId, out Double, out Double)

    Gets the modeling tolerances of an operation.

    Declaration
    [AvailableSinceVersion(7, 8, 0, 0)]
    void GetModelingTolerances(ElementId inElementId, out double outLinearTolerance, out double outAngularTolerance)
    Parameters
    Type Name Description
    ElementId inElementId

    Identifier of the operation to analyze.

    Double outLinearTolerance

    Linear tolerance (in meters), or 0 if the operation does not have a linear modeling tolerance.

    Double outAngularTolerance

    Angular tolerance (in radians), or 0 if the operation does not have an angular modeling tolerance.

    Remarks

    This method is available since v7.8.

    GetOperations(DocumentId)

    Gets the operations of a document.

    Declaration
    [AvailableSinceVersion(7, 6, 0, 0)]
    List<ElementId> GetOperations(DocumentId inDocumentId)
    Parameters
    Type Name Description
    DocumentId inDocumentId

    Identifier of the document to analyze.

    Returns
    Type Description
    List<ElementId>

    Operations found.

    Remarks

    The operations are sorted in chronological order (i.e. first operation of the list is executed first).

    This method is available since v7.6.

    GetStages(DocumentId)

    Gets the stage operations of a document.

    Declaration
    [AvailableSinceVersion(7, 8, 0, 0)]
    List<ElementId> GetStages(DocumentId inDocumentId)
    Parameters
    Type Name Description
    DocumentId inDocumentId

    Identifier of the document to analyze.

    Returns
    Type Description
    List<ElementId>

    Stage operations found.

    Remarks

    The stage operations are sorted in chronological order.

    This method is available since v7.8.

    GetWorkingStage(DocumentId)

    Gets the working stage operation of a document.

    Declaration
    [AvailableSinceVersion(7, 8, 0, 0)]
    ElementId GetWorkingStage(DocumentId inDocumentId)
    Parameters
    Type Name Description
    DocumentId inDocumentId

    Identifier of the document to analyze.

    Returns
    Type Description
    ElementId

    Identifier of the working stage operation.

    Remarks

    This method is available since v7.8.

    HasFrozenOwner(ElementId)

    Tells whether an operation owner is frozen, or the owner of its owner,...

    Declaration
    [AvailableSinceVersion(7, 12, 0, 0)]
    bool HasFrozenOwner(ElementId inElementId)
    Parameters
    Type Name Description
    ElementId inElementId

    Identifier of the operation to analyze.

    Returns
    Type Description
    Boolean

    The operation has a direct or indirect frozen owner.

    Remarks

    This method is available since v7.12.

    HasInactiveOwner(ElementId)

    Tells whether an operation owner is not active, or the owner of its owner,...

    Declaration
    [AvailableSinceVersion(7, 12, 0, 0)]
    bool HasInactiveOwner(ElementId inElementId)
    Parameters
    Type Name Description
    ElementId inElementId

    Identifier of the operation to analyze.

    Returns
    Type Description
    Boolean

    The operation has a direct or indirect inactive owner.

    Remarks

    This method is available since v7.12.

    IsActive(ElementId)

    Tells whether an operation is active.

    Declaration
    [AvailableSinceVersion(7, 6, 0, 0)]
    bool IsActive(ElementId inElementId)
    Parameters
    Type Name Description
    ElementId inElementId

    Identifier of the operation to analyze.

    Returns
    Type Description
    Boolean

    The operation is active.

    Remarks

    This method is available since v7.6.

    IsDeactivable(ElementId)

    Tells whether an operation may be deactivated.

    Declaration
    [AvailableSinceVersion(7, 12, 0, 0)]
    bool IsDeactivable(ElementId inElementId)
    Parameters
    Type Name Description
    ElementId inElementId

    Identifier of the operation to analyze.

    Returns
    Type Description
    Boolean

    The operation may be deactivated.

    Remarks

    This method is available since v7.12.

    IsFreezable(ElementId)

    Tells whether an operation may be frozen.

    Declaration
    [AvailableSinceVersion(7, 12, 0, 0)]
    bool IsFreezable(ElementId inElementId)
    Parameters
    Type Name Description
    ElementId inElementId

    Identifier of the operation to analyze.

    Returns
    Type Description
    Boolean

    The operation may be frozen.

    Remarks

    This method is available since v7.12.

    IsFrozen(ElementId)

    Tells whether an operation is frozen.

    Declaration
    [AvailableSinceVersion(7, 12, 0, 0)]
    bool IsFrozen(ElementId inElementId)
    Parameters
    Type Name Description
    ElementId inElementId

    Identifier of the operation to analyze.

    Returns
    Type Description
    Boolean

    The operation is frozen.

    Remarks

    This method is available since v7.12.

    IsOperation(ElementId)

    Tells whether an element is an operation.

    Declaration
    [AvailableSinceVersion(7, 6, 0, 0)]
    bool IsOperation(ElementId inElementId)
    Parameters
    Type Name Description
    ElementId inElementId

    Identifier of the element to analyze.

    Returns
    Type Description
    Boolean

    The element is an operation.

    Remarks

    This method is available since v7.6.

    MoveOperation(ElementId, ElementId, Int32)

    Moves an operation.

    Declaration
    [AvailableSinceVersion(7, 7, 201, 80)]
    void MoveOperation(ElementId inElementId, ElementId inOwnerId, int inIndex)
    Parameters
    Type Name Description
    ElementId inElementId

    Identifier of the operation to move.

    ElementId inOwnerId

    Identifier of the new owner operation.

    Int32 inIndex

    Index of the operation in the new owner.

    Remarks

    StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

    This method is available since v7.7.201.80.

    ResetInsertionOperation(DocumentId)

    Resets the insertion operation of a document to its natural place.

    Declaration
    [AvailableSinceVersion(7, 8, 0, 0)]
    void ResetInsertionOperation(DocumentId inDocumentId)
    Parameters
    Type Name Description
    DocumentId inDocumentId

    Identifier of the document to modify.

    Remarks

    New operations are created before the insertion operation.

    StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

    This method is available since v7.8.

    SetCondition(ElementId, SmartBoolean)

    Sets the condition of an operation.

    Declaration
    [AvailableSinceVersion(7, 12, 0, 0)]
    void SetCondition(ElementId inElementId, SmartBoolean inCondition)
    Parameters
    Type Name Description
    ElementId inElementId

    Identifier of the operation to modify.

    SmartBoolean inCondition

    Condition, or null if none.

    Remarks

    An exception will be thrown when trying to set a non-null condition to an operation that is not deactivable.

    StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

    This method is available since v7.12.

    SetInsertionOperation(ElementId)

    Sets the insertion operation of a document.

    Declaration
    [AvailableSinceVersion(7, 8, 0, 0)]
    void SetInsertionOperation(ElementId inOperationId)
    Parameters
    Type Name Description
    ElementId inOperationId

    Identifier of new insertion operation.

    Remarks

    New operations are created before the insertion operation.

    StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

    This method is available since v7.8.

    SetModelingTolerances(ElementId, Double, Double)

    Sets the modeling tolerances of an operation.

    Declaration
    [AvailableSinceVersion(7, 8, 0, 0)]
    void SetModelingTolerances(ElementId inElementId, double inLinearTolerance, double inAngularTolerance)
    Parameters
    Type Name Description
    ElementId inElementId

    Identifier of the operation to modify.

    Double inLinearTolerance

    Linear tolerance (in meters, within [0.0001mm,0.1mm]), or 0 for unchanged.

    Double inAngularTolerance

    Angular tolerance (in radians, within [0.01°,10°]), or 0 for unchanged.

    Remarks

    StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

    This method is available since v7.8.

    SetWorkingStage(ElementId)

    Sets the working stage operation of a document.

    Declaration
    [AvailableSinceVersion(7, 8, 0, 0)]
    void SetWorkingStage(ElementId inOperationId)
    Parameters
    Type Name Description
    ElementId inOperationId

    Identifier of new working stage operation.

    Remarks

    StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

    This method is available since v7.8.

    Unfreeze(ElementId)

    Unfreezes an operation.

    Declaration
    [AvailableSinceVersion(7, 12, 0, 0)]
    void Unfreeze(ElementId inElementId)
    Parameters
    Type Name Description
    ElementId inElementId

    Identifier of the operation to modify.

    Remarks

    StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

    This method is available since v7.12.

    In This Article
    • Term of use
    • Corporate information
    • Privacy Policy - GDPR

    Copyright ©2024 TopSolid - All rights reserved.