/*******************************************************************************
* Copyright 2014 Analog Devices, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
********************************************************************************/
package com.analog.lyric.dimple.matlabproxy;
import org.eclipse.jdt.annotation.Nullable;
import com.analog.lyric.dimple.model.variables.RealJoint;
import com.analog.lyric.util.misc.Matlab;
/**
* Base class for Dimple MATLAB proxy objects.
*/
@Matlab
public abstract class PObject
{
/**
* Convert object to its delegate.
* <p>
* If {@code obj} is a {@code PObject} and its {@linkplain #getDelegate() delegate} is
* non-null, the delegate will be returned. Otherwise returns {@code obj} itself.
* @since 0.07
*/
public static Object unwrap(Object obj)
{
if (obj instanceof PObject)
{
Object delegate = ((PObject)obj).getDelegate();
if (delegate != null)
{
return delegate;
}
}
return obj;
}
/**
* Returns the object(s) to which this proxy delegates.
* @since 0.07
*/
public abstract @Nullable Object getDelegate();
/**
* Returns the modeler object wrapped by this proxy or null
* if not applicable for this type of object.
*/
public @Nullable Object getModelerObject() { return null; }
/**
* True if object applies only to discrete variables.
* Implies not {@link #isReal} and not {@link #isJoint}.
*/
public boolean isDiscrete() { return false; }
/**
* True if object is a type of {@link PDomain}.
*/
public boolean isDomain() { return false; }
/**
* True of object is a {@link PFactorGraphVector}.
*/
public boolean isGraph() { return false; }
/**
* True if object is a {@link PFactorVector}.
*/
public boolean isFactor() { return false; }
/**
* True if object is a {@link PFactorFunction}
*/
public boolean isFactorFunction() { return false; }
/**
* True if object is a {@link PFactorTable}
*/
public boolean isFactorTable() { return false; }
/**
* True if object is a {@link PScheduler}
* @since 0.08
*/
public boolean isScheduler() { return false; }
/**
* True if object is a {@link PVariableBlock}
* @since 0.08
*/
public boolean isVariableBlock() { return false; }
/**
* True if object applies only to {@link RealJoint} variables.
* Implies not {@link #isDiscrete} and not {@link #isReal}.
*/
public boolean isJoint() { return false; }
/**
* True if object applies only to real variables.
* Implies not {@link #isDiscrete} and not {@link #isJoint}.
*/
public boolean isReal() { return false; }
/**
* True if object is a {@link PVariableVector}.
*/
public boolean isVariable() { return false; }
/**
* True if object is a type of {@link PNodeVector}.
*/
public boolean isVector() { return false; }
}