cim1.model

Class Equipment

java.lang.Object

cim1.model.CIMInstance

cim1.model.IdentifiedObject

cim1.model.Equipment

Direct Known Subclasses:

ConductingEquipment, GeneratingUnit, PowerTransformer

public class Equipment
extends IdentifiedObject

This file has been automatically generated by CIMGateway Description : This class "Equipment.java" represents the class Equipment extends IdentifiedObject + equivalent 0..1 boolean + MemberOf_EquipmentContainer 0..1 EquipmentContainer

Field Summary

Fields

Modifier and Type	Field and Description
boolean	equivalent Attribute "equivalent" Comment from profile: All classes derived from Equipment are to include this attribute except for the TransformerWinding class.
java.lang.String	idMemberOf_EquipmentContainer The id of the attribute "memberOf_EquipmentContainer" This id is mainly used to resolve links after parsing an instance
EquipmentContainer	memberOf_EquipmentContainer Attribute "memberOf_EquipmentContainer" Comment from profile:

Fields inherited from class cim1.model.IdentifiedObject

aliasName, description, name

Fields inherited from class cim1.model.CIMInstance

addedToUnresolved, fromBoundary, id, subset

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Equipment() Constructor of the class Equipment

Method Summary

Modifier and Type	Method and Description
protected void	clearAssociations(Subset subset) Utility to clear the associations of this class belonging to a specific subset
void	clearContent(Subset subset) Utility to "clear" the content of a class when a subset is invalidated
Equipment	clone() Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances
void	copyBase(Equipment otherEquipment) Utility to copy the "base" of an other instance of the same class This utility does not copy the associations with other instances from the instance to copy
static Equipment	create(java.lang.String id) Factory of the class
boolean	equivalentIsSet() Utility to test if the value of "equivalent" has been set
EquipmentContainer	getMemberOf_EquipmentContainer() Utility to return the "memberOf_EquipmentContainer"
boolean	isEquivalent() Utility to return the "equivalent" value
boolean	memberOf_EquipmentContainerIsSet() Utility to test if the value of "memberOf_EquipmentContainer" has been set
ConsistencyCheck	modelConsistency() Utility to check whether this class is consistent in a "merged" context
ConsistencyCheck	modelConsistency(Subset subset) Utility to check whether this class is consistent according to a subset
void	readAttribute(java.lang.String class_name, java.lang.String attr_name, java.lang.String value, CIMModel model) Utility to read an attribute This function is called by the CIMModel
void	readResource(java.lang.String class_name, java.lang.String resource_name, java.lang.String id, CIMModel model) Utility to read a reference to a resource This function is called by the CIMModel
void	resolveLinks(CIMModel model, CIMModel boundaryModel) Utility to resolve the links at the end of parsing
void	setEquivalent(boolean equivalentValue) Utility to set the "equivalent" value
void	setMemberOf_EquipmentContainer(EquipmentContainer memberOf_EquipmentContainerValue, boolean setInverse) Utility to set the "memberOf_EquipmentContainerValue"
void	write(javax.xml.stream.XMLStreamWriter xmlsw, boolean writeID) Utility to write the content into the CIM XML format
void	write(javax.xml.stream.XMLStreamWriter xmlsw, Subset subset, boolean writeID) Utility to write the content this class into the CIM/XML format according to a subset

Methods inherited from class cim1.model.IdentifiedObject

aliasNameIsSet, copyBase, descriptionIsSet, getAliasName, getDescription, getName, nameIsSet, setAliasName, setDescription, setName

Methods inherited from class cim1.model.CIMInstance

addToUnresolved, copyBase, getId, getSubset, isAddedToUnresolved, isFromBoundary, removeFromUnresolved, setFromBoundary, setId

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

equivalent

public boolean equivalent

Attribute "equivalent" Comment from profile: All classes derived from Equipment are to include this attribute except for the TransformerWinding class. For transformers the PowerTransformer class will be used to specify the real or equivalent status and the contained TransformerWinding class instances need not and should not specify this attribute.

memberOf_EquipmentContainer

public EquipmentContainer memberOf_EquipmentContainer

Attribute "memberOf_EquipmentContainer" Comment from profile:

idMemberOf_EquipmentContainer

public java.lang.String idMemberOf_EquipmentContainer

The id of the attribute "memberOf_EquipmentContainer" This id is mainly used to resolve links after parsing an instance

Constructor Detail

Equipment

protected Equipment()

Constructor of the class Equipment

Method Detail

isEquivalent

public boolean isEquivalent()

Utility to return the "equivalent" value

Returns:

the value of the attribute "equivalent"

setEquivalent

public void setEquivalent(boolean equivalentValue)

Utility to set the "equivalent" value

Parameters:

equivalentValue - value to set

equivalentIsSet

public boolean equivalentIsSet()

