• Skip to main content
  • Skip to header right navigation
  • Skip to site footer
CDP Studio logo

CDP Studio

The no-code and full-code software development tool for distributed control systems and HMI

  • Why CDP
    • Software developers
    • Automation engineers
    • Managers
  • Product
    • Design UI
    • Develop
    • Analyze and test
    • Deploy
    • Framework and toolbox
    • Compatibility
  • Services
  • Use cases
  • Pricing
  • Try CDP

CDP Studio Documentation

  • Framework - CDP Core
  • TranslatorChannelBase
  • 4.11.14

TranslatorChannelBase Class

(ServerIO::Translator::TranslatorChannelBase)

Type-less base class for TranslatorChannel<T>. Defines virtual functions to be implemented in derived (typed) classes for setting and getting channel synced values. More...

Header: #include <IO/ServerIO/Translator/TranslatorChannel.h>
Inherited By:

ServerIO::Translator::TranslatorChannel

  • List of all members, including inherited members

Public Functions

virtual ~TranslatorChannelBase()
bool Bidirectional()
virtual bool GetData(void *data, unsigned int size = 0)
unsigned int GetDataSize() const
virtual bool HasMappedValue() const = 0
bool Input()
virtual std::string MappedValue() const = 0
std::string Name() const
virtual bool PutData(const void *data, unsigned int size = 0)
void SerializeChannel(CDP::StudioAPI::NodeStream &NodeStream) const
virtual bool SetMappedValue(const std::string &stringVal) = 0
void SetOnChangeValidator(ServerIO::ISendTrigger *sendTo)
virtual void SetValue(const std::string &stringVal) = 0
void SetValue(T val)
void SetValueMapper(ValueMapper *m)
virtual std::string StringValue() const = 0
virtual std::string Type() const = 0
T Value() const

Static Public Members

TranslatorChannelBase *CreateNew(const std::string &type, ServerIO::ICDPChannel *iCDPChannel)

Detailed Description

Type-less base class for TranslatorChannel<T>. Defines virtual functions to be implemented in derived (typed) classes for setting and getting channel synced values.

Member Function Documentation

[virtual] TranslatorChannelBase::~TranslatorChannelBase()

Destructor for TranslatorChannelBase. Explicitly mandatory for TranslatorChannelBase vtable.

bool TranslatorChannelBase::Bidirectional()

[static] TranslatorChannelBase *TranslatorChannelBase::CreateNew(const std::string &type, ServerIO::ICDPChannel *iCDPChannel)

[virtual] bool TranslatorChannelBase::GetData(void *data, unsigned int size = 0)

Gets syncValue binary data. For binary translator use only.

unsigned int TranslatorChannelBase::GetDataSize() const

[pure virtual] bool TranslatorChannelBase::HasMappedValue() const

bool TranslatorChannelBase::Input()

[pure virtual] std::string TranslatorChannelBase::MappedValue() const

std::string TranslatorChannelBase::Name() const

Returns channel name.

[virtual] bool TranslatorChannelBase::PutData(const void *data, unsigned int size = 0)

void TranslatorChannelBase::SerializeChannel(CDP::StudioAPI::NodeStream &NodeStream) const

Serializes actual CDP channel to nodestream.

[pure virtual] bool TranslatorChannelBase::SetMappedValue(const std::string &stringVal)

void TranslatorChannelBase::SetOnChangeValidator(ServerIO::ISendTrigger *sendTo)

[pure virtual] void TranslatorChannelBase::SetValue(const std::string &stringVal)

void TranslatorChannelBase::SetValue(T val)

Templated helper function for setting channel synced value.

void TranslatorChannelBase::SetValueMapper(ValueMapper *m)

Used to set protected valuemapper (back)pointer.

[pure virtual] std::string TranslatorChannelBase::StringValue() const

[pure virtual] std::string TranslatorChannelBase::Type() const

T TranslatorChannelBase::Value() const

The content of this document is confidential information not to be published without the consent of CDP Technologies AS.

CDP Technologies AS, www.cdpstudio.com

Get started with CDP Studio today

Let us help you take your great ideas and turn them into the products your customer will love.

Try CDP Studio for free
Why CDP Studio?

CDP Technologies AS
Hundsværgata 8,
P.O. Box 144
6001 Ålesund, Norway

Tel: +47 990 80 900
E-mail: info@cdptech.com

Company

About CDP

Contact us

Services

Partners

Blog

Developers

Get started

User manuals

Support

Document download

Release notes

Follow CDP

  • LinkedIn
  • YouTube
  • GitHub

    © Copyright 2022 CDP Technologies. Privacy and cookie policy.

    Return to top