openDAQ
Open data acquisition platform
ChannelPtr Class Reference

Channels represent physical sensors of openDAQ devices. Internally they are standard function blocks with an additional option to provide a list of tags. More...

+ Inheritance diagram for ChannelPtr:
+ Collaboration diagram for ChannelPtr:

Detailed Description

Channels represent physical sensors of openDAQ devices. Internally they are standard function blocks with an additional option to provide a list of tags.

Additional Inherited Members

- Public Member Functions inherited from GenericFunctionBlockPtr< IChannel >
daq::FunctionBlockTypePtr getFunctionBlockType () const
 Gets an information structure contain metadata of the function block type. More...
 
daq::ListPtr< daq::IInputPort > getInputPorts (const daq::SearchFilterPtr &searchFilter=nullptr) const
 Gets a list of the function block's input ports. More...
 
daq::ListPtr< daq::ISignal > getSignals (const daq::SearchFilterPtr &searchFilter=nullptr) const
 Gets the list of the function block's output signals. More...
 
daq::ListPtr< daq::ISignal > getSignalsRecursive (const daq::SearchFilterPtr &searchFilter=nullptr) const
 Gets the list of the function block's visible output signals including signals from visible child function blocks. More...
 
daq::SignalPtr getStatusSignal () const
 Gets the function block's status signal. More...
 
daq::ListPtr< daq::IFunctionBlock > getFunctionBlocks (const daq::SearchFilterPtr &searchFilter=nullptr) const
 Gets a list of sub-function blocks. More...
 
daq::DictPtr< daq::IString, daq::IFunctionBlockType > getAvailableFunctionBlockTypes () const
 Gets all nested function block types that are supported, containing their description. More...
 
daq::FunctionBlockPtr addFunctionBlock (const daq::StringPtr &typeId, const daq::PropertyObjectPtr &config=nullptr) const
 Creates and adds a function block as the nested of current function block with the provided unique ID and returns it. More...
 
void removeFunctionBlock (const daq::FunctionBlockPtr &functionBlock) const
 Removes the function block provided as argument, disconnecting its signals and input ports. More...
 
- Public Member Functions inherited from GenericFolderPtr< InterfaceType >
daq::ListPtr< daq::IComponent > getItems (const daq::SearchFilterPtr &searchFilter=nullptr) const
 Gets the list of the items in the folder. More...
 
daq::Bool isEmpty () const
 Returns True if the folder is empty. More...
 
daq::Bool hasItem (const daq::StringPtr &localId) const
 Returns True if the folder has an item with local ID. More...
 
daq::GenericComponentPtr< daq::IComponent > getItem (const daq::StringPtr &localId) const
 Gets the item component with the specified localId. More...
 
- Public Member Functions inherited from GenericComponentPtr< InterfaceType >
daq::StringPtr getLocalId () const
 Gets the local ID of the component. More...
 
daq::StringPtr getGlobalId () const
 Gets the global ID of the component. More...
 
daq::Bool getActive () const
 Returns true if the component is active; false otherwise. More...
 
void setActive (daq::Bool active) const
 Sets the component to be either active or inactive. Also recursively sets the active field of all child components if component is a folder. More...
 
daq::ContextPtr getContext () const
 Gets the context object. More...
 
daq::ComponentPtr getParent () const
 Gets the parent of the component. More...
 
daq::StringPtr getName () const
 Gets the name of the component. More...
 
void setName (const daq::StringPtr &name) const
 Sets the name of the component. More...
 
daq::StringPtr getDescription () const
 Gets the description of the component. More...
 
void setDescription (const daq::StringPtr &description) const
 Sets the description of the component. More...
 
daq::TagsPtr getTags () const
 Gets the tags of the component. More...
 
daq::Bool getVisible () const
 Gets visible metadata state of the component. More...
 
void setVisible (daq::Bool visible) const
 Sets visible attribute state of the component. More...
 
daq::ListPtr< daq::IString > getLockedAttributes () const
 Gets a list of the component's locked attributes. The locked attributes cannot be modified via their respective setters. More...
 
daq::Event< daq::ComponentPtr, daq::CoreEventArgsPtr > getOnComponentCoreEvent () const
 Gets the Core Event object that triggers whenever a change to this component happens within the openDAQ core structure. More...
 
daq::ComponentStatusContainerPtr getStatusContainer () const
 Gets the container of Component statuses. More...
 
daq::ComponentPtr findComponent (const daq::StringPtr &id) const
 Finds the component (signal/device/function block) with the specified (global) id. More...
 
daq::OperationModeType getOperationMode () const
 Gets the operation mode of the device. More...
 
- Public Member Functions inherited from GenericPropertyObjectPtr< InterfaceType >
daq::StringPtr getClassName () const
 Gets the name of the class the Property object was constructed with. More...
 
void setPropertyValue (const daq::StringPtr &propertyName, const daq::BaseObjectPtr &value) const
 Sets the value of the Property with the given name. More...
 
daq::BaseObjectPtr getPropertyValue (const daq::StringPtr &propertyName) const
 Gets the value of the Property with the given name. More...
 
daq::BaseObjectPtr getPropertySelectionValue (const daq::StringPtr &propertyName) const
 Gets the selected value of the Property, if the Property is a Selection property. More...
 
void clearPropertyValue (const daq::StringPtr &propertyName) const
 Clears the Property value from the Property object. More...
 
daq::Bool hasProperty (const daq::StringPtr &propertyName) const
 Checks if the Property object contains a property named propertyName. More...
 
daq::PropertyPtr getProperty (const daq::StringPtr &propertyName) const
 Gets the Property with the given propertyName. More...
 
void addProperty (const daq::PropertyPtr &property) const
 Adds the property to the Property object. More...
 
void removeProperty (const daq::StringPtr &propertyName) const
 Removes the Property named propertyName from the Property object. More...
 
daq::Event< daq::PropertyObjectPtr, daq::PropertyValueEventArgsPtr > getOnPropertyValueWrite (const daq::StringPtr &propertyName) const
 Gets the Event that is triggered whenever a Property value is written to the Property named propertyName. More...
 
daq::Event< daq::PropertyObjectPtr, daq::PropertyValueEventArgsPtr > getOnPropertyValueRead (const daq::StringPtr &propertyName) const
 Gets the Event that is triggered whenever a Property value of a Property named propertyName is read. More...
 
daq::Event< daq::PropertyObjectPtr, daq::PropertyValueEventArgsPtr > getOnAnyPropertyValueWrite () const
 Gets the Event that is triggered whenever any Property value is written. The event is triggered after the specific Property event. More...
 
daq::Event< daq::PropertyObjectPtr, daq::PropertyValueEventArgsPtr > getOnAnyPropertyValueRead () const
 Gets the Event that is triggered whenever any Property value is read.The event is triggered after the specific Property event. More...
 
daq::ListPtr< daq::IProperty > getVisibleProperties () const
 Returns a list of visible properties contained in the Property object. More...
 
daq::ListPtr< daq::IProperty > getAllProperties () const
 Returns a list of all properties contained in the Property object. More...
 
void setPropertyOrder (const daq::ListPtr< daq::IString > &orderedPropertyNames) const
 Sets a custom order of properties as defined in the list of property names. More...
 
void beginUpdate () const
 Begins batch configuration of the object. More...
 
void endUpdate () const
 Ends batch configuration of the object. More...
 
daq::Bool getUpdating () const
 Returns the state of batch configuration. More...
 
daq::Event< daq::PropertyObjectPtr, daq::EndUpdateEventArgsPtr > getOnEndUpdate () const
 Gets the Event that is triggered whenever the batch configuration is applied. More...
 
daq::PermissionManagerPtr getPermissionManager () const
 Gets the permission manager of property object. More...