<SomeName>TheValue</SomeName>

SomeName="TheValue"

Member Function Documentation

CDPPropertyBase::CDPPropertyBase()

CDPPropertyBase::CDPPropertyBase Base constructor

[pure virtual] void CDPPropertyBase::AddListener(CDPPropertyBase *pProperty)

Adds pProperty as a listener to this property

[pure virtual] void CDPPropertyBase::AddListenersToSyncInOnce()

Adds this property's listeners to their respective parent components list of properties to be synced in once (Typically for event-driven properties)

[static] void CDPPropertyBase::AddToDataGroup(CDPPropertyBase *property, uint64_t groupId)

Adds property to group. Values of all properties within same group are propagated to remote applications within same data packet. This guarantees data consistency. The groupId must be unique and first 32 bits of it must be zero (they are reserved for internal CDP use).

See also RemoveFromDataGroup() and GetDataGroup().

[pure virtual] void CDPPropertyBase::AddToSyncIn()

Adds this property to the SyncIn list in the parent component, so that for each component run, this property internal value is updated before the run.

[pure virtual] void CDPPropertyBase::AddToSyncInOnce()

Adds this property to parent components list of properties to be synced in once (Typically for event-driven properties)

[pure virtual] void CDPPropertyBase::AddToSyncOut()

Adds this property to SyncOut list in the parent component, so that for each component run, this property external value is updated after the run.

[pure virtual] void CDPPropertyBase::AddToSyncOutOnce()

Adds this property to parent components list of properties to be synced out once (Typically for event-driven properties)

[static] void CDPPropertyBase::AddValuesToList(const std::string &strValue, StringList &listInOut)

Assuming strValue is a string or a semicolon separated list of strings, put each string into listInOut.

[pure virtual] void CDPPropertyBase::ClearRoutedProperty()

Clears the pointer to the Property to read values from (if routed)

[pure virtual] void CDPPropertyBase::ClockIn()

Copies securely from the external side to the internal side of the object

[pure virtual] void CDPPropertyBase::ClockOut()

Copies securely from the internal side to the external side of the object

[pure virtual] void CDPPropertyBase::Configure(XMLPrimitive *pXMLPrimitive)

Reads its configuration an XMLPrimitive.

[pure virtual] void CDPPropertyBase::Connect(std::string propertyRouting)

Connects this property to another named property, so that this property will read its value from that other property.

[pure virtual] void CDPPropertyBase::ConnectToProperty(CDPPropertyBase *pProperty)

Connects this property to the property supplied so that when this property is read, the other property is also read

[pure virtual] void CDPPropertyBase::Create(const char *pzName, CDP::StudioAPI::ICDPNode *pOwner, CDPPropertyBase::PropertyType_e ePropertyType = CDPPropertyBase::e_Attribute, CDPOBJECT_SETPROPERTY_HANDLER setPropertyHandler = nullptr, CDPOBJECT_VALIDATEPROPERTY_HANDLER validatePropertyHandler = nullptr)

Creates the property and bind it to an object. pzName is the name of the property, pOwner is the CDPObject that the property resides in, ePropertyType can be e_Element or e_Attribute.

Optionally, the SetProperty callback and ValidateProperty callback can be set here.

See also RegisterSetCallback() and RegisterValidateCallback().

[pure virtual] void CDPPropertyBase::Create(XMLPrimitive *pXMLOwner, CDP::StudioAPI::ICDPNode *pOwner)

[static] CDPPropertyBase *CDPPropertyBase::CreateProperty(CDPPropertyBase::PropertyInternalType_e ePropType)

Create a property of a given type (enum) Supported types: see PropertyInternalType_e

[static] CDPPropertyBase *CDPPropertyBase::CreateProperty(const std::string &strType)

CDPPropertyBase::CreateProperty Create a property given strType, f.i. "short" or "string" Supported types: 'bool', 'char', 'unsigned char', 'short', 'unsigned short', 'int', 'unsigned int', 'float', 'int64_t', 'uint64_t', 'double', 'string' Returns the created CDPProperty

[static] CDPPropertyBase *CDPPropertyBase::CreateProxyProperty(CDPPropertyBase *pPropertySrc, CDPBaseObject *pOwner, bool bRoutePeriodic = false)

Create a local recipient for propertychange messages, so they are set in the proxy property and clocked out. The locally connected property will then get the value clocked in next time it is run.

