Open Search
    Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | List of all members
    NodeContextAssetInterface Class Reference

    #include <nodecontext_asset.h>

    Inheritance diagram for NodeContextAssetInterface:
    Inheritance graph
    [legend]

    Public Member Functions

    MAXON_METHOD InternedId GetContextId () const
     
    MAXON_METHOD Result< void > SetContextId (const Id &contextId)
     
    MAXON_METHOD DataType GetContextType () const
     
    MAXON_METHOD Result< void > SetContextType (const DataType &dataType)
     

    Static Public Member Functions

    static MAXON_METHOD Result< NodeContextAsset > Create ()
     

    Static Public Attributes

    static constexpr LiteralId NONE_CONTEXT_ID
     

    Private Member Functions

     MAXON_INTERFACE (NodeContextAssetInterface, MAXON_REFERENCE_COPY_ON_WRITE, "net.maxon.node.interface.contextasset")
     

    Member Function Documentation

    ◆ MAXON_INTERFACE()

    MAXON_INTERFACE ( NodeContextAssetInterface  ,
    MAXON_REFERENCE_COPY_ON_WRITE  ,
    "net.maxon.node.interface.contextasset"   
    )
    		private

    ◆ Create()

    static MAXON_METHOD Result<NodeContextAsset> Create ( )
    		static

    ◆ GetContextId()

    MAXON_METHOD InternedId GetContextId ( ) const

    Read the context's Id.

    Returns
    The Id read.

    ◆ SetContextId()

    MAXON_METHOD Result<void> SetContextId ( const Id &  contextId)

    Set the context's Id.

    Parameters
    [in]contextIdThe type to set (empty type accepted).
    Returns
    OK on success.

    ◆ GetContextType()

    MAXON_METHOD DataType GetContextType ( ) const

    Read the context's type.

    Returns
    The type read (can be empty DataType).

    ◆ SetContextType()

    MAXON_METHOD Result<void> SetContextType ( const DataType &  dataType)

    Set the context's type.

    Parameters
    [in]dataTypeThe type to set (empty type accepted).
    Returns
    OK on success.

    Member Data Documentation

    ◆ NONE_CONTEXT_ID

    constexpr LiteralId NONE_CONTEXT_ID
    		staticconstexpr