cim1.model

Class ConductingEquipment

java.lang.Object

cim1.model.CIMInstance

cim1.model.IdentifiedObject

cim1.model.Equipment

cim1.model.ConductingEquipment

Direct Known Subclasses:

BusbarSection, Conductor, EnergyConsumer, EquivalentEquipment, RegulatingCondEq, Switch, TransformerWinding

public class ConductingEquipment
extends Equipment

This file has been automatically generated by CIMGateway Description : This class "ConductingEquipment.java" represents the class ConductingEquipment extends Equipment + Terminals 0..-1 Terminal (inverseAssociation) + BaseVoltage 0..1 BaseVoltage

Field Summary

Fields

Modifier and Type	Field and Description
BaseVoltage	baseVoltage Attribute "baseVoltage" Comment from profile: Use association to ConductingEquipment only when there is no VoltageLevel container used.The profile requires a BaseVoltage associaton on ConductingEquipment subtypes of classes ACLineSegment and TransformerWinding.
java.lang.String	idBaseVoltage The id of the attribute "baseVoltage" This id is mainly used to resolve links after parsing an instance
java.util.List<Terminal>	terminals Attribute "terminals" Comment from profile: ConductingEquipment has 1 or 2 terminals that may be connected to other ConductingEquipment terminals via ConnectivityNodes

Fields inherited from class cim1.model.Equipment

equivalent, idMemberOf_EquipmentContainer, memberOf_EquipmentContainer

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	ConductingEquipment() Constructor of the class ConductingEquipment

Method Summary

Modifier and Type	Method and Description
void	addTerminals(Terminal terminalsValue, boolean setInverse) Utility to add a value within the "terminals" ArrayList of "Terminal"
boolean	baseVoltageIsSet() Utility to test if the value of "baseVoltage" has been set
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
ConductingEquipment	clone() Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances
void	copyBase(ConductingEquipment otherConductingEquipment) 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 ConductingEquipment	create(java.lang.String id) Factory of the class
BaseVoltage	getBaseVoltage() Utility to return the "baseVoltage"
java.util.List<Terminal>	getTerminals() Utility to return the "terminals" List of "Terminal" enum
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	setBaseVoltage(BaseVoltage baseVoltageValue, boolean setInverse) Utility to set the "baseVoltageValue"
boolean	terminalsIsSet() Utility to test if the value of "terminals" has been set
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.Equipment

copyBase, equivalentIsSet, getMemberOf_EquipmentContainer, isEquivalent, memberOf_EquipmentContainerIsSet, setEquivalent, setMemberOf_EquipmentContainer

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

terminals

public java.util.List<Terminal> terminals

Attribute "terminals" Comment from profile: ConductingEquipment has 1 or 2 terminals that may be connected to other ConductingEquipment terminals via ConnectivityNodes

baseVoltage

public BaseVoltage baseVoltage

Attribute "baseVoltage" Comment from profile: Use association to ConductingEquipment only when there is no VoltageLevel container used.The profile requires a BaseVoltage associaton on ConductingEquipment subtypes of classes ACLineSegment and TransformerWinding. The association is not used for any other subtypes.

idBaseVoltage

public java.lang.String idBaseVoltage

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

Constructor Detail

ConductingEquipment

protected ConductingEquipment()

Constructor of the class ConductingEquipment

Method Detail

getTerminals

public java.util.List<Terminal> getTerminals()

Utility to return the "terminals" List of "Terminal" enum

Returns:

the list of the attributes "terminals"

addTerminals

public void addTerminals(Terminal terminalsValue,
                         boolean setInverse)
                  throws LinkageException

Utility to add a value within the "terminals" ArrayList of "Terminal"

Parameters:

terminalsValue - value to add within the ArrayList

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

Throws:

LinkageException

terminalsIsSet

public boolean terminalsIsSet()

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

Returns:

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

getBaseVoltage

public BaseVoltage getBaseVoltage()

Utility to return the "baseVoltage"

Returns:

the value of the attribute "baseVoltage"

baseVoltageIsSet

public boolean baseVoltageIsSet()

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

Returns:

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

setBaseVoltage

public void setBaseVoltage(BaseVoltage baseVoltageValue,
                           boolean setInverse)
                    throws LinkageException

Utility to set the "baseVoltageValue"

Parameters:

baseVoltageValue - instance to set

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

Throws:

LinkageException

create

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

Factory of the class

Parameters:

id - id of the class ConductingEquipment 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 Equipment

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 Equipment

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 Equipment

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 Equipment

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 Equipment

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 Equipment

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 Equipment

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 Equipment

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(ConductingEquipment otherConductingEquipment)

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:

otherConductingEquipment - 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 Equipment

Parameters:

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

clone

public ConductingEquipment 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 Equipment

Returns:

a clone of this instance