class MotorInterface : public CDPPort
{
public:
    void Create(const char* shortName, CDPComponent* parent) override;

    CDPProperty<double> SpeedSetpoint;
    CDPProperty<double> ActualSpeed;
    CDPProperty<bool>   Start;
    CDPProperty<bool>   Stop;
    CDPProperty<bool>   IsRunning;
};

Member Function Documentation

CDPPort::CDPPort()

Plain port constructor

[virtual] CDPPort::~CDPPort()

Destructor

[override virtual] void CDPPort::Activate()

Reimplemented from CDPBaseObject::Activate().

Establishes connection to remote object. Called automatically by parent component on startup.

void CDPPort::AddInput(const std::string &name, const std::string &localName, const std::string &remoteName)

Adds a input connection in addition to those specified in configuration.

If port was connected when this method was called, a reconnect sequence will be triggered. For bulk modifications first call Disconnect(), then do modifications and finally call Reconnect().

void CDPPort::AddOutput(const std::string &name, const std::string &localName, const std::string &remoteName)

Adds a output connection in addition to those specified in configuration.

If port was connected when this method was called, a reconnect sequence will be triggered. For bulk modifications first call Disconnect(), then do modifications and finally call Reconnect().

void CDPPort::AddValuedInput(const std::string &name, const std::string &valueType, const std::string &initialValue, const std::string &valueRouting)

Adds a input connection with embedded value (like ValuedConnection<T>) in addition to those specified in configuration.

If port was connected when this method was called, a reconnect sequence will be triggered. For bulk modifications first call Disconnect(), then do modifications and finally call Reconnect().

void CDPPort::AddValuedOutput(const std::string &name, const std::string &valueType, const std::string &initialValue, const std::string &valueRouting)

Adds a output connection with embedded value (like ValuedConnection<T>) in addition to those specified in configuration.

If port was connected when this method was called, a reconnect sequence will be triggered. For bulk modifications first call Disconnect(), then do modifications and finally call Reconnect().

[override virtual] void CDPPort::Configure(XMLElementEx *xml)

Reimplemented from CDPObject::Configure().

void CDPPort::Connect(const std::string &routing)

Connects the port to specified remote node

[override virtual] void CDPPort::Create(const char *shortName, CDPComponent *parent)

Reimplemented from CDPObject::Create().

[override virtual] void CDPPort::CreateModel()

Reimplemented from CDPBaseObject::CreateModel().

[override virtual] void CDPPort::Destroy()

Reimplemented from CDPBaseObject::Destroy().

void CDPPort::Disconnect()

Disconnects all inputs and outputs. Disconnect does not clear current Routing.

[override virtual] void CDPPort::FillNodeChildren(CDP::StudioAPI::NodeStream &serializer) const

Reimplemented from CDPNode::FillNodeChildren().

void CDPPort::ForEachConnection(const std::function<void( IPortConnection & ) > &f)

Call argument f function for each Connection the CDPPort has.

[protected] int CDPPort::HandleReverseProxyValue(const std::string &api, const std::string &value)

[virtual] bool CDPPort::HasNamedValueChild(const std::string &name)

Returns true if given port has a value child with given name

bool CDPPort::IsConnected() const

Returns true if all inputs and outputs were found and have been connected.

bool CDPPort::IsInput() const

Returns true if port is an input.

[virtual protected] bool CDPPort::IsInputConnection(XMLElementEx *connection)

Override to programmatically determine whether a Connection is input or output.

[virtual protected] int CDPPort::MessageConnectValueFailed(void *message)

Received when connecting a output failed.

[virtual protected] int CDPPort::MessageConnectValueOK(void *message)

Received when a output specified in message parameter string was successfully connected.

int CDPPort::MessageNACK(void *messageNack)

int CDPPort::MessageReconnectValue(void *message)

Received when Port needs to try reconnect on a API value.

[virtual] int CDPPort::MessageReverseProxyValue(void *message)

void CDPPort::Reconnect()

Connects to node specified by Routing property.

void CDPPort::RemoveInput(const std::string &name)

Removes a input.

If port was connected when this method was called, a reconnect sequence will be triggered. For bulk modifications first call Disconnect(), then do modifications and finally call Reconnect().

void CDPPort::RemoveOutput(const std::string &name)

Removes a output.

If port was connected when this method was called, a reconnect sequence will be triggered. For bulk modifications first call Disconnect(), then do modifications and finally call Reconnect().

void CDPPort::SetDataConsistency(bool dataConsistency)

When set to true, values connected by this port are sent within the same data packet, meaning that a group of remote values always appears consistent. Otherwise when multiple values change, they may appear for a remote application in wrong order or one change might be delayed a little. This option can only be enabled when the port only connects values with periodic routing (not event-based, see CDPPropertyBase::RouteMethod_e).

If port was connected when this method was called, a reconnect sequence will be triggered.

[override virtual] void CDPPort::SetProperty(std::string propertyName, std::string propertyValue)

[override virtual protected] void CDPPort::SetPropertyHandler(CDPPropertyBase *property)

Reimplemented from CDPObject::SetPropertyHandler().

[override virtual] void CDPPort::Suspend()

Reimplemented from CDPBaseObject::Suspend().

Disconnects all inputs and outputs from remote object.