Set bRoutePeriodic = true to get automatic sync handling (always sync). Should be false for eventbased properties. Returns a CDPProperty (proxy) that must be deleted by the caller.

To use a proxy property: 1. Create the proxyproperty by calling PropertyFactory::CreateProxyProperty(pOriginalProperty, this, bRoutePeriodic); 2. update the proxyproperty by calling SetValue or use operators to update internal value. 3. call AddToSyncOutOnce(); or AddToSyncOut() for the proxyproperty 4. Call SetDeleteOnDisconnect() on the proxyproperty if you want it to be automatically deleted when the property it listens to is disconnected.

[pure virtual] void CDPPropertyBase::Destroy()

Disconnects and Destroy the property

[pure virtual] void CDPPropertyBase::Disconnect()

Disconnects this property routing so that GetRouting() returns "".

[pure virtual] void CDPPropertyBase::DisconnectAllListeners()

Disconnects all listeners from this property.

[pure virtual] void CDPPropertyBase::DisconnectBackend(bool removeFromRoutedPropertyListener = true)

Disconnects the property from the backend. If removeFromRoutedPropertyListener is true, this property will be removed from the listeners list of the property, of whom which this property may get routed values from.

[static] uint64_t CDPPropertyBase::GetDataGroup(CDPPropertyBase *property)

Returns the data group of given property.

See also AddToDataGroup().

[pure virtual] bool CDPPropertyBase::GetDoSaveOnChange() const

Returns true if Save on change is enabled

T CDPPropertyBase::GetExternalValue()

Gets the external value. This is clocked out to the nodes which route from this property.

[pure virtual protected] std::string CDPPropertyBase::GetExternalValueString() const

[pure virtual] const char *CDPPropertyBase::GetFullName() const

Returns the full name of this property

[pure virtual] unsigned int CDPPropertyBase::GetInternalSize() const

Returns the internal type size of the property, the size is returned in bytes.

[pure virtual] PropertyInternalType_e CDPPropertyBase::GetInternalType() const

Returns the internal representation of the property.

[virtual] const char *CDPPropertyBase::GetInternalTypeName() const

Return the internal representation of the property, see enumerations in PropertyInternalType_e for types returned.

[pure virtual] double CDPPropertyBase::GetInternalValue() const

Returns the internal value as a double

[pure virtual] uint64_t CDPPropertyBase::GetInternalValueUInt64() const

Returns the internal value as an uint64_t

[pure virtual] std::string CDPPropertyBase::GetKeepLastValueOnDisconnect() const

Returns value of KeepLastValueOnDisconnect. Selection="Default;0;1". If set to "Default" (or left empty), then the global setting from YourAppName.CDP.MessengerIOServer component is used. If set to "1", then the property will keep the last known value when the routing is lost, otherwise the property value is set to 0 on disconnect.

[pure virtual] bool CDPPropertyBase::GetLogEventOnChange() const

Returns true if Log Event on change is enabled

[pure virtual] const char *CDPPropertyBase::GetName() const

Returns the Name of this CDPProperty

[pure virtual] CDPBaseObject *CDPPropertyBase::GetOwner() const

Gets the owner of this object

[pure virtual] CDPObject *CDPPropertyBase::GetParent() const

Returns the parent object for this property.

[pure virtual] CDPComponent *CDPPropertyBase::GetParentComponent() const

Returns the CDPComponent that handles this property

Useful for things like:

property->GetParentComponent()->RunInComponentThread([=] { *property = 123; });

[pure virtual] const PropertyListeners &CDPPropertyBase::GetPropertyListeners() const

Returns a const list of properties that listen to this property

[pure virtual] RouteMethod_e CDPPropertyBase::GetRouteMethod() const

Gets the routingtype for this property when routed: e_RoutePeriodic or e_RouteEvent

See also RouteMethod_e.

[pure virtual] CDPPropertyBase *CDPPropertyBase::GetRoutedProperty()

Returns a pointer to the routed property

[pure virtual] const char *CDPPropertyBase::GetRouting() const

Returns the routing for this property, or "" if no routing is set

[pure virtual] RoutingStatus_e CDPPropertyBase::GetRoutingStatus() const

Returns the CDPPropertyBase::RoutingStatus_e for this CDPProperty

[static] const std::string &CDPPropertyBase::GetRoutingStatusString(RoutingStatus_e status)

Converts enum RoutingStatus_e value to printable string value.

[pure virtual] int CDPPropertyBase::GetSyncGroupId() const

Returns the SyncGroupId that this property belongs to

[pure virtual] std::string CDPPropertyBase::GetValue() const

Gets property Value as a string

[pure virtual] XMLPrimitive *CDPPropertyBase::GetXMLOwner()

Returns the XML primitive holding the XML for this property

[pure virtual] void CDPPropertyBase::HandleKeepLastValueOnDisconnect()

This property's value will be set to 0/"", or kept unchanged, depending on value of KeepLastValueOnDisconnect: If property's model has KeepLastValueOnDisconnect set to "0" or "1", this value will be used. If value is "Default" or not set, MessengerIOServer's value of KeepLastValueOnDisconnect will decide.

[pure virtual] void CDPPropertyBase::InvalidateListener(CDPPropertyBase *pProperty)

Notifies that listener pProperty will be deleted and is no longer safe to access.

Similar to RemoveListener but it is safe to call InvalidateListener from another thread.

[pure virtual] bool CDPPropertyBase::IsAutoCreated() const

Returns true if this object will be automatically deallocated (deleted), false if not

[pure virtual] bool CDPPropertyBase::IsConnected() const

Returns true if routing is connected, false if not

[pure virtual] bool CDPPropertyBase::IsDestroyed() const

Returns true if Destroy() has been called.

The property must not be used after it is destroyed. Calling Create() again will reset the property.

bool CDPPropertyBase::IsExternalValueValid() const

[virtual] bool CDPPropertyBase::IsLocalProperty()

CDPPropertyBase::IsLocalProperty Returns true if is routed to local application

[pure virtual] bool CDPPropertyBase::IsNumeric() const

Returns true if internal type is a numeric type (i.e. not a string)

bool CDPPropertyBase::IsProxyProperty() const

Returns true if the property is a local recipient for propertychange messages.

See also CreateProxyProperty.

[pure virtual] bool CDPPropertyBase::IsString() const

Returns true if internal type is string

[pure virtual] void CDPPropertyBase::RegisterRoutingChangeCallback(CDPOBJECT_SETPROPERTY_HANDLER handler)

Registers a callback function to call whenever the routingstatus on a property changes.

[pure virtual] void CDPPropertyBase::RegisterSetCallback(CDPOBJECT_SETPROPERTY_HANDLER handler)

Registers a callback function to call after a property change (set) is done.

[pure virtual] void CDPPropertyBase::RegisterValidateCallback(CDPOBJECT_VALIDATEPROPERTY_HANDLER handler)

Registers a callback function to call when Set is called, before the property is actually set.

[static] void CDPPropertyBase::RemoveFromDataGroup(CDPPropertyBase *property)

Removes property from data group.

See also AddToDataGroup().

[pure virtual] void CDPPropertyBase::RemoveListener(CDPPropertyBase *pProperty)

Removes pProperty from listeners to this property.

See also InvalidateListener.

[pure virtual] void CDPPropertyBase::RemoveListenerIfNotListening()

Goes through listeners and remove the first listener that does not have a routed property set.

[pure virtual] void CDPPropertyBase::SetAutoCreated()

Sets that this object is auto-created and should be automatically deallocated (deleted).

[virtual] void CDPPropertyBase::SetDeleteOnDisconnect()

Set whether this property should delete on disconnect or not

[pure virtual] void CDPPropertyBase::SetDoSaveOnChange(bool bSave)

Call this function to enable or disable saving of the property when it changes.

void CDPPropertyBase::SetExternalValueValid(bool available)

[pure virtual] void CDPPropertyBase::SetKeepLastValueOnDisconnect(const std::string &klvalue)

Call this function to set the value of KeepLastValueOnDisconnect.

[pure virtual] void CDPPropertyBase::SetLogEventOnChange(bool bLogEvent)

Call this function to enable or disable event logging on property change

[pure virtual] void CDPPropertyBase::SetName(const char *propertyName)

Sets the Name of this CDPProperty

[pure virtual] void CDPPropertyBase::SetOwner(CDPBaseObject *pBase)

Sets the owner of this object

[pure virtual] void CDPPropertyBase::SetPropertyChangeHandler(const std::function<void( CDPPropertyBase * ) > &handler)

Sets a callback std::function to call after a property change (set) is done.

[pure virtual] bool CDPPropertyBase::SetPropertySetting(std::string strPropertySetting, std::string strValue)

Sets a behavior on a property. The following PropertySettings can be set:

Returns true if PropertySetting was handled, false if not.

[pure virtual] void CDPPropertyBase::SetPropertyValidateHandler(const std::function<bool( CDP::StudioAPI::CDPVariantValue &, CDPPropertyBase * ) > &)

void CDPPropertyBase::SetProxyProperty()

Marks that the property is a local recipient for propertychange messages.

See also CreateProxyProperty.

[pure virtual] void CDPPropertyBase::SetRouteMethod(RouteMethod_e eType)

Sets the routingtype to either e_RoutePeriodic or e_RouteEvent

[pure virtual] void CDPPropertyBase::SetRoutingStatus(RoutingStatus_e newStatus)

Sets the routing status for this property

[pure virtual] void CDPPropertyBase::SetValue(const std::string &propertyValue)

Sets property Value (m_ValueInternal) from propertyValue

[pure virtual] void CDPPropertyBase::SetValueDontSave(const char *propertyValue)

[pure virtual] void CDPPropertyBase::SetXMLOwner(XMLPrimitive *pPrim)

Set the pPrim that this CDPProperty should configure itself from.

[virtual] bool CDPPropertyBase::ShouldDeleteOnDisconnect() const

Return whether this property should delete on disconnect or not

[pure virtual] const char *CDPPropertyBase::c_str() const

Returns property value as a 'const char*' (std::string compatibility function).

CDPPropertyBase::operator bool() const

Returns GetInternalValue()!=0.0

CDPPropertyBase::operator char() const

Returns GetInternalValue()

CDPPropertyBase::operator double() const

Returns GetInternalValue()

CDPPropertyBase::operator float() const

Returns GetInternalValue()

CDPPropertyBase::operator int() const

Returns GetInternalValue()

CDPPropertyBase::operator int64_t() const

Returns GetInternalValueUInt64() casted to int64_t

CDPPropertyBase::operator short() const

Returns GetInternalValue()

CDPPropertyBase::operator std::string() const

CDPPropertyBase::operator uint64_t() const

Returns GetInternalValueUInt64()

CDPPropertyBase::operator unsigned char() const

Returns GetInternalValue()

CDPPropertyBase::operator unsigned int() const

Returns GetInternalValue()

CDPPropertyBase::operator unsigned short() const

Returns GetInternalValue()

[pure virtual] CDPPropertyBase &CDPPropertyBase::operator=(CDPPropertyBase const &rhs)

Copy-assignment operator.

[pure virtual] CDPPropertyBase &CDPPropertyBase::operator=(const double &)

Assigns the value from a double value

[pure virtual] CDPPropertyBase &CDPPropertyBase::operator=(const float)

Assigns the value from a float value

[pure virtual] CDPPropertyBase &CDPPropertyBase::operator=(const uint64_t &)

Assigns the value from a uint64_t value

[pure virtual] CDPPropertyBase &CDPPropertyBase::operator=(const int64_t &)

Assigns the value from an int64_t value

[pure virtual] CDPPropertyBase &CDPPropertyBase::operator=(const unsigned int)

Assigns the value from an unsigned int value

[pure virtual] CDPPropertyBase &CDPPropertyBase::operator=(const int)

Assigns the value from an int value

[pure virtual] CDPPropertyBase &CDPPropertyBase::operator=(const unsigned short)

Assigns the value from an unsigned short value

[pure virtual] CDPPropertyBase &CDPPropertyBase::operator=(const short)

Assigns the value from a short value

[pure virtual] CDPPropertyBase &CDPPropertyBase::operator=(const unsigned char)

Assigns the value from an unsigned char value

[pure virtual] CDPPropertyBase &CDPPropertyBase::operator=(const char)

Assigns the value from a char value

[pure virtual] CDPPropertyBase &CDPPropertyBase::operator=(const bool)

Assigns the value from a bool value

[pure virtual] CDPPropertyBase &CDPPropertyBase::operator=(const std::string &)

[pure virtual] CDPPropertyBase &CDPPropertyBase::operator=(const char *)