RegisterMessage(CM_OPEN,"Open","Open the valve.",(CDPOBJECT_MESSAGEHANDLER)&ClassName::MessageOpen, "ParamName");

RegisterMessage(CM_OPEN,"Open","Open the valve.", NULL, "ParamName");

RegisterMessage(CM_TEXTCOMMAND,"Open","Open the valve.",(CDPOBJECT_MESSAGEHANDLER)&ClassName::MessageOpen, "ParamName");

Member Function Documentation

CDPObject::CDPObject()

Default constructor. Resets all member variables to safe initial values. Overload to set custom members.

CDPObject::~CDPObject()

Default destructor.

[override virtual] void CDPObject::Activate()

Reimplemented from CDPBaseObject::Activate().

Activates message processing and process state machine for the object. Activates the object so it can receive messages and do processing. When this function is called, the member mutex of the CDPComponent (if this is not a CDPComponent: then the member mutex of the object owner) has already been locked. This function may be called from another thread, typically the main thread or the Application process thread, or from the correct CDPEngine scheduler.

[virtual] void CDPObject::ActivateIfWaitingForActivate()

Called to automatically activate components/objects after Configure().

• If ActivateWait is negative, the object will be activated as soon as possible.
• If Activate is >0, and IsReadyToActivate() returns true, activate the object (Activate-1.0) seconds after Application::Start().
• If Activate is 0, the object is suspended until it receives a CM_ACTIVATE message.

See also CDPEngine::RemoveActivateWait.

void CDPObject::AddProperty_DontSaveDontGenerateEvent(const char *pName, const std::string &strName)

Adds a property to the property database if it does not exist. SaveOnChange and LogEventOnChange is set to false if the property is found.

void CDPObject::AddToBaseObjectList(CDPBaseObject *pObj)

Adds pObj to m_listBaseObjects. Do not call this for CDPObject derived classes.

[protected] void CDPObject::ClearPropertyDataGroups(const std::string &basePath, const std::string &remote)

[protected] void CDPObject::ClearPropertyXMLPointers()

Clears all the XML pointers in all properties in the property database.

[virtual] void CDPObject::Configure(const char *xml)

Configures object from .xml configuration. Configure object instance from .xml description. Opens .xml file if src=".. is specified. If errors are detected, a disk alarm is set and this object (and owner component) becomes invalid.

[virtual] void CDPObject::Configure(XMLElementEx *pObjectElement)

Configures object instance from .xml description. Generates disk alarm and suspends the object if an error is encountered.

[override virtual] void CDPObject::Create(const char *shortName, CDPBaseObject *pParent)

Reimplemented from CDPBaseObject::Create().

Creates an object and connect it to the CDP system infrastructure.

[virtual] void CDPObject::Create(const char *shortName, CDPComponent *pParent)

Create an object and connect it to the CDP system infrastructure.

[override virtual protected] void CDPObject::CreateModel()

Reimplemented from CDPBaseObject::CreateModel().

Creates a model instance and registers messages to the object.

[virtual] void CDPObject::CreateXMLConfigurationFilename(std::string &src, const std::string shortName = "", const char *parentName = nullptr)

Creates .xml configuration file name from component name.

CDPProperty<std::string> &CDPObject::Description()

Returns textual description of this instance as specified by the Description attribute.

[override virtual] void CDPObject::Destroy()

Reimplemented from CDPBaseObject::Destroy().

Destroys the object and removes the object from CDP engine and model storage.

This method should reverse what whas done in Create().

Do pre-destructor stuff, like removing references to this object from lists in other objects.

It must be possible to call Destroy() several times without causing harm.

[virtual] void CDPObject::DontSaveXML()

Permanently prevent this object from being saved to XML. m_pXMLElement is unlinked from XMLParser, and the XMLParser will delete the element when destroyed.

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

Reimplemented from CDPNode::FillNodeChildren().

CDPBaseObject *CDPObject::GetBaseObject(const char *name) const

Returns a pointer to a CDPBaseObject* that is owned by this object, provided that the named CDPBaseObject is found in this object.

CDPComponent *CDPObject::GetCDPComponent()

Returns pointer to the CDPComponent of this object. If this object is actually a CDPComponent then it is simply cast, otherwise parent CDPComponent is returned.

[virtual protected] void CDPObject::GetComponentXML(XMLParser &parser, const char *xml)

Reads .xml file from src="" attribute found in xml into parser. If parser contains elements, this function will just call parser.CallCallback() and return. If parser contains no elements, the XMLConfigurationName will be created, and then the src file (if found) will be read into the parser. Upon error, the object will be suspended and a disk alarm will be set.

[override virtual] std::string CDPObject::GetNodeLongName() const

Reimplemented from ICDPNode::GetNodeLongName().

Returns the full name of the object, f.i. "MyApp.MyComp.MyObject".

See also ShortName().

[override virtual] CDP::StudioAPI::CDPNodeType CDPObject::GetNodeType() const

Reimplemented from ICDPNode::GetNodeType().

Returns CDP::StudioAPI::eCDP_OBJECT_NODE

[virtual] XMLPrimitive *CDPObject::GetObjectXMLLocation()

Returns a pointer to the XMLPrimitive for this object. For a component, the pointer to the <Component> element is returned, for an Alarm, a pointer to the <Alarm> element is returned, etc. May return nullptr if it can not determine object location.

CDPComponent *CDPObject::GetParent() const

Returns this CDPObject's parent pointer. The parent pointer is set to the parent CDPComponent (or derived) for CDPObject types after Create().

Note: For CDPComponent and derived classes the parent pointer is always set to 0.

[static] CDPObject *CDPObject::GetParentCDPObject(const char *name)

Returns the pointer to nearest CDPObject identified by name. Static method.

Example:

To check if a CDPObject* is also a CDPComponent*, use dynamic_cast

CDPComponent* pComponent = dynamic_cast<CDPComponent*>(GetParentCDPObject("Component.Subcomp.MyNode.MyProperty"));
if (pComponent)
  pComponent->AddSubcomponent(mySubComponent);  // Adds mySubComponent to CDPComponent named "Subcomp"

This function will temporarily lock the ObjectMap and find the object requested.

Returns a pointer to the nearest CDPObject derived parent in scope identified by 'name', or nullptr if not found. Also if a CDPObject derived parent is found, but the remaining part after the parent does not exist, a nullptr is returned.

[override virtual] std::string CDPObject::GetProperty(std::string propertyName)

Reimplemented from CDPBaseObject::GetProperty().

Handles ShortName, Name, FullName and Model specifically in addition to calling base.

[override virtual] CDPPropertyBase *CDPObject::GetPropertyObject(std::string propertyName) const

Reimplemented from CDPBaseObject::GetPropertyObject().

Will also search for propertyName in PropertyList of all CDPBaseObjects listed in m_listBaseObjects.

[virtual] const char *CDPObject::GetType()

Returns object type as a const char*, overloaded by extended classes

[virtual] XMLElementEx *CDPObject::GetXMLElement()

Gets the XML Element for this object (may be NULL for a CDPComponent)

[virtual] const XMLParser &CDPObject::GetXMLParser() const

Returns the const XML parser of the owner component

[virtual] XMLParser &CDPObject::GetXMLParser()

Returns the XML parser of the owner component

bool CDPObject::IsInitialized()

Returns true if Configure() has been run at least once.

[virtual] bool CDPObject::IsReadyToActivate()

Postpones object activation until the Application component is running. Override this function if your object needs to be activated before the Application component is running, or set the Activate property to a negative value.

[virtual] bool CDPObject::IsWaitingForActivate() const

Checks if an object is waiting to be activated.

Returns true if waiting to be activated:

• Must be suspended
• activateWait > 0.0 || activateWait < 0.0

[protected] int CDPObject::MessageConfirm(void *messageAck)

Acknowledge function, called to acknowledge that a destination has received a message when the message was sent with retryenabled.

[protected] int CDPObject::MessageSetValues(void *messageSetValues)

[protected] int CDPObject::MessageTimeout(void *messageAck)

Message timed out function, called to notify that a message acknowledge has timed out. This means that we don't know if the message was delivered, but we know that we did NOT receive an acknowledge for the message within the timeout.

const char *CDPObject::Name() const

Returns the full name of the object, f.i. "MyApp.MyComp.MyObject".

See also ShortName().

int CDPObject::ParentHandle() const

Returns this CDPObject's parent (CDPComponent-) handle.

Note: When called from a CDPComponent, ParentHandle() will always return 0.

std::string CDPObject::ParentName() const

Returns the name of the parent object

[static] CDPObject *CDPObject::Pointer(const char *fullName)

Returns the pointer to the object identified by fullName. Static method.

Example:

To check if a CDPObject* is also a CDPComponent*, use dynamic_cast

CDPComponent* pComponent = dynamic_cast<CDPComponent*>(Pointer("Component.Subcomp"));
if (pComponent)
  pComponent->AddSubcomponent(mySubComponent);  // Adds a subcomponent to pComponent

Returns a pointer to the CDPObject-derived object identified by fullName, or nullptr if not found.

void CDPObject::PropertyClearXMLPointer(CDPPropertyBase *pBase)

Callback-handler to clear the XMLOwner for all properties

[protected] void CDPObject::ReceiveEvent(Event *ev)

Called when events are received, or when an event receiver has subscribed to simple event notifictaions.

[override virtual] int CDPObject::ReceiveMessage(void *message)

Reimplemented from CDPBaseObject::ReceiveMessage().

Processes incoming message. Routes registered messages to registered message handlers. Returns 1 if message was processed, 0 if message was not handled.

[protected] void CDPObject::RemotePropertyChanged(unsigned int remoteHandle, std::string propertyName, std::string propertyValue)

Callback used by CDPComponent::Message(Extended)EventNotify() to notify that an event has occurred in an object that this objects has subscribed to.

void CDPObject::RemoveFromBaseObjectList(CDPBaseObject *pObj)

Removes pObj from m_listBaseObjects. Call this in Destroy() when you have called AddToBaseObjectList.

[static] std::string CDPObject::ResolveRelativeName(std::string &relativeName, CDPObject *owner, const char *componentName = nullptr)

[static] std::string CDPObject::ResolveRelativeName(std::string &relativeName, const std::string &ownerName, const char *componentName = nullptr)

Resolves relativeName into a full name, returning an std::string. '.' at relativeName start jumps down one level. Examples: Assuming This is a child of Application: '.Item' resolves to 'Application.This.Item' '..Item' resolves to 'Application.Item', and so on.

Also resolves relative to a component name if relative name starts with '$' and componentName specified.

Both the return-value and the first parameter relativeName will contain the resolved name.

[static] char *CDPObject::ResolveRelativeName(char *relativeName, CDPObject *owner, const char *componentName = nullptr)

Resolves relativeName to a full name, returning a char ptr.

Note: relativeName will be updated with the resolved name, and must be able to hold the full name. Array size for relativeName should be CDPOBJECT_MAX_FULLNAME_LENGTH.

Examples: Assuming This is a child of Application: '.Item' resolves to 'Application.This.Item' '..Item' resolves to 'Application.Item', and so on.

Also resolves relative to a component name if relative name starts with '$' and componentName specified.

Both the return-value and the first parameter relativeName will contain the resolved name.

[static] CDPObject *CDPObject::Root()

Returns the root node (pointer to the application object).

[protected] void CDPObject::SaveNonDefaultPropertyHandler(CDPPropertyBase *pProp)

[protected] void CDPObject::SetObjectSuspended()

[override virtual] void CDPObject::SetProperty(std::string propertyName, std::string propertyValue)

Reimplemented from CDPBaseObject::SetProperty().

Handles Activate, ActivateWait and Handle specifically, and calls CDPBaseObject::SetProperty for all other properties.

[protected] bool CDPObject::SetPropertyDataGroups(const std::string &basePath, const std::string &remote, const std::string &api, unsigned int origin)

[virtual protected] void CDPObject::SetPropertyHandler(CDPPropertyBase *pProp)

Callback-handler for properties that need special handling after they are set. Typically used when a change in a property requires other actions to be performed. When treating multiple properties in one callback, the property pointer pProp should be used to compare with the property in question:

if(pProp==&myProperty) { ... }

.

[protected] void CDPObject::SetValueConnection(const MessageConnectValueArgs &mcv)

[override virtual] const char *CDPObject::ShortName() const

Reimplemented from CDPBaseObject::ShortName().

Returns the "short" name of the object, f.i. "MyObject"

See also Name().

[override virtual] void CDPObject::Suspend()

Reimplemented from CDPBaseObject::Suspend().

Suspends the object. Message processing and state machine is stopped. Stop the periodic calling of Process() (if this is a CDPComponent) and also stop message processing for CDPObject derived types. The member mutex of the Component or owner object has already been locked when this function is called. This function will be called from the correct CDPEngine scheduler during runtime, or from the main task on shutdown.

[override virtual] void CDPObject::SuspendByException()

Reimplemented from CDPBaseObject::SuspendByException().

Suspends the object because of the unhandled C++ exception happened. Resulting the same state as by calling the Suspend() but this state will not be synced by redundancy.

[virtual protected] bool CDPObject::ValidatePropertyHandler(CDP::StudioAPI::CDPVariantValue &newValue, CDPPropertyBase *property)

Callback-handler to restrict property values to certain values.

[override virtual] void CDPObject::XMLParserCallback(XMLPrimitive *pPrim)

Callback that is called from the XMLParser for each XMLPrimitive in a successfully parsed configuration file.