info:Markdown LaTex example

Version: 0.0.0

Description

This operator showcases the use of Markdown and LaTeX in operator and pin descriptions:

Headings

h2

h3

####### h4 ######## h5

Text

This should result in a paragraph it's that simple.

italic, bold

Lists

• an unordered list
  • with some hierarchy
    1. and an ordered
    2. mixed
    • list
    • directly
  • inside

Code

Code block

std::string a = 'test';

var a = 'test';

a: str = 'test'

Inline code

And well inline code should also work.

Quotes

A Quote

With some text blocks inside

• even a list
• should be
• possible

Links

Links such as link.

Images

Separations

Checklists

• how
• about
  • a
  • nice
• check
• list

Tables

LaTeX

An inline equation $x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.$ using LaTeX dollar delimiters.

An inline equation (x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.) using LaTeX parenthesis delimiters.

An equation on its own using dollar delimiters: $$x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.$$

An equation on its own using square bracket delimiters: [x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.]

Inputs

This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. Some inputs are required, while others are optional and provide additional configuration. Each parameter is detailed in the sections that follow the table.

bogus_input (Pin 0)

• Required: No
• Expected type(s): string

This pin showcases the use of Markdown and LaTeX in pin descriptions:

Headings

h2

h3

####### h4 ######## h5

Text

This should result in a paragraph it's that simple.

italic, bold

Lists

• an unordered list
  • with some hierarchy
    1. and an ordered
    2. mixed
    • list
    • directly
  • inside

Code

Code block

std::string a = 'test';

var a = 'test';

a: str = 'test'

Inline code

And well inline code should also work.

Quotes

A Quote

With some text blocks inside

• even a list
• should be
• possible

Links

Links such as link.

Images

Separations

Checklists

• how
• about
  • a
  • nice
• check
• list

Tables

LaTeX

An inline equation $x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.$ using LaTeX dollar delimiters.

An inline equation (x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.) using LaTeX parenthesis delimiters.

An equation on its own using dollar delimiters: $$x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.$$

An equation on its own using square bracket delimiters: [x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.]

Outputs

This table lists the output pins for this operator. Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. Each output is detailed in the sections that follow the table.

bogus_output (Pin 0)

• Expected type(s):

This pin showcases the use of Markdown and LaTeX in pin descriptions:

Headings

h2

h3

####### h4 ######## h5

Text

This should result in a paragraph it's that simple.

italic, bold

Lists

• an unordered list
  • with some hierarchy
    1. and an ordered
    2. mixed
    • list
    • directly
  • inside

Code

Code block

std::string a = 'test';

var a = 'test';

a: str = 'test'

Inline code

And well inline code should also work.

Quotes

A Quote

With some text blocks inside

• even a list
• should be
• possible

Links

Links such as link.

Images

Separations

Checklists

• how
• about
  • a
  • nice
• check
• list

Tables

LaTeX

An inline equation $x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.$ using LaTeX dollar delimiters.

An inline equation (x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.) using LaTeX parenthesis delimiters.

An equation on its own using dollar delimiters: $$x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.$$

An equation on its own using square bracket delimiters: [x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.]

Configurations

This operator supports configuration options that modify its behavior.

mutex

• Expected type(s): bool
• Default value: false

If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.

Scripting

This operator can be accessed through scripting interfaces using these identifiers.

Category: info

Plugin: documentation

Scripting name: None

Full name: None

Internal name: markdown_latex_example

License: None

Examples

These examples demonstrate how to use this operator in different programming environments. Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output.

#include "dpf_api.h"

ansys::dpf::Operator op("markdown_latex_example"); // operator instantiation
op.connect(0, my_bogus_input);
 my_bogus_output = op.getOutput<>(0);

import ansys.dpf.core as dpf

op = dpf.operators.info.None() # operator instantiation
op.inputs.bogus_input.connect(my_bogus_input)
my_bogus_output = op.outputs.bogus_output()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.info.None() # operator instantiation
op.inputs.bogus_input.Connect(my_bogus_input)
my_bogus_output = op.outputs.bogus_output.GetData()

Changelog

• Version 0.0.0: Initial release.