Detailed Description

The SimPort is a CDPPort which is able to aggregate SimSignals. It can only be added to simulator components. To use it, inherit your class from SimPort and add some SimSignals.

Properties

The following properties are available for the SimPort:

PortSimSignal

A PortSimSignal is a CDPSim::SimSignal added to a SimPort. For that purpose, it includes a few additional properties compared to a regular CDPSim::SimSignal that allows customizing the connection options.

The following properties are available for the PortSimSignal:

Usage

The SimPort can be used in two ways:

• As a code port meant to be used in C++ code by a DynamicSimComponent
• As a configuration-only port meant to help structure the project and to make use of CDPOperators creating some simple no-code logic.

This class documentation describes the code port use case. For the configuration-only use case, see the SimPort Configuration Manual.

Description

The SimPort is used to aggregate multiple SimSignals into a single data structure that can be connected to another SimPort by setting a single Routing. The port allows two-way connection, for that each SimSignal must specify whether they are inputs or outputs of the port.

Usage

To use SimPort:

• Create a new class and make it inherit from SimPort.
• Add your SimSignals and register them by calling SimSignal::Create.
• Make sure the SimSignals have been added to SimPort model in Configure mode.
• Make sure the Input flag of every SimSignal is correctly set for each input and output signal.
• Build the library and use the SimPort from simulator component code as a regular CDPPort is used.

Code

In the class header:

#include <CDPSim/DynamicSimComponent/SimPort.h>
namespace SimLib {
class MySimPort : public CDPSim::SimPort
{
public:
    void Create(const char* shortName, CDPComponent* parent) override;
    CDPSim::SimSignal MySignal;
};
}

In the implementation file:

#include "MySimPort.h"
using namespace SimLib;
void MySimPort::Create(const char* shortName, CDPComponent* parent)
{
    CDPPort::Create(shortName, parent); // Always call base
    MySignal.Create("MySignal", this);
}

To use the created MySimPort, add it to your simulator component.

class MySimComponent : public CDPSim::DynamicSimComponent
{
  ...
  SimLib::MySimPort Port;
};

void MySimComponent::Create(const char* fullName)
{
  CDPSim::DynamicSimComponent::Create(fullName); // Always call base class.
  Port.Create("Port", this);
}

void MySimComponent::EvaluateDiffEquations(double t)
{
  // Use Port.MySignal in your calculations
}

Properties

The following properties are available for the SimPort: