ome-xml  5.6.0
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ome::xml::model::Dichroic Class Reference

Dichroic model object. More...

#include <ome/xml/model/Dichroic.h>

+ Inheritance diagram for ome::xml::model::Dichroic:
+ Collaboration diagram for ome::xml::model::Dichroic:

Classes

class  Impl
 Private implementation details of Dichroic model object. More...
 

Public Member Functions

 Dichroic ()
 Default constructor.
 
 Dichroic (const Dichroic &copy)
 Copy constructor. More...
 
virtual ~Dichroic ()
 Destructor.
 
const std::string & elementName () const
 Get the element name of this model object. More...
 
bool validElementName (const std::string &name) const
 Check if a given element name is valid for processing by this model object. More...
 
virtual SKIP void update (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
 Update the object hierarchy recursively from an XML DOM tree. More...
 
bool link (std::shared_ptr< Reference > &reference, std::shared_ptr< ome::xml::model::OMEModelObject > &object)
 Link a given OME model object to this model object. More...
 
const std::string & getID () const
 Get the ID property. More...
 
void setID (const std::string &id)
 Set the ID property. More...
 
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList () const
 Get size of linked Annotation list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList () const
 Get the linked Annotation list. More...
 
const std::weak_ptr< ome::xml::model::Annotation > & getLinkedAnnotation (OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index) const
 Get linked Annotation. More...
 
const std::weak_ptr< ome::xml::model::Annotation > & setLinkedAnnotation (OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Annotation > &annotation)
 Set linked Annotation. More...
 
bool linkAnnotation (const std::shared_ptr< ome::xml::model::Annotation > &annotation)
 Link Annotation. More...
 
bool unlinkAnnotation (const std::shared_ptr< ome::xml::model::Annotation > &annotation)
 Unlink Annotation. More...
 
std::weak_ptr< ome::xml::model::InstrumentgetInstrument ()
 Get the Instrument property. More...
 
const std::weak_ptr< ome::xml::model::InstrumentgetInstrument () const
 Get the Instrument property. More...
 
void setInstrument (std::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
 Set the Instrument property. More...
 
OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type::size_type sizeOfLinkedFilterSetList () const
 Get size of linked FilterSet list. More...
 
OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type getLinkedFilterSetList () const
 Get the linked FilterSet list. More...
 
const std::weak_ptr< ome::xml::model::FilterSet > & getLinkedFilterSet (OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type::size_type index) const
 Get linked FilterSet. More...
 
const std::weak_ptr< ome::xml::model::FilterSet > & setLinkedFilterSet (OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
 Set linked FilterSet. More...
 
bool linkFilterSet (const std::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
 Link FilterSet. More...
 
bool unlinkFilterSet (const std::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
 Unlink FilterSet. More...
 
OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type sizeOfLinkedLightPathList () const
 Get size of linked LightPath list. More...
 
OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type getLinkedLightPathList () const
 Get the linked LightPath list. More...
 
const std::weak_ptr< ome::xml::model::LightPath > & getLinkedLightPath (OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type index) const
 Get linked LightPath. More...
 
const std::weak_ptr< ome::xml::model::LightPath > & setLinkedLightPath (OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
 Set linked LightPath. More...
 
bool linkLightPath (const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
 Link LightPath. More...
 
bool unlinkLightPath (const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
 Unlink LightPath. More...
 
const std::string & getXMLNamespace () const
 Get the XML namespace for this model object. More...
 
- Public Member Functions inherited from ome::xml::model::ManufacturerSpec
 ManufacturerSpec ()
 Default constructor.
 
 ManufacturerSpec (const ManufacturerSpec &copy)
 Copy constructor. More...
 
virtual ~ManufacturerSpec ()
 Destructor.
 
bool validElementName (const std::string &name) const
 Check if a given element name is valid for processing by this model object. More...
 
bool link (std::shared_ptr< Reference > &reference, std::shared_ptr< ome::xml::model::OMEModelObject > &object)
 Link a given OME model object to this model object. More...
 
std::shared_ptr< std::string > getLotNumber ()
 Get the LotNumber property. More...
 
const std::shared_ptr< std::string > getLotNumber () const
 Get the LotNumber property. More...
 
void setLotNumber (std::shared_ptr< std::string > &lotNumber)
 Set the LotNumber property. More...
 
std::shared_ptr< std::string > getModel ()
 Get the Model property. More...
 
const std::shared_ptr< std::string > getModel () const
 Get the Model property. More...
 
void setModel (std::shared_ptr< std::string > &model)
 Set the Model property. More...
 
std::shared_ptr< std::string > getSerialNumber ()
 Get the SerialNumber property. More...
 
const std::shared_ptr< std::string > getSerialNumber () const
 Get the SerialNumber property. More...
 
void setSerialNumber (std::shared_ptr< std::string > &serialNumber)
 Set the SerialNumber property. More...
 
std::shared_ptr< std::string > getManufacturer ()
 Get the Manufacturer property. More...
 
const std::shared_ptr< std::string > getManufacturer () const
 Get the Manufacturer property. More...
 
void setManufacturer (std::shared_ptr< std::string > &manufacturer)
 Set the Manufacturer property. More...
 
const std::string & getXMLNamespace () const
 Get the XML namespace for this model object. More...
 
- Public Member Functions inherited from ome::xml::model::detail::OMEModelObject
virtual ~OMEModelObject ()
 Destructor.
 
virtual common::xml::dom::Element asXMLElement (common::xml::dom::Document &document) const
 Transform the object hierarchy rooted at this element to XML. More...
 
virtual void asXMLElement (common::xml::dom::Document &document, common::xml::dom::Element &element) const
 Transform the object hierarchy rooted at this element to XML. More...
 
virtual void update (const common::xml::dom::Element &element, ::ome::xml::model::OMEModel &model)
 Update the object hierarchy recursively from an XML DOM tree. More...
 
virtual bool link (std::shared_ptr< Reference > &reference, std::shared_ptr<::ome::xml::model::OMEModelObject > &object)
 Link a given OME model object to this model object. More...
 
- Public Member Functions inherited from ome::xml::model::OMEModelObject
virtual bool link (std::shared_ptr< Reference > &reference, std::shared_ptr< OMEModelObject > &object)=0
 Link a given OME model object to this model object. More...
 

Static Public Member Functions

static std::shared_ptr< Dichroiccreate (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
 Create a Dichroic model object from DOM element. More...
 
- Static Public Member Functions inherited from ome::xml::model::detail::OMEModelObject
static std::vector< common::xml::dom::ElementgetChildrenByTagName (const common::xml::dom::Element &parent, const std::string &name)
 Retrieve all the children of an element that have a given tag name. More...
 
static std::string stripNamespacePrefix (const std::string &value)
 Strip the namespace prefix from a tag name. More...
 

Protected Member Functions

virtual void asXMLElementInternal (common::xml::dom::Document &document, common::xml::dom::Element &element) const
 Transform the object hierarchy rooted at this element to XML. More...
 
- Protected Member Functions inherited from ome::xml::model::detail::OMEModelObject
 OMEModelObject (const std::string &objectType="OMEModelObject")
 Constructor. More...
 
 OMEModelObject (const OMEModelObject &copy)
 Copy constructor. More...
 
template<class C , typename T >
bool contains (const C &container, const std::shared_ptr< T > &element)
 Check if a container contains a particular element. More...
 
- Protected Member Functions inherited from ome::xml::model::OMEModelObject
 OMEModelObject ()
 Constructor.
 

Private Attributes

std::shared_ptr< Implimpl
 Private implementation details.
 

Additional Inherited Members

- Protected Attributes inherited from ome::xml::model::detail::OMEModelObject
ome::common::Logger logger
 Message logger.
 

Detailed Description

Dichroic model object.

Constructor & Destructor Documentation

◆ Dichroic()

ome::xml::model::Dichroic::Dichroic ( const Dichroic copy)

Copy constructor.

Parameters
copythe Dichroic to copy.

Member Function Documentation

◆ asXMLElementInternal()

void ome::xml::model::Dichroic::asXMLElementInternal ( common::xml::dom::Document document,
common::xml::dom::Element element 
) const
protectedvirtual

Transform the object hierarchy rooted at this element to XML.

This internal implementation of asXMLelement also requires an XML element, which must not be null, or may be instantiated and passed from superclasses.

Concrete model object implementations should override this method.

Parameters
documentXML document for element creation.
elementXML element for setting model data.

Reimplemented from ome::xml::model::ManufacturerSpec.

References ome::common::xml::dom::Node::appendChild(), ome::xml::model::ManufacturerSpec::asXMLElementInternal(), ome::common::xml::dom::Document::createElementNS(), getXMLNamespace(), impl, and ome::common::xml::dom::Element::setAttribute().

◆ create()

std::shared_ptr< Dichroic > ome::xml::model::Dichroic::create ( const common::xml::dom::Element element,
ome::xml::model::OMEModel model 
)
static

Create a Dichroic model object from DOM element.

Parameters
elementroot of the XML DOM tree to from which to construct the model object graph.
modelhandler for the OME model used to track instances and references seen during the update.
Exceptions
EnumerationExceptionif there is an error instantiating an enumeration during model object creation, or ModelException if there are any consistency or validity errors found during processing.
Returns
a new model object.

Referenced by ome::xml::model::Instrument::update().

+ Here is the caller graph for this function:

◆ elementName()

const std::string & ome::xml::model::Dichroic::elementName ( ) const
virtual

Get the element name of this model object.

This will be the most-derived class name.

Returns
the element type.

Implements ome::xml::model::OMEModelObject.

◆ getID()

const std::string & ome::xml::model::Dichroic::getID ( ) const

Get the ID property.

Returns
the ID property.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ getInstrument() [1/2]

std::weak_ptr< ome::xml::model::Instrument > ome::xml::model::Dichroic::getInstrument ( )

Get the Instrument property.

Returns
the Instrument property.

References impl.

◆ getInstrument() [2/2]

const std::weak_ptr< ome::xml::model::Instrument > ome::xml::model::Dichroic::getInstrument ( ) const

Get the Instrument property.

Returns
the Instrument property.

References impl.

◆ getLinkedAnnotation()

const std::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Dichroic::getLinkedAnnotation ( OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type  index) const

Get linked Annotation.

Parameters
indexthe index number of the Annotation.
Returns
a weak pointer to the Annotation.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

◆ getLinkedAnnotationList()

OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type ome::xml::model::Dichroic::getLinkedAnnotationList ( ) const

Get the linked Annotation list.

Returns
a reference to the list.

References impl.

◆ getLinkedFilterSet()

const std::weak_ptr< ome::xml::model::FilterSet > & ome::xml::model::Dichroic::getLinkedFilterSet ( OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type::size_type  index) const

Get linked FilterSet.

Parameters
indexthe index number of the FilterSet.
Returns
a weak pointer to the FilterSet.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

◆ getLinkedFilterSetList()

OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type ome::xml::model::Dichroic::getLinkedFilterSetList ( ) const

Get the linked FilterSet list.

Returns
a reference to the list.

References impl.

◆ getLinkedLightPath()

const std::weak_ptr< ome::xml::model::LightPath > & ome::xml::model::Dichroic::getLinkedLightPath ( OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type  index) const

Get linked LightPath.

Parameters
indexthe index number of the LightPath.
Returns
a weak pointer to the LightPath.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

◆ getLinkedLightPathList()

OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type ome::xml::model::Dichroic::getLinkedLightPathList ( ) const

Get the linked LightPath list.

Returns
a reference to the list.

References impl.

◆ getXMLNamespace()

const std::string & ome::xml::model::Dichroic::getXMLNamespace ( ) const
virtual

Get the XML namespace for this model object.

Returns
the XML namespace.

Implements ome::xml::model::OMEModelObject.

Referenced by asXMLElementInternal().

+ Here is the caller graph for this function:

◆ link()

bool ome::xml::model::Dichroic::link ( std::shared_ptr< Reference > &  reference,
std::shared_ptr< ome::xml::model::OMEModelObject > &  object 
)

Link a given OME model object to this model object.

Parameters
referencetype qualifier for the reference. This should be the corresponding reference type for object. If, for example, object is of type Image, reference must be of type ImageRef.
objectModel object to link to.
Returns
true if this model object was able to handle the reference, otherwise false.
Todo:
the use of reference to provide type information for the type of object is unconventional and quite possibly unnecessary–a simple string or type_info would suffice for what it's being used for, if it's needed at all. Is this true for all cases? The implementation also needs to do strict checking of the object type; it's not currently failing if it's of the wrong type. This applies to all generated model objects implementing this interface.
Todo:
This bit is silly; why do we have two dynamic_casts here.

References impl, ome::xml::model::ManufacturerSpec::link(), ome::xml::model::Annotation::linkDichroic(), and ome::xml::model::detail::OMEModelObject::logger.

◆ linkAnnotation()

bool ome::xml::model::Dichroic::linkAnnotation ( const std::shared_ptr< ome::xml::model::Annotation > &  annotation)

Link Annotation.

Parameters
annotationthe Annotation to link.
Returns
true if the object was added to the internal annotationLinks list, otherwise false.
Todo:
Why have a return value here; what is it used for? Is this an artifact of the Java API?

References impl.

◆ linkFilterSet()

bool ome::xml::model::Dichroic::linkFilterSet ( const std::shared_ptr< ome::xml::model::FilterSet > &  filterSet_BackReference)

Link FilterSet.

Parameters
filterSet_BackReferencethe FilterSet to link.
Returns
true if the object was added to the internal filterSets list, otherwise false.
Todo:
Why have a return value here; what is it used for? Is this an artifact of the Java API?

References impl.

Referenced by ome::xml::model::FilterSet::link().

+ Here is the caller graph for this function:

◆ linkLightPath()

bool ome::xml::model::Dichroic::linkLightPath ( const std::shared_ptr< ome::xml::model::LightPath > &  lightPath_BackReference)

Link LightPath.

Parameters
lightPath_BackReferencethe LightPath to link.
Returns
true if the object was added to the internal lightPaths list, otherwise false.
Todo:
Why have a return value here; what is it used for? Is this an artifact of the Java API?

References impl.

Referenced by ome::xml::model::LightPath::link().

+ Here is the caller graph for this function:

◆ setID()

void ome::xml::model::Dichroic::setID ( const std::string &  id)

Set the ID property.

Parameters
idthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ setInstrument()

void ome::xml::model::Dichroic::setInstrument ( std::weak_ptr< ome::xml::model::Instrument > &  instrument_BackReference)

Set the Instrument property.

Parameters
instrument_BackReferencethe value to set.

References impl.

◆ setLinkedAnnotation()

const std::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Dichroic::setLinkedAnnotation ( OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type  index,
const std::shared_ptr< ome::xml::model::Annotation > &  annotation 
)

Set linked Annotation.

Note
The index must be valid.
Parameters
indexthe index number of the Annotation.
annotationthe Annotation to set.
Returns
a weak pointer to the Annotation.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

◆ setLinkedFilterSet()

const std::weak_ptr< ome::xml::model::FilterSet > & ome::xml::model::Dichroic::setLinkedFilterSet ( OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type::size_type  index,
const std::shared_ptr< ome::xml::model::FilterSet > &  filterSet_BackReference 
)

Set linked FilterSet.

Note
The index must be valid.
Parameters
indexthe index number of the FilterSet.
filterSet_BackReferencethe FilterSet to set.
Returns
a weak pointer to the FilterSet.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

◆ setLinkedLightPath()

const std::weak_ptr< ome::xml::model::LightPath > & ome::xml::model::Dichroic::setLinkedLightPath ( OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type  index,
const std::shared_ptr< ome::xml::model::LightPath > &  lightPath_BackReference 
)

Set linked LightPath.

Note
The index must be valid.
Parameters
indexthe index number of the LightPath.
lightPath_BackReferencethe LightPath to set.
Returns
a weak pointer to the LightPath.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

◆ sizeOfLinkedAnnotationList()

OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type ome::xml::model::Dichroic::sizeOfLinkedAnnotationList ( ) const

Get size of linked Annotation list.

Returns
the size of the list.

References impl.

◆ sizeOfLinkedFilterSetList()

OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type::size_type ome::xml::model::Dichroic::sizeOfLinkedFilterSetList ( ) const

Get size of linked FilterSet list.

Returns
the size of the list.

References impl.

◆ sizeOfLinkedLightPathList()

OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type ome::xml::model::Dichroic::sizeOfLinkedLightPathList ( ) const

Get size of linked LightPath list.

Returns
the size of the list.

References impl.

◆ unlinkAnnotation()

bool ome::xml::model::Dichroic::unlinkAnnotation ( const std::shared_ptr< ome::xml::model::Annotation > &  annotation)

Unlink Annotation.

Parameters
annotationthe Annotation to unlink.
Returns
true if the Annotation was unlinked, otherwise false if the Annotation was not linked and could hence not be unlinked.
Todo:

Does the return value serve any useful purpose? Is this also inherited Java API?

Doesn't the removal break the indexing?

Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.

References impl.

◆ unlinkFilterSet()

bool ome::xml::model::Dichroic::unlinkFilterSet ( const std::shared_ptr< ome::xml::model::FilterSet > &  filterSet_BackReference)

Unlink FilterSet.

Parameters
filterSet_BackReferencethe FilterSet to unlink.
Returns
true if the FilterSet was unlinked, otherwise false if the FilterSet was not linked and could hence not be unlinked.
Todo:

Does the return value serve any useful purpose? Is this also inherited Java API?

Doesn't the removal break the indexing?

Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.

References impl.

◆ unlinkLightPath()

bool ome::xml::model::Dichroic::unlinkLightPath ( const std::shared_ptr< ome::xml::model::LightPath > &  lightPath_BackReference)

Unlink LightPath.

Parameters
lightPath_BackReferencethe LightPath to unlink.
Returns
true if the LightPath was unlinked, otherwise false if the LightPath was not linked and could hence not be unlinked.
Todo:

Does the return value serve any useful purpose? Is this also inherited Java API?

Doesn't the removal break the indexing?

Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.

References impl.

◆ update()

void ome::xml::model::Dichroic::update ( const common::xml::dom::Element element,
ome::xml::model::OMEModel model 
)
virtual

Update the object hierarchy recursively from an XML DOM tree.

Note
No properties are removed, only added or updated.
Parameters
elementroot of the XML DOM tree to from which to construct the model object graph.
modelhandler for the OME model used to track instances and references seen during the update.
Exceptions
EnumerationExceptionif there is an error instantiating an enumeration during model object creation, or ModelException if there are any consistency or validity errors found during processing.

Reimplemented from ome::xml::model::ManufacturerSpec.

References ome::xml::model::OMEModel::addModelObject(), ome::xml::model::OMEModel::addReference(), ome::common::xml::dom::Element::getAttribute(), ome::xml::model::detail::OMEModelObject::getChildrenByTagName(), getID(), ome::common::xml::dom::Element::getTagName(), ome::common::xml::dom::Element::hasAttribute(), ome::xml::model::detail::OMEModelObject::logger, setID(), ome::xml::model::ManufacturerSpec::update(), and validElementName().

◆ validElementName()

bool ome::xml::model::Dichroic::validElementName ( const std::string &  name) const
virtual

Check if a given element name is valid for processing by this model object.

Used for processing nodes when interitance is involved.

Parameters
namethe element name to check.
Returns
true if valid, false if invalid.
Deprecated:
Always returns true since any element name is now regarded as being valid.

Implements ome::xml::model::detail::OMEModelObject.

Referenced by update().

+ Here is the caller graph for this function:

The documentation for this class was generated from the following files: