• 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
  • TranslatorChannelGroup
  • 4.11.3

TranslatorChannelGroup Class

(ServerIO::Translator::TranslatorChannelGroup)

TranslatorChannelGroup abstract class represents TranslatorChannel channel-tree used by Translators for translating channel values to/from streams. Eash TranslatorChannelGroup is actually a subtree by holding: a) vector of TranslatorChannels and b) vector of subrees (TranslatorChannelGroups) Inherited class must implement OwnerName() and GetDebugLevel(). More...

Header: #include <IO/ServerIO/Translator/TranslatorChannelGroup.h>
Inherits: CDP::StudioAPI::CDPNode
  • List of all members, including inherited members

Public Functions

~TranslatorChannelGroup()
void AddChildChannel(TranslatorChannelBase *c)
void AddChildGroup(TranslatorChannelGroup *c)
const std::vector<TranslatorChannelBase *> &ChildChannels() const
const std::vector<TranslatorChannelGroup *> &ChildGroups() const
void Configure(XMLElementEx *element, CDP::StudioAPI::CDPNode *parentnode, TranslatorChannelGroup *parentGroup)
bool Empty() const
virtual int GetDebugLevel() const = 0
std::string Model() const
std::string Name() const
virtual std::string OwnerName() const = 0
std::string ParentTreePath(bool excludeRootName = false) const
void SetOnChangeValidators(ServerIO::ISendTrigger *sendTo)
unsigned TreeLevel() const
  • 26 public functions inherited from CDP::StudioAPI::CDPNode
  • 22 public functions inherited from CDP::StudioAPI::ICDPNode

Static Public Members

void AddChannelTreeToFormatter(const TranslatorChannelGroup &channelTree, FORMATTERTYPE &formatter)
void SetMatchedValuesInChannelTree(const TranslatorChannelGroup &channelTree, const MATCHARRAYTYPE &matchArray, size_t *channel_nr)

Reimplemented Protected Functions

virtual void FillNodeChildren(CDP::StudioAPI::NodeStream &stream) const override
virtual const std::string GetNodeName() const override
virtual std::string GetNodeTypeName() const override
  • 1 protected function inherited from CDP::StudioAPI::CDPNode

Detailed Description

TranslatorChannelGroup abstract class represents TranslatorChannel channel-tree used by Translators for translating channel values to/from streams. Eash TranslatorChannelGroup is actually a subtree by holding: a) vector of TranslatorChannels and b) vector of subrees (TranslatorChannelGroups) Inherited class must implement OwnerName() and GetDebugLevel().

See also ServerIO::Translator::TranslatorChannel.

Member Function Documentation

TranslatorChannelGroup::~TranslatorChannelGroup()

Destroys the instance of TranslatorChannelGroup.

[static] void TranslatorChannelGroup::AddChannelTreeToFormatter(const TranslatorChannelGroup &channelTree, FORMATTERTYPE &formatter)

void TranslatorChannelGroup::AddChildChannel(TranslatorChannelBase *c)

Adds channel to this channel group

void TranslatorChannelGroup::AddChildGroup(TranslatorChannelGroup *c)

Adds subgroup to this channel group

const std::vector<TranslatorChannelBase *> &TranslatorChannelGroup::ChildChannels() const

Returns vector of input (using <istream>) or output (using <ostream>) or both (using <iostream>) channels in current channel group.

const std::vector<TranslatorChannelGroup *> &TranslatorChannelGroup::ChildGroups() const

void TranslatorChannelGroup::Configure(XMLElementEx *element, CDP::StudioAPI::CDPNode *parentnode, TranslatorChannelGroup *parentGroup)

bool TranslatorChannelGroup::Empty() const

[override virtual protected] void TranslatorChannelGroup::FillNodeChildren(CDP::StudioAPI::NodeStream &stream) const

[pure virtual] int TranslatorChannelGroup::GetDebugLevel() const

[override virtual protected] const std::string TranslatorChannelGroup::GetNodeName() const

Reimplemented from ICDPNode::GetNodeName().

[override virtual protected] std::string TranslatorChannelGroup::GetNodeTypeName() const

Reimplemented from ICDPNode::GetNodeTypeName().

std::string TranslatorChannelGroup::Model() const

Returns node (group) name (thread-safely).

std::string TranslatorChannelGroup::Name() const

Returns node (group) name (thread-safely).

[pure virtual] std::string TranslatorChannelGroup::OwnerName() const

std::string TranslatorChannelGroup::ParentTreePath(bool excludeRootName = false) const

[static] void TranslatorChannelGroup::SetMatchedValuesInChannelTree(const TranslatorChannelGroup &channelTree, const MATCHARRAYTYPE &matchArray, size_t *channel_nr)

void TranslatorChannelGroup::SetOnChangeValidators(ServerIO::ISendTrigger *sendTo)

unsigned TranslatorChannelGroup::TreeLevel() 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