cim1.model

Class IdentifiedObject

java.lang.Object

cim1.model.CIMInstance

cim1.model.IdentifiedObject

Direct Known Subclasses:

BaseVoltage, ConnectivityNodeContainer, ControlArea, Curve, Equipment, FossilFuel, GeographicalRegion, HydroPump, LoadResponseCharacteristic, MutualCoupling, OperationalLimit, OperationalLimitSet, OperationalLimitType, RegulatingControl, SubGeographicalRegion, TapChanger, Terminal, TopologicalIsland, TopologicalNode, VoltageControlZone

public class IdentifiedObject
extends CIMInstance

This file has been automatically generated by CIMGateway Description : This class "IdentifiedObject.java" represents the class IdentifiedObject : CIMInstance + description 0..1 String + aliasName 0..1 String + name 0..1 String

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	aliasName Attribute "aliasName" Comment from profile: The aliasName is free text human readable name of the object alternative to IdentifiedObject.name.
java.lang.String	description Attribute "description" Comment from profile: The description is a free human readable text describing or naming the object.
java.lang.String	name Attribute "name" Comment from profile: The name is a free text human readable name of the object.

Fields inherited from class cim1.model.CIMInstance

addedToUnresolved, fromBoundary, id, subset

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	aliasNameIsSet() Utility to test if the value of "aliasName" 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
IdentifiedObject	clone() Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances
void	copyBase(IdentifiedObject otherIdentifiedObject) 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 IdentifiedObject	create(java.lang.String id) Factory of the class
boolean	descriptionIsSet() Utility to test if the value of "description" has been set
java.lang.String	getAliasName() Utility to return the "aliasName" value
java.lang.String	getDescription() Utility to return the "description" value
java.lang.String	getName() Utility to return the "name" value
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
boolean	nameIsSet() Utility to test if the value of "name" has been set
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	setAliasName(java.lang.String aliasNameValue) Utility to set the "aliasName" value
void	setDescription(java.lang.String descriptionValue) Utility to set the "description" value
void	setName(java.lang.String nameValue) Utility to set the "name" value
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.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

description

public java.lang.String description

Attribute "description" Comment from profile: The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

aliasName

public java.lang.String aliasName

Attribute "aliasName" Comment from profile: The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.In the UCTE profile the aliasName is used to hold the EIC code. The code length is 16 characters. Not all CIM classes have an EIC code so the attribute is optional.

name

public java.lang.String name

Attribute "name" Comment from profile: The name is a free text human readable name of the object. It may be non unique and may not correlate to a naming hierarchy.This attribute is required on all instances in this Profile that inherit from IdentifiedObject except for the following Classes: 1) BaseVoltage; 2) Terminal; 3) TransformerWinding; 4) RatioTapChanger; 5) PhaseTapChanger; 6) OperationalLImitSet; 7) CurrentLimit; and, 8) VoltageLimit.

Constructor Detail

IdentifiedObject

protected IdentifiedObject()

Constructor of the class IdentifiedObject

Method Detail

getDescription

public java.lang.String getDescription()

Utility to return the "description" value

Returns:

the value of the attribute "description"

setDescription

public void setDescription(java.lang.String descriptionValue)

Utility to set the "description" value

Parameters:

descriptionValue - value to set

descriptionIsSet

public boolean descriptionIsSet()

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

Returns:

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

getAliasName

public java.lang.String getAliasName()

Utility to return the "aliasName" value

Returns:

the value of the attribute "aliasName"

setAliasName

public void setAliasName(java.lang.String aliasNameValue)

Utility to set the "aliasName" value

Parameters:

aliasNameValue - value to set

aliasNameIsSet

public boolean aliasNameIsSet()

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

Returns:

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

getName

public java.lang.String getName()

Utility to return the "name" value

Returns:

the value of the attribute "name"

setName

public void setName(java.lang.String nameValue)

Utility to set the "name" value

Parameters:

nameValue - value to set

nameIsSet

public boolean nameIsSet()

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

Returns:

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

create

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

Factory of the class

Parameters:

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

Specified by:

clearContent in class CIMInstance

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

Specified by:

readAttribute in class CIMInstance

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

Specified by:

readResource in class CIMInstance

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

Specified by:

write in class CIMInstance

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

Specified by:

write in class CIMInstance

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

Specified by:

resolveLinks in class CIMInstance

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

Specified by:

modelConsistency in class CIMInstance

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

Specified by:

modelConsistency in class CIMInstance

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(IdentifiedObject otherIdentifiedObject)

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:

otherIdentifiedObject - the instance to copy

clearAssociations

protected void clearAssociations(Subset subset)

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

Specified by:

clearAssociations in class CIMInstance

Parameters:

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

clone

public IdentifiedObject 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 java.lang.Object

Returns:

a clone of this instance