CFunction

class Lib3MF::CFunction : public CResource
std::string GetDisplayName()

Retrieves the display name of the function

Returns:

the display name

void SetDisplayName(const std::string &sDisplayName)

Sets the display name of the function

Parameters:

sDisplayName – the display name

PImplicitPort AddInput(const std::string &sIdentifier, const std::string &sDisplayName, const eImplicitPortType eType)

Add an input

Parameters:
  • sIdentifier – the identifier of the input

  • sDisplayName – the display name of the input

  • eType – the type of the input

Returns:

The added input port

PImplicitPortIterator GetInputs()

Retrieves the inputs

Returns:

iterator for the list of inputs

void RemoveInput(classParam<CImplicitPort> pInput)

Removes an input

Parameters:

pInput – The input to be removed

PImplicitPort AddOutput(const std::string &sIdentifier, const std::string &sDisplayName, const eImplicitPortType eType)

Add an output

Parameters:
  • sIdentifier – the identifier of the output

  • sDisplayName – the display name of the output

  • eType – the type of the input

Returns:

The added input port

PImplicitPortIterator GetOutputs()

Retrieves the outputs

Returns:

iterator for the outputs

void RemoveOutput(classParam<CImplicitPort> pOutput)

Removes an output

Parameters:

pOutput – The output to be removed

PImplicitPort FindInput(const std::string &sIdentifier)

Retrieves an input

Parameters:

sIdentifier – the identifier of the input

Returns:

the input port

PImplicitPort FindOutput(const std::string &sIdentifier)

Retrieves an output

Parameters:

sIdentifier – the identifier of the output

Returns:

the output port

typedef std::shared_ptr<CFunction> Lib3MF::PFunction

Shared pointer to CFunction to easily allow reference counting.