ethernet_ip.h

Go to the documentation of this file.

#ifndef AUBO_SCOPE_ETHERNET_IP_H
#define AUBO_SCOPE_ETHERNET_IP_H

#include <aubo_caps/domain/io/io.h>

namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(EtherNetIP);

/**
 *
 * This interface provides support for EtherNet/IP I/Os.
 */
class ARCS_ABI_EXPORT EtherNetIP : public Io
{
public:
    EtherNetIP(EtherNetIP &f);
    EtherNetIP(EtherNetIP &&f);
    ~EtherNetIP();

    /**
     *
     * @return Get the byte offset for this EtherNet/IP I/O.
     */
    int getByteOffset();

    /**
     *
     * @return Get the bit offset for this EtherNet/IP I/O.
     */
    int getBitOffset();

    /**
     *
     * @return Get the is slave for this EtherNet/IP I/O.
     */
    bool isSlave();

    /**
     *
     * @param value Set EtherNet/IP signal to an integer value. If the
     * EtherNet/IP signal is digital, then <code>false</code> is represented by
     * 0 and <code>true</code> are represented by all numbers different from 0.
     *
     * @return <code>true</code> if the EtherNet/IP signal was sent down to the
     * controller, and <code>false</code> if the signal was not sent down, e.g.
     * because the controller was not running. Notice that the EtherNet/IP
     * signal must support writes, consult the Aubo EtherNet/IP protocol.
     */
    bool setValue(int value);

    /**
     *
     * @return the integer value of the EtherNet/IP signal. If the EtherNet/IP
     * signal is digital then <code>false</code> is represented by 0 and
     * <code>true}</code> is represented by the value 1.
     */
    int getValue();

private:
    friend class DataSwitch;
    EtherNetIP();
    void *d_{ nullptr };
};

struct EtherNetIPFilter
{
    EtherNetIPFilter(Io::IoType type, bool is_input)
        : type_(type), is_input_(is_input)
    {
    }
    bool operator()(IoPtr io)
    {
        return std::dynamic_pointer_cast<EtherNetIP>(io) != nullptr &&
               io->getType() == type_ && io->isInput() == is_input_;
    }

private:
    Io::IoType type_;
    bool is_input_;
};

} // namespace aubo_scope
} // namespace arcs

#endif // EtherNet/IPIO_H