Utility to test if the value of "equivalent" has been set

Returns:

boolean if true the attribute "equivalent" is already set if false isn't yet

getMemberOf_EquipmentContainer

public EquipmentContainer getMemberOf_EquipmentContainer()

Utility to return the "memberOf_EquipmentContainer"

Returns:

the value of the attribute "memberOf_EquipmentContainer"

memberOf_EquipmentContainerIsSet

public boolean memberOf_EquipmentContainerIsSet()

Utility to test if the value of "memberOf_EquipmentContainer" has been set

Returns:

boolean if true the attribute "memberOf_EquipmentContainer" is already set if false it isn't yet

setMemberOf_EquipmentContainer

public void setMemberOf_EquipmentContainer(EquipmentContainer memberOf_EquipmentContainerValue,
                                           boolean setInverse)
                                    throws LinkageException

Utility to set the "memberOf_EquipmentContainerValue"

Parameters:

memberOf_EquipmentContainerValue - instance to set

setInverse - boolean to specify whether to set the inverse association or not

Throws:

LinkageException

create

public static Equipment create(java.lang.String id)

Factory of the class

Parameters:

id - id of the class Equipment to create

Returns:

the class created

clearContent

public void clearContent(Subset subset)

Utility to "clear" the content of a class when a subset is invalidated

Overrides:

clearContent in class IdentifiedObject

Parameters:

subset - subset to clean

readAttribute

public void readAttribute(java.lang.String class_name,
                          java.lang.String attr_name,
                          java.lang.String value,
                          CIMModel model)
                   throws InterpretationException

Utility to read an attribute This function is called by the CIMModel

Overrides:

readAttribute in class IdentifiedObject

Parameters:

class_name - the read name of class

attr_name - the read name of attribute

value - the read value of the attribute

model - the interface to the model this class belongs to

Throws:

InterpretationException

readResource

public void readResource(java.lang.String class_name,
                         java.lang.String resource_name,
                         java.lang.String id,
                         CIMModel model)
                  throws InterpretationException,
                         LinkageException

Utility to read a reference to a resource This function is called by the CIMModel

Overrides:

readResource in class IdentifiedObject

Parameters:

class_name - the read name of class

resource_name - the read name of the associated resource

id - the id of the associated resource

model - the model this class belongs to

Throws:

InterpretationException

LinkageException

write

public void write(javax.xml.stream.XMLStreamWriter xmlsw,
                  boolean writeID)

Utility to write the content into the CIM XML format

Overrides:

write in class IdentifiedObject

Parameters:

writeID - specifies whether to write the XML "id" attribute (this is used for describing concrete class)

xmlsw - XMLStreamWriter where are stored the elements to write

write

public void write(javax.xml.stream.XMLStreamWriter xmlsw,
                  Subset subset,
                  boolean writeID)

Utility to write the content this class into the CIM/XML format according to a subset

Overrides:

write in class IdentifiedObject

Parameters:

subset - the subset defining the context in which to write this class

writeID - specifies whether to write the XML "id" attribute (this is used for describing concrete class)

xmlsw - the stream in which are stored the elements to write

resolveLinks

public void resolveLinks(CIMModel model,
                         CIMModel boundaryModel)
                  throws LinkageException

Utility to resolve the links at the end of parsing

Overrides:

resolveLinks in class IdentifiedObject

Parameters:

model - the model this class belongs to

boundaryModel - the model that gather data about the boundarySet, used as a resource force links resolving

Throws:

Linkage - Exception

LinkageException

modelConsistency

public ConsistencyCheck modelConsistency(Subset subset)

Utility to check whether this class is consistent according to a subset

Overrides:

modelConsistency in class IdentifiedObject

Parameters:

subset - the subset defining the context in which to check whether this class is consistent

Returns:

a ConsistencyCheck instance whose boolean attribute (consistent) indicates if this class is consistent and whose String attribute (message) indicates why this class is not consistent if it is not

modelConsistency

public ConsistencyCheck modelConsistency()

Utility to check whether this class is consistent in a "merged" context

Overrides:

modelConsistency in class IdentifiedObject

Returns:

a ConsistencyCheck instance whose boolean attribute (consistent) indicates if this class is consistent and whose String attribute (message) indicates why this class is not consistent if it is not

copyBase

public void copyBase(Equipment otherEquipment)

Utility to copy the "base" of an other instance of the same class This utility does not copy the associations with other instances from the instance to copy

Parameters:

otherEquipment - the instance to copy

clearAssociations

protected void clearAssociations(Subset subset)

Utility to clear the associations of this class belonging to a specific subset

Overrides:

clearAssociations in class IdentifiedObject

Parameters:

subset - the subset from which to clear the associations of this class

clone

public Equipment clone()

Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances

Overrides:

clone in class IdentifiedObject

Returns:

a clone of this instance