PLCnext API Documentation 23.3.0.32
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Namespaces | Classes | Typedefs | Enumerations | Functions
Arp::Plc::Commons::Meta Namespace Reference

Namespace for the Meta component More...

Namespaces

namespace  TypeSystem
 Namespace for the type information of the Meta component
 

Classes

class  ArrayDimension
 Provide array information. More...
 
class  ArrayDimensions
 Provide array information. More...
 
class  ChangeDataInfoProvider
 Decorator for DataInfoProvider to set IsBackgroundDomain = true More...
 
class  ChildTypeInfo
 Provides detailed type information of a child within TypeBrowser interface. More...
 
class  CustomAttribute
 Container for individual attributes within the interface DataBrowser More...
 
class  DataInfo
 Provides detailed informations for the respective data object. More...
 
class  DataInfoProvider
 Provides information of component root variables More...
 
class  DataTag
 Includes kind as well as instance browse name. More...
 
class  DynamicPortsBuilder
 Provides the infrastructure for dynamic port provision More...
 
class  IChangeNavigator
 Enables switching of counterparts during download change More...
 
class  IDataInfoProvider
 Interface to provide information about component roots More...
 
class  IMetaComponent
 Interface for all components providing meta data More...
 
class  IMetaLibrary
 Interface for all libraries providing meta data More...
 
class  ITypeInfoProvider
 Interface to type information of a library More...
 
class  ITypeNavigator
 Provide type information More...
 
class  MetaComponentBase
 Base class for components providing meta data More...
 
class  MetaLibraryBase
 Base class for libraries providing meta data More...
 
class  StandardAttributes
 Collection of StandardAttribute flags More...
 
class  StructNavigator
 Navigates the children of a struct More...
 
class  TypeIdentifier
 Identifies a type descriptions More...
 
class  TypeInfo
 Provides detailed type information within TypeBrowser interface. More...
 
class  TypeInfoProvider
 Provides type information of one library More...
 

Typedefs

using CustomAttributes = std::vector< CustomAttribute >
 List of type attributes TypeAttribute.
 

Enumerations

enum class  ChildKind : uint8 {
  None = 0 , Instance = 1 , Static = 2 , Literal = 3 ,
  Default = 1
}
 Enumeration of the type of a child type More...
 
enum class  StandardAttribute : uint64 {
  None = 0 , Hidden = 1 , Input = 2 , Output = 4 ,
  ReadOnly = 8 , Retain = 16 , Opc = 32 , Ehmi = 64 ,
  ProfiCloud = 128 , Archive = 256 , Invisible = 512 , Assignable = 1024 ,
  Redundant = 2048
}
 Standard attributes to types More...
 

Functions

bool operator== (const ArrayDimension &lhs, const ArrayDimension &rhs)
 
bool operator!= (const ArrayDimension &lhs, const ArrayDimension &rhs)
 
bool operator< (const ArrayDimension &lhs, const ArrayDimension &rhs)
 
std::ostream & operator<< (std::ostream &os, const ArrayDimension &rhs)
 
bool operator== (const ArrayDimensions &lhs, const ArrayDimensions &rhs)
 
bool operator!= (const ArrayDimensions &lhs, const ArrayDimensions &rhs)
 
std::ostream & operator<< (std::ostream &os, const ArrayDimensions &rhs)
 
ARP_CXX_SYMBOL_EXPORT std::ostream & operator<< (std::ostream &os, ChildKind value)
 
ARP_CXX_SYMBOL_EXPORT std::istream & operator>> (std::istream &is, ChildKind &value)
 
constexpr StandardAttribute operator| (StandardAttribute lhs, StandardAttribute rhs)
 
constexpr StandardAttribute operator& (StandardAttribute lhs, StandardAttribute rhs)
 
StandardAttributeoperator|= (StandardAttribute &lhs, StandardAttribute rhs)
 
StandardAttributeoperator&= (StandardAttribute &lhs, StandardAttribute rhs)
 
constexpr StandardAttribute operator~ (StandardAttribute arg)
 
ARP_CXX_SYMBOL_EXPORT std::ostream & operator<< (std::ostream &os, StandardAttribute value)
 
ARP_CXX_SYMBOL_EXPORT std::istream & operator>> (std::istream &is, StandardAttribute &value)
 
std::ostream & operator<< (std::ostream &os, const TypeIdentifier &typeId)
 The ostream operator makes any object of this class or any derived class formattable or loggable, respectively. More...
 

Detailed Description

Namespace for the Meta component

Enumeration Type Documentation

◆ ChildKind

Enumeration of the type of a child type

Enumerator
None 

Not set.

Instance 

Instance member or field, respectively.

Static 

Static class member.

Literal 

Const member or literal, respectively.

Default 

The default is instance member or field, respectively.

◆ StandardAttribute

Standard attributes to types

These standard attributes are used to mark ports as inputs, outputs, retain, etc.

Enumerator
None 

The attribute value is not set.

Hidden 

The node is hidden, that is, it has just a technical purpose but no logical meaning and does not occur in any variable path.

Input 

The node is an input port.

Output 

The node is an output port.

ReadOnly 

The node is read only.

Retain 

The node shall be retained.

Opc 

The node is visible for OPC.

Ehmi 

The node is visible for eHmi.

ProfiCloud 

The node is visible for ProfiCloud.

Archive 

The node is set to archive.

Invisible 

Applicative attribute for PLCnext, to modify variables in the data list or similar.

Assignable 

Applicative attribute for PLCnext, to reinitialize pointer variables.

Redundant 

The node is visible for Redundancy.

Function Documentation

◆ operator<<()

std::ostream & Arp::Plc::Commons::Meta::operator<< ( std::ostream &  os,
const TypeIdentifier typeId 
)

The ostream operator makes any object of this class or any derived class formattable or loggable, respectively.

The implementation just calls the ToString operation of this class.