5 Model ToC Previous Next

5.8 Alarm model ToC Previous Next

5.8.14 PlaceInService2 Method ToC Previous Next

The PlaceInService2 Method extends the PlaceInService Method, by adding an optional Comment. For other functionality see the PlaceInService Method definition.

Signature

PlaceInService2 (

[in] LocalizedText	Comment
);

The parameters are defined in Table 66.

Table 66 – PlaceInService2 Method parameters

Argument Description
Comment A localized text to be applied to the Condition.

If the Comment argument is NULL (both locale and text are empty) it will be ignored and any existing comments will remain unchanged. If the comment is to be reset, an empty text with a locale shall be provided.

Method result codes in Table 67 (defined in Call Service)

Table 67 – PlaceInService2 result codes

Result Code Description
Bad_MethodInvalid The MethodId provided does not correspond to the ObjectId provided. See 10000-4 for the general description of this result code.
Bad_NodeIdInvalid    Used to indicate that the specified ObjectId is not valid or that the Method was called on the AlarmConditionType Node.See 10000-4 for the general description of this result code.

Comments

The PlaceInService2 Method applies to an Alarm instance, even if it is not currently in the Active State.

Table 68 specifies the AddressSpace representation for the PlaceInService2 Method.

Table 68 – PlaceInService2 Method AddressSpace definition

Attribute Value
BrowseName PlaceInService2
References NodeClass BrowseName DataType TypeDefinition ModellingRule
HasProperty Variable InputArguments Argument[] PropertyType Mandatory
AlwaysGeneratesEvent ObjectType AuditConditionOutOfServiceEventType Defined in 5.10.12    
ConformanceUnits          
A & C Out Of Service2          

If Auditing is supported, this Method shall generate an Event of AuditConditionOutOfServiceEventType for all invocations of the Method.

Previous